Open CASCADE Technology 7.7.0
|
Base class for items of the schema. Stores a name of the class, package name and flag used to mark items for generation. Provides interface for writing generated class definitions to HXX and CXX files. More...
#include <Express_Item.hxx>
Public Types | |
enum | GenMode { GM_NoGen , GM_GenByUser , GM_GenByAlgo , GM_Undefined , GM_Generated } |
![]() | |
typedef void | base_type |
Returns a type descriptor about this object. | |
Public Member Functions | |
const TCollection_AsciiString & | Name () const |
Returns item name. | |
Handle< TCollection_HAsciiString > | HName () const |
Returns a pointer to the item name to modify it. | |
virtual const TCollection_AsciiString | CPPName () const |
Returns (generated) name for the item in CXX-style (Package_Class) | |
const TCollection_AsciiString & | GetPackageName () const |
Returns package name If not defined, returns unknown package name: "StepStep". | |
Standard_Boolean | IsPackageNameSet () const |
Returns whether the package name is set. | |
void | SetPackageName (const TCollection_AsciiString &thePack) |
Sets package name. | |
GenMode | GetGenMode () const |
Returns item generation mode. | |
void | SetGenMode (const GenMode theGenMode) |
Change generation mode for item. | |
void | ResetLoopFlag () |
Reset loop flag. | |
virtual Standard_Boolean | GenerateClass () const =0 |
General interface for creating HXX/CXX files from item. | |
virtual void | PropagateUse () const =0 |
Propagates the calls of Use function. | |
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. | |
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(). | |
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. | |
void | SetCategory (const Handle< TCollection_HAsciiString > &theCateg) |
Set category for item. | |
const TCollection_AsciiString & | Category () const |
Get item category. | |
void | SetShortName (const Handle< TCollection_HAsciiString > &theShName) |
Set short name for item. | |
Handle< TCollection_HAsciiString > | ShortName () const |
Get item short name. | |
void | SetCheckFlag (const Standard_Boolean theCheckFlag) |
Set flag for presence of method Check in the class. | |
Standard_Boolean | CheckFlag () const |
Get flag resposible for presence of method Check in the class. | |
void | SetFillSharedFlag (const Standard_Boolean theFillSharedFlag) |
Set flag for presence of method FillShared in the class. | |
Standard_Boolean | FillSharedFlag () const |
Get flag resposible for presence of method FillShared in the class. | |
![]() | |
Standard_Transient () | |
Empty constructor. | |
Standard_Transient (const Standard_Transient &) | |
Copy constructor – does nothing. | |
Standard_Transient & | operator= (const Standard_Transient &) |
Assignment operator, needed to avoid copying reference counter. | |
virtual | ~Standard_Transient () |
Destructor must be virtual. | |
virtual void | Delete () const |
Memory deallocator for transient classes. | |
virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
Returns a type descriptor about this object. | |
Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
Returns a true value if this is an instance of Type. | |
Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
Returns a true value if this is an instance of TypeName. | |
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. | |
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. | |
Standard_Transient * | This () 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. | |
Standard_Integer | GetRefCount () const |
Get the reference counter of this object. | |
void | IncrementRefCounter () const |
Increments the reference counter of this object. | |
Standard_Integer | DecrementRefCounter () const |
Decrements the reference counter of this object; returns the decremented value. | |
Static Public Member Functions | |
static TCollection_AsciiString & | GetUnknownPackageName () |
Returns unknown package name: "StepStep". | |
static void | SetIndex (const Standard_Integer theIndex) |
Set start entity index. | |
static Standard_Integer | Index () |
Get current entity index. | |
![]() | |
static const char * | get_type_name () |
Returns a type descriptor about this object. | |
static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
Returns type descriptor of Standard_Transient class. | |
Protected Member Functions | |
Express_Item (const Standard_CString theName) | |
Creates object and initializes fields PackageName and CreateFlag by 0. | |
Express_Item (const Handle< TCollection_HAsciiString > &theName) | |
Creates object and initializes fields PackageName and CreateFlag by 0. | |
Base class for items of the schema. Stores a name of the class, package name and flag used to mark items for generation. Provides interface for writing generated class definitions to HXX and CXX files.
|
protected |
Creates object and initializes fields PackageName and CreateFlag by 0.
|
protected |
Creates object and initializes fields PackageName and CreateFlag by 0.
const TCollection_AsciiString & Express_Item::Category | ( | ) | const |
Get item category.
Standard_Boolean Express_Item::CheckFlag | ( | ) | const |
Get flag resposible for presence of method Check in the class.
|
virtual |
Returns (generated) name for the item in CXX-style (Package_Class)
Reimplemented in Express_Alias.
Standard_Boolean Express_Item::FillSharedFlag | ( | ) | const |
Get flag resposible for presence of method FillShared in the class.
Standard_Boolean Express_Item::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.
|
pure virtual |
General interface for creating HXX/CXX files from item.
Implemented in Express_Alias, Express_Enum, Express_Reference, and Express_Select.
GenMode Express_Item::GetGenMode | ( | ) | const |
Returns item generation mode.
const TCollection_AsciiString & Express_Item::GetPackageName | ( | ) | const |
Returns package name If not defined, returns unknown package name: "StepStep".
|
static |
Returns unknown package name: "StepStep".
Handle< TCollection_HAsciiString > Express_Item::HName | ( | ) | const |
Returns a pointer to the item name to modify it.
|
static |
Get current entity index.
Standard_Boolean Express_Item::IsPackageNameSet | ( | ) | const |
Returns whether the package name is set.
const TCollection_AsciiString & Express_Item::Name | ( | ) | const |
Returns item name.
|
pure virtual |
Propagates the calls of Use function.
Implemented in Express_Alias, Express_Enum, Express_Reference, and Express_Select.
void Express_Item::ResetLoopFlag | ( | ) |
Reset loop flag.
void Express_Item::SetCategory | ( | const Handle< TCollection_HAsciiString > & | theCateg | ) |
Set category for item.
void Express_Item::SetCheckFlag | ( | const Standard_Boolean | theCheckFlag | ) |
Set flag for presence of method Check in the class.
void Express_Item::SetFillSharedFlag | ( | const Standard_Boolean | theFillSharedFlag | ) |
Set flag for presence of method FillShared in the class.
void Express_Item::SetGenMode | ( | const GenMode | theGenMode | ) |
Change generation mode for item.
|
static |
Set start entity index.
void Express_Item::SetPackageName | ( | const TCollection_AsciiString & | thePack | ) |
Sets package name.
void Express_Item::SetShortName | ( | const Handle< TCollection_HAsciiString > & | theShName | ) |
Set short name for item.
Handle< TCollection_HAsciiString > Express_Item::ShortName | ( | ) | const |
Get item short name.
Standard_Boolean Express_Item::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().
void Express_Item::Use2 | ( | const TCollection_AsciiString & | theRefName, |
const TCollection_AsciiString & | theRefPack | ||
) |
Mark Item as visited in PropagateUse flow and defined the package name if not set.