Hide menu

Defines a complete PMI element. More...

Inheritance diagram for cadex::ModelData_PMIData:
cadex::ModelData_BaseObject

Public Types

typedef cadex::internal::ModelData_PMIDataImpl ImplType
 
- Public Types inherited from cadex::ModelData_BaseObject
typedef int IdType
 Defines a type identifier.
 

Public Member Functions

 ModelData_PMIData ()
 Constructor. More...
 
 ModelData_PMIData (initialized)
 Constructor. More...
 
 ModelData_PMIData (ImplType *theImpl)
 Constructor (reserved for internal use).
 
 ModelData_PMIData (const ModelData_PMIGraphicalElement &theElement)
 Constructor.
 
 ModelData_PMIData (ModelData_PMIType theType)
 Constructor.
 
 ModelData_PMIData (ModelData_PMIType theType, const Base_UTF16String &theName)
 Constructor.
 
void SetGraphicalElement (const ModelData_PMIGraphicalElement &theElement)
 Sets a graphical element.
 
ModelData_PMIGraphicalElement GraphicalElement () const
 Returns a graphical element.
 
void SetSemanticElement (const ModelData_PMISemanticElement &theElement)
 Sets a semantic element.
 
ModelData_PMISemanticElement SemanticElement () const
 Returns a semantic element.
 
void AddProperties (const ModelData_PropertyTable &theProperties)
 Adds a property table to the data. More...
 
ModelData_PropertyTable Properties () const
 Returns a property table.
 
void SetType (ModelData_PMIType theType)
 
ModelData_PMIType Type () const
 
bool IsEmpty () const
 
- Public Member Functions inherited from cadex::ModelData_BaseObject
 ModelData_BaseObject ()
 Constructor. More...
 
IdType TypeId () const
 Returns an object type id. More...
 
template<typename T >
bool IsOfType () const
 Returns true if the object has a type T. More...
 
void SetName (const Base_UTF16String &theName)
 Sets an object name. More...
 
Base_UTF16String Name () const
 
void SetUuid (const Base_Uuid &theUuid)
 
Base_Uuid Uuid () const
 
void Nullify ()
 Resets reference to implementation object. More...
 
bool IsNull () const
 Returns true if the object is nullified. More...
 
 operator bool () const
 Casts the object to the bool type. More...
 
internal::ModelData_BaseObjectImpl * Impl () const
 Return a handle to backend (reserved for internal use).
 
const internal::Base_Handle & HImpl () const
 
template<typename T >
T * Impl () const
 Reserved for internal use.
 

Static Public Member Functions

static IdType GetTypeId ()
 

Additional Inherited Members

- Protected Member Functions inherited from cadex::ModelData_BaseObject
 ModelData_BaseObject (const internal::ModelData_BaseObjectImpl *theImpl)
 Constructor (reserved for internal use).
 
 ModelData_BaseObject (const internal::ModelData_BaseObjectImpl *theImpl, const Base_UTF16String &theName)
 Constructor (reserved for internal use).
 
template<typename T >
T * GetOrCreateImpl ()
 Reserved for internal use.
 

Detailed Description

Defines a complete PMI element.

Encapsulates a PMI graphical element, a PMI semantic element, a type and a property table.

See also
ModelData_PMIGraphicalElement, ModelData_PMISemanticElement
Examples
exploring/pmi/main.cxx.

Constructor & Destructor Documentation

◆ ModelData_PMIData() [1/2]

cadex::ModelData_PMIData::ModelData_PMIData ( )

Constructor.

Creates uninitialized object, for which IsNull() returns true.

◆ ModelData_PMIData() [2/2]

cadex::ModelData_PMIData::ModelData_PMIData ( initialized  )
explicit

Constructor.

Creates initialized object, for which IsNull() returns false.

Member Function Documentation

◆ AddProperties()

void cadex::ModelData_PMIData::AddProperties ( const ModelData_PropertyTable theProperties)

Adds a property table to the data.

If this object did not have properties yet, then theProperties are just linked to this object. Otherwise, the elements of theProperties are appended to existing property table (see ModelData_PropertyTable::Add (const ModelData_PropertyTable&).

Note: properties are rarely attached to individual PMI objects.

Must not be called on IsNull() object. Otherwise behavior is undefined.

◆ IsEmpty()

bool cadex::ModelData_PMIData::IsEmpty ( ) const

Returns true if no graphical or semantic element was set.

See also
SetGraphicalElement(), SetSemanticElement()