CAD Exchanger SDK
cadex::ModelData_PMITable Class Reference

Defines a container storing PMI data. More...

Inheritance diagram for cadex::ModelData_PMITable:
cadex::ModelData_BaseObject

Classes

class  GraphicalElementIterator
 Iterator over added graphical elements. More...
 
class  PlaneIterator
 Iterator over added planes. More...
 
class  Provider
 Provides PMI table. More...
 
class  SavedViewIterator
 Iterator over added saved views. More...
 

Public Types

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

Public Member Functions

 ModelData_PMITable (initialized)
 
 ModelData_PMITable (ImplType *theImpl)
 Constructor (reserved for internal use).
 
 ModelData_PMITable (const Base_UTF16String &theName)
 Constructor.
 
void Add (const ModelData_PMIGraphicalElement &theElement)
 Adds a graphical element.
 
void Add (const ModelData_PMITable &theTable)
 Appends a collection of PMI entities.
 
void AddView (const ModelData_PMISavedView &theView)
 Adds a saved view.
 
void AddPlane (const ModelData_PMIPlane &thePlane)
 Adds a plane.
 
void AddProvider (const std::shared_ptr< Provider > &theProvider)
 Adds a provider.
 
bool IsEmpty () const
 Returns true if no PMI items or providers have been added. More...
 
size_t NumberOfGraphicalElements () const
 Returns the number of added PMI graphical elements. More...
 
size_t NumberOfSavedViews () const
 Returns the number of Saved View objects. More...
 
size_t NumberOfPlanes () const
 Returns the number of PMI planes. More...
 
void Clear ()
 Discards associated data. More...
 
- 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
 Returns an object name. More...
 
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).
 

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 container storing PMI data.

A table stores PMI specific information.

A table can be attached to any scene graph element (ModelData_SceneGraphElement subclass).

PMI items can be retrieved using iterator mechanism.

See also
ModelData_PMIGraphicalElement, ModelData_PMISavedView, ModelData_PMIPlane

Member Function Documentation

◆ Clear()

void cadex::ModelData_PMITable::Clear ( )

Discards associated data.

Added providers will be deleted.

◆ IsEmpty()

bool cadex::ModelData_PMITable::IsEmpty ( ) const

Returns true if no PMI items or providers have been added.

Returns true if IsNull().

See also
NumberOfGraphicalElements().

◆ NumberOfGraphicalElements()

size_t cadex::ModelData_PMITable::NumberOfGraphicalElements ( ) const

Returns the number of added PMI graphical elements.

Returns a number of items which were added with Add(). Does not take into account added providers (as a provider may add an arbitrary number of items).

Returns 0 if this object IsNull().

◆ NumberOfPlanes()

size_t cadex::ModelData_PMITable::NumberOfPlanes ( ) const

Returns the number of PMI planes.

Returns a number of items which were added with AddPlane(). Does not take into account added providers (as a provider may add an arbitrary number of views).

Returns 0 if this object IsNull().

◆ NumberOfSavedViews()

size_t cadex::ModelData_PMITable::NumberOfSavedViews ( ) const

Returns the number of Saved View objects.

Returns a number of items which were added with AddView(). Does not take into account added providers (as a provider may add an arbitrary number of views).

Returns 0 if this object IsNull().