Open CASCADE Technology  7.7.0
Public Member Functions
Express_Entity Class Reference

Implements ENTITY item of the EXPRESS schema, with interface for deferred Item class. More...

#include <Express_Entity.hxx>

Inheritance diagram for Express_Entity:
Inheritance graph
[legend]

Public Member Functions

 Express_Entity (const Standard_CString theName, const Handle< TColStd_HSequenceOfHAsciiString > &theInherit, const Handle< Express_HSequenceOfField > &theFields)
 Create ENTITY item and initialize it flags hasCheck and hasFillShared mark if generated class has methods Check and FillShared correspondingly. More...
 
const Handle< TColStd_HSequenceOfHAsciiString > & SuperTypes () const
 Returns sequence of inherited classes (names) More...
 
const Handle< Express_HSequenceOfEntity > & Inherit () const
 Returns sequence of inherited items. More...
 
const Handle< Express_HSequenceOfField > & Fields () const
 Returns sequence of fields. More...
 
Standard_Integer NbFields (const Standard_Boolean theInherited=Standard_False) const
 Returns number of fields (only own fields if inherited is False and including fields of all supertypes if it is True) More...
 
void SetAbstractFlag (const Standard_Boolean theIsAbstract)
 Sets abstruct flag for entity;. More...
 
Standard_Boolean AbstractFlag () const
 Returns abstract flag. More...
 
- Public Member Functions inherited from Express_Item
const TCollection_AsciiStringName () const
 Returns item name. More...
 
Handle< TCollection_HAsciiStringHName () const
 Returns a pointer to the item name to modify it. More...
 
virtual const TCollection_AsciiString CPPName () const
 Returns (generated) name for the item in CXX-style (Package_Class) More...
 
const TCollection_AsciiStringGetPackageName () const
 Returns package name If not defined, returns unknown package name: "StepStep". More...
 
Standard_Boolean IsPackageNameSet () const
 Returns whether the package name is set. More...
 
void SetPackageName (const TCollection_AsciiString &thePack)
 Sets package name. More...
 
GenMode GetGenMode () const
 Returns item generation mode. More...
 
void SetGenMode (const GenMode theGenMode)
 Change generation mode for item. More...
 
void ResetLoopFlag ()
 Reset loop flag. More...
 
Standard_Boolean Generate ()
 Checks that item is marked for generation and if yes, generate it by calling GenerateClass. But firstly define PackageName to "StepStep" if not yet defined and drop Mark flag. More...
 
Standard_Boolean Use ()
 Declares item as used by other item being generated If Item is not mentioned by the user (as new or existed) but is used, then it sets GenMode to GM_GenByAlgo and Calls Generate(). More...
 
void Use2 (const TCollection_AsciiString &theRefName, const TCollection_AsciiString &theRefPack)
 Mark Item as visited in PropagateUse flow and defined the package name if not set. More...
 
void SetCategory (const Handle< TCollection_HAsciiString > &theCateg)
 Set category for item. More...
 
const TCollection_AsciiStringCategory () const
 Get item category. More...
 
void SetShortName (const Handle< TCollection_HAsciiString > &theShName)
 Set short name for item. More...
 
Handle< TCollection_HAsciiStringShortName () const
 Get item short name. More...
 
void SetCheckFlag (const Standard_Boolean theCheckFlag)
 Set flag for presence of method Check in the class. More...
 
Standard_Boolean CheckFlag () const
 Get flag resposible for presence of method Check in the class. More...
 
void SetFillSharedFlag (const Standard_Boolean theFillSharedFlag)
 Set flag for presence of method FillShared in the class. More...
 
Standard_Boolean FillSharedFlag () const
 Get flag resposible for presence of method FillShared in the class. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Express_Item
enum  GenMode {
  GM_NoGen, GM_GenByUser, GM_GenByAlgo, GM_Undefined,
  GM_Generated
}
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Express_Item
static TCollection_AsciiStringGetUnknownPackageName ()
 Returns unknown package name: "StepStep". More...
 
static void SetIndex (const Standard_Integer theIndex)
 Set start entity index. More...
 
static Standard_Integer Index ()
 Get current entity index. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Member Functions inherited from Express_Item
 Express_Item (const Standard_CString theName)
 Creates object and initializes fields PackageName and CreateFlag by 0. More...
 
 Express_Item (const Handle< TCollection_HAsciiString > &theName)
 Creates object and initializes fields PackageName and CreateFlag by 0. More...
 

Detailed Description

Implements ENTITY item of the EXPRESS schema, with interface for deferred Item class.

Constructor & Destructor Documentation

◆ Express_Entity()

Express_Entity::Express_Entity ( const Standard_CString  theName,
const Handle< TColStd_HSequenceOfHAsciiString > &  theInherit,
const Handle< Express_HSequenceOfField > &  theFields 
)

Create ENTITY item and initialize it flags hasCheck and hasFillShared mark if generated class has methods Check and FillShared correspondingly.

Member Function Documentation

◆ AbstractFlag()

Standard_Boolean Express_Entity::AbstractFlag ( ) const
inline

Returns abstract flag.

◆ Fields()

const Handle< Express_HSequenceOfField >& Express_Entity::Fields ( ) const

Returns sequence of fields.

◆ Inherit()

const Handle< Express_HSequenceOfEntity >& Express_Entity::Inherit ( ) const

Returns sequence of inherited items.

◆ NbFields()

Standard_Integer Express_Entity::NbFields ( const Standard_Boolean  theInherited = Standard_False) const

Returns number of fields (only own fields if inherited is False and including fields of all supertypes if it is True)

◆ SetAbstractFlag()

void Express_Entity::SetAbstractFlag ( const Standard_Boolean  theIsAbstract)

Sets abstruct flag for entity;.

◆ SuperTypes()

const Handle< TColStd_HSequenceOfHAsciiString >& Express_Entity::SuperTypes ( ) const

Returns sequence of inherited classes (names)


The documentation for this class was generated from the following file: