cadex::ModelData_BaseObject Class Reference

Base class for all objects that have private implementation (pimpl) back-end. More...

Inheritance diagram for cadex::ModelData_BaseObject:

Public Types
typedef int	IdType
	Defines a type identifier.

Public Member Functions
	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).

Protected Member Functions
	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

Base class for all objects that have private implementation (pimpl) back-end.

ModelData_BaseObject is a root of a hierarchy where objects represent API.

Implementation objects (returned by Impl()) internally contains reference counter which is used to manage life span of the object.

Subclases of ModelData_BaseObject do not have own data fields. Data is stored inside the implementation object.

Examples

exploring/bom/Program.cs.

Constructor & Destructor Documentation

ModelData_BaseObject()

cadex::ModelData_BaseObject::ModelData_BaseObject ( )

inline

Constructor.

Creates a null object (see IsNull()).

Member Function Documentation

IsNull()

bool cadex::ModelData_BaseObject::IsNull

(

)

const

Returns true if the object is nullified.

See also

Nullify().

Examples

meshing/remeshing/Program.cs, meshing/remeshing/main.cxx, and modeling/elementremoval/main.cxx.

IsOfType()

template<typename T >

bool cadex::ModelData_BaseObject::IsOfType ( ) const

inline

Returns true if the object has a type T.

Helper method which uses static method T::GetTypeId() to compare with value returned by virtual method TypeId().

Examples

advgeom/meshsimplify/main.cxx, exploring/bom/main.cxx, exploring/layers/main.cxx, exploring/polyrepresentation/main.cxx, and meshing/lods/main.cxx.

Name()

Base_UTF16String cadex::ModelData_BaseObject::Name

(

)

const

Returns an object name. Returns empty string if the object has no name (by default).

See also

SetName().

Examples

exploring/bom/Program.cs, exploring/bom/main.cxx, exploring/brepgeometry/Program.cs, exploring/brepgeometry/main.cxx, exploring/layers/Program.cs, exploring/layers/main.cxx, exploring/pmi/Program.cs, exploring/pmi/main.cxx, exploring/transformations/Program.cs, exploring/transformations/main.cxx, meshing/remeshing/Program.cs, meshing/remeshing/main.cxx, and modeling/elementremoval/main.cxx.

Nullify()

void cadex::ModelData_BaseObject::Nullify

(

)

Resets reference to implementation object.

Decrements reference counter and destroys the object if the counter reaches zero.

operator bool()

cadex::ModelData_BaseObject::operator bool ( ) const

inline

Casts the object to the bool type.

Returns IsNull().

Returns IsNull().

SetName()

void cadex::ModelData_BaseObject::SetName

(

const Base_UTF16String &

theName

)

Sets an object name.

Accepts a string as a unicode string. Must not be called on IsNull() object. Otherwise behavior is undefined.

See also

Name().

SetUuid()

void cadex::ModelData_BaseObject::SetUuid

(

const Base_Uuid &

theUuid

)

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

See also

Uuid()

TypeId()

ModelData_BaseObject::IdType cadex::ModelData_BaseObject::TypeId

(

)

const

Returns an object type id.

Type id can be used for faster type check (comparing to dynamic_cast), for instance:

ModelData_Representation a

Examples

advgeom/meshsimplify/Program.cs, exploring/bom/Program.cs, exploring/layers/Program.cs, exploring/polyrepresentation/Program.cs, meshing/lods/Program.cs, and meshing/remeshing/main.cxx.

Uuid()

Base_Uuid cadex::ModelData_BaseObject::Uuid

(

)

const

Returns an object uuid. Returns nullable uuid if the object has no uuid (by default).

See also

SetUuid()