EntityBase Class Reference

#include <entity_base.hh>

Inherits GenericPropContainer< EntityBase >.

Inherited by EntityHandle, and EntityView.

Public Member Functions
	EntityBase (const impl::EntityImplPtr &impl)
	EntityBase ()
const String &	GetName () const
void	SetName (const String &ent_name)
Public Member Functions inherited from GenericPropContainer< EntityBase >
void	ClearProps ()
void	SetStringProp (const String &key, const String &value)
void	SetFloatProp (const String &key, Real value)
void	SetIntProp (const String &key, int value)
void	SetBoolProp (const String &key, bool value)
void	SetVec3Prop (const String &key, geom::Vec3 value)
void	RemoveProp (const String &key)
Public Member Functions inherited from ConstGenericPropContainer< H >
bool	HasProp (const String &key) const
String	GetPropAsString (const String &key) const
String	GetStringProp (const String &key) const
Real	GetFloatProp (const String &key) const
int	GetIntProp (const String &key) const
bool	GetBoolProp (const String &key) const
geom::Vec3	GetVec3Prop (const String &key) const
String	GetStringProp (const String &key, const String &def) const
Real	GetFloatProp (const String &key, Real def) const
int	GetIntProp (const String &key, int def) const
bool	GetBoolProp (const String &key, bool def) const
std::map< String, GenericPropValue >	GetPropMap () const
std::vector< String >	GetPropList () const

Friends
class	ConstGenericPropContainer< EntityBase >

Handle validity
	operator bool () const
bool	IsValid () const
impl::EntityImplPtr &	Impl ()
const impl::EntityImplPtr &	Impl () const
GenericPropContainerImpl *	GpImpl ()
const GenericPropContainerImpl *	GpImpl () const
void	CheckValidity () const

Additional Inherited Members
Protected Member Functions inherited from ConstGenericPropContainer< H >
template<typename T >
T	gp_get (const String &key) const
template<typename T >
T	gp_get (const String &key, const T &def) const
GenericPropContainerImpl *	GetImpl ()
const GenericPropContainerImpl *	GetImpl () const

Detailed Description

definition of EntityBase

Definition at line 30 of file entity_base.hh.

Constructor & Destructor Documentation

EntityBase() [1/2]

EntityBase

(

const impl::EntityImplPtr &

impl

)

EntityBase() [2/2]

EntityBase

(

)

Member Function Documentation

CheckValidity()

void CheckValidity ( ) const

protected

GetName()

const String& GetName

(

)

const

Get entity name.

See also

EntityBase::SetName

GpImpl() [1/2]

GenericPropContainerImpl* GpImpl ( )

protected

GpImpl() [2/2]

const GenericPropContainerImpl* GpImpl ( ) const

protected

Impl() [1/2]

impl::EntityImplPtr& Impl

(

)

Impl() [2/2]

const impl::EntityImplPtr& Impl

(

)

const

IsValid()

bool IsValid ( ) const

inline

check validity of handle

See also

operator bool()

Definition at line 62 of file entity_base.hh.

operator bool()

operator bool ( ) const

inline

check validity of handle

check, whether the entity handle points to a valid entity.

Note

It is an error to use any method other than IsValid, Impl and operator bool() when the handle is invalid. An InvalidHandle exception will be thrown.

Definition at line 59 of file entity_base.hh.

SetName()

void SetName

(

const String &

ent_name

)

Set entity name.

Parameters

ent_name

is the new entity name.

See also

EntityBase::GetName

Friends And Related Function Documentation

ConstGenericPropContainer< EntityBase >

friend class ConstGenericPropContainer< EntityBase >

friend

Definition at line 76 of file entity_base.hh.

---

The documentation for this class was generated from the following file:

• build-dev-doc/stage/include/ost/mol/entity_base.hh