include/opencascade/Express_Field.hxx

0001 // Copyright (c) 1999-2020 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _Express_Field_HeaderFile
0015 #define _Express_Field_HeaderFile
0016
0017 #include <Standard_Type.hxx>
0018
0019 class Express_Type;
0020 class TCollection_HAsciiString;
0021 class TCollection_AsciiString;
0022
0023 //! Represents field of the ENTITY item in the EXPRESS schema
0024 class Express_Field : public Standard_Transient
0025 {
0026
0027 public:
0028
0029   //! Create object and initialize it
0030   Standard_EXPORT Express_Field (const Standard_CString theName,
0031                                  const Handle(Express_Type)& theType,
0032                                  const Standard_Boolean theOpt);
0033
0034   //! Create object and initialize it
0035   Standard_EXPORT Express_Field (const Handle(TCollection_HAsciiString)& theName,
0036                                  const Handle(Express_Type)& theType,
0037                                  const Standard_Boolean theOpt);
0038
0039   //! Returns field name
0040   Standard_EXPORT const TCollection_AsciiString& Name() const;
0041
0042   //! Returns a pointer to the field name to modify it
0043   Standard_EXPORT Handle(TCollection_HAsciiString) HName() const;
0044
0045   //! Returns field type
0046   Standard_EXPORT const Handle(Express_Type)& Type() const;
0047
0048   //! Returns True if field is optional
0049   Standard_EXPORT Standard_Boolean IsOptional() const;
0050
0051   DEFINE_STANDARD_RTTIEXT(Express_Field, Standard_Transient)
0052
0053 protected:
0054
0055 private:
0056
0057   Handle(TCollection_HAsciiString) myName;
0058   Handle(Express_Type) myType;
0059   Standard_Boolean myOpt;
0060
0061 };
0062
0063 #endif // _Express_Field_HeaderFile