cadex::ModelData_PMITable Class Reference

Defines a container storing PMI data. More...

#include <cadex/ModelData_PMITable.hxx>

Inheritance diagram for cadex::ModelData_PMITable:

Classes
class	PlaneIterator
	Iterator over added planes. More...
class	PMIDataIterator
	Iterator over added PMIData items, which contains graphical and semantical elements. 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_PMIData &theData)
	Adds a PMIData, which contains a graphical and a related semantical element, or only one of them.
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.
size_t	NumberOfPMIData () const
	Returns the number of added PMIData.
size_t	NumberOfSavedViews () const
	Returns the number of Saved View objects.
size_t	NumberOfPlanes () const
	Returns the number of PMI planes.
void	Clear ()
	Discards associated data.
Public Member Functions inherited from cadex::ModelData_BaseObject
	ModelData_BaseObject ()
	Constructor.
IdType	TypeId () const
	Returns an object type id.
template<typename T >
bool	IsOfType () const
	Returns true if the object has a type T.
void	SetName (const Base_UTF16String &theName)
	Sets an object name.
Base_UTF16String	Name () const
void	SetUuid (const Base_Uuid &theUuid)
Base_Uuid	Uuid () const
void	Nullify ()
	Resets reference to implementation object.
bool	IsNull () const
	Returns true if the object is nullified.
	operator bool () const
	Casts the object to the bool type.
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

Examples

exploring/pmi/Program.cs, exploring/pmi/main.cxx, and visualization/wpf/pmiviewer/App.xaml.cs.

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

NumberOfPMIData().

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

NumberOfPMIData()

size_t cadex::ModelData_PMITable::NumberOfPMIData

(

)

const

Returns the number of added PMIData.

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

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