Open CASCADE Technology  7.7.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
Express_Item Class Referenceabstract

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>

Inheritance diagram for Express_Item:
Inheritance graph
[legend]

Public Types

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...
 

Public Member Functions

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...
 
virtual Standard_Boolean GenerateClass () const =0
 General interface for creating HXX/CXX files from item. More...
 
virtual void PropagateUse () const =0
 Propagates the calls of Use function. 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...
 

Static Public Member Functions

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

 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

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.

Member Enumeration Documentation

◆ GenMode

Enumerator
GM_NoGen 
GM_GenByUser 
GM_GenByAlgo 
GM_Undefined 
GM_Generated 

Constructor & Destructor Documentation

◆ Express_Item() [1/2]

Express_Item::Express_Item ( const Standard_CString  theName)
protected

Creates object and initializes fields PackageName and CreateFlag by 0.

◆ Express_Item() [2/2]

Express_Item::Express_Item ( const Handle< TCollection_HAsciiString > &  theName)
protected

Creates object and initializes fields PackageName and CreateFlag by 0.

Member Function Documentation

◆ Category()

const TCollection_AsciiString& Express_Item::Category ( ) const

Get item category.

◆ CheckFlag()

Standard_Boolean Express_Item::CheckFlag ( ) const

Get flag resposible for presence of method Check in the class.

◆ CPPName()

virtual const TCollection_AsciiString Express_Item::CPPName ( ) const
virtual

Returns (generated) name for the item in CXX-style (Package_Class)

Reimplemented in Express_Alias.

◆ FillSharedFlag()

Standard_Boolean Express_Item::FillSharedFlag ( ) const

Get flag resposible for presence of method FillShared in the class.

◆ Generate()

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.

◆ GenerateClass()

virtual Standard_Boolean Express_Item::GenerateClass ( ) const
pure virtual

General interface for creating HXX/CXX files from item.

Implemented in Express_Reference, Express_Select, Express_Alias, and Express_Enum.

◆ GetGenMode()

GenMode Express_Item::GetGenMode ( ) const

Returns item generation mode.

◆ GetPackageName()

const TCollection_AsciiString& Express_Item::GetPackageName ( ) const

Returns package name If not defined, returns unknown package name: "StepStep".

◆ GetUnknownPackageName()

static TCollection_AsciiString& Express_Item::GetUnknownPackageName ( )
static

Returns unknown package name: "StepStep".

◆ HName()

Handle< TCollection_HAsciiString > Express_Item::HName ( ) const

Returns a pointer to the item name to modify it.

◆ Index()

static Standard_Integer Express_Item::Index ( )
static

Get current entity index.

◆ IsPackageNameSet()

Standard_Boolean Express_Item::IsPackageNameSet ( ) const

Returns whether the package name is set.

◆ Name()

const TCollection_AsciiString& Express_Item::Name ( ) const

Returns item name.

◆ PropagateUse()

virtual void Express_Item::PropagateUse ( ) const
pure virtual

Propagates the calls of Use function.

Implemented in Express_Reference, Express_Select, Express_Alias, and Express_Enum.

◆ ResetLoopFlag()

void Express_Item::ResetLoopFlag ( )

Reset loop flag.

◆ SetCategory()

void Express_Item::SetCategory ( const Handle< TCollection_HAsciiString > &  theCateg)

Set category for item.

◆ SetCheckFlag()

void Express_Item::SetCheckFlag ( const Standard_Boolean  theCheckFlag)

Set flag for presence of method Check in the class.

◆ SetFillSharedFlag()

void Express_Item::SetFillSharedFlag ( const Standard_Boolean  theFillSharedFlag)

Set flag for presence of method FillShared in the class.

◆ SetGenMode()

void Express_Item::SetGenMode ( const GenMode  theGenMode)

Change generation mode for item.

◆ SetIndex()

static void Express_Item::SetIndex ( const Standard_Integer  theIndex)
static

Set start entity index.

◆ SetPackageName()

void Express_Item::SetPackageName ( const TCollection_AsciiString thePack)

Sets package name.

◆ SetShortName()

void Express_Item::SetShortName ( const Handle< TCollection_HAsciiString > &  theShName)

Set short name for item.

◆ ShortName()

Handle< TCollection_HAsciiString > Express_Item::ShortName ( ) const

Get item short name.

◆ Use()

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().

◆ Use2()

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.


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