cadex::PMI::Element Class Reference

Defines a complete PMI element. More...

#include <cadex/PMI/Element.hxx>

Inheritance diagram for cadex::PMI::Element:

Public Member Functions
	Element (Initialized)
	Element (const GraphicalRepresentation &theRepresentation)
	Constructor.
	Element (ElementType theType)
	Constructor.
	Element (ElementType theType, const UTF16String &theName)
	Constructor.
void	SetGraphicalRepresentation (const GraphicalRepresentation &theRepresentation)
	Sets the graphical representation.
PMI::GraphicalRepresentation	GraphicalRepresentation () const
	Returns the graphical representation.
void	SetSemanticRepresentation (const SemanticRepresentation &theRepresentation)
	Sets the semantic element.
PMI::SemanticRepresentation	SemanticRepresentation () const
	Returns the semantic element.
void	SetName (const UTF16String &theName)
	Sets the name.
UTF16String	Name () const
	Returns the name.
void	SetType (ElementType theType)
	Sets the element type.
ElementType	Type () const
bool	IsEmpty () const
	Returns true if no graphical or semantic representation was set.
Public Member Functions inherited from cadex::BaseObject
size_t	Id () const
	Return unique identifier of public object.
internal::BaseObjectImpl *	Impl () const
bool	IsNull () const
	operator bool () const
template<typename T >
bool	IsOfType () const
template<typename T >
T *	Impl () const
	Reserved for internal use.

Static Public Member Functions
static bool	CompareType (const BaseObject &theObject)
	Returns true if theObject has the Element type.

Protected Member Functions
	Element (const ImplType &theImpl)
Protected Member Functions inherited from cadex::BaseObject
	BaseObject (const ImplType &theImpl)

Additional Inherited Members
Public Types inherited from cadex::BaseObject
typedef std::shared_ptr< internal::BaseObjectImpl >	ImplType

Detailed Description

Defines a complete PMI element.

Encapsulates a PMI graphical representation, a PMI semantic representation, and a type.

See also

GraphicalRepresentation, SemanticRepresentation

Constructor & Destructor Documentation

Element() [1/3]

cadex::PMI::Element::Element ( const GraphicalRepresentation & theRepresentation )

explicit

Constructor.

Element() [2/3]

cadex::PMI::Element::Element ( ElementType theType )

explicit

Constructor.

Element() [3/3]

cadex::PMI::Element::Element	(	ElementType	theType,
		const UTF16String &	theName )

Constructor.

Member Function Documentation

CompareType()

bool cadex::PMI::Element::CompareType ( const BaseObject & theObject )

static

Returns true if theObject has the Element type.

GraphicalRepresentation()

GraphicalRepresentation cadex::PMI::Element::GraphicalRepresentation

(

)

const

Returns the graphical representation.

IsEmpty()

bool cadex::PMI::Element::IsEmpty

(

)

const

Returns true if no graphical or semantic representation was set.

See also

SetGraphicalRepresentation(), SetSemanticRepresentation()

Name()

UTF16String cadex::PMI::Element::Name

(

)

const

Returns the name.

Returns the empty string if the model element has no name (by default).

See also

SetName().

SemanticRepresentation()

SemanticRepresentation cadex::PMI::Element::SemanticRepresentation

(

)

const

Returns the semantic element.

SetGraphicalRepresentation()

void cadex::PMI::Element::SetGraphicalRepresentation

(

const GraphicalRepresentation &

theRepresentation

)

Sets the graphical representation.

SetName()

void cadex::PMI::Element::SetName

(

const UTF16String &

theName

)

Sets the name.

Accepts a string as a unicode string.

See also

Name().

SetSemanticRepresentation()

void cadex::PMI::Element::SetSemanticRepresentation

(

const SemanticRepresentation &

theRepresentation

)

Sets the semantic element.

SetType()

void cadex::PMI::Element::SetType

(

ElementType

theType

)

Sets the element type.