OpenStructure
Public Member Functions | Friends
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 StringGetName () 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 RemoveProp (const String &key)
- Public Member Functions inherited from ConstGenericPropContainer< EntityBase >
bool HasProp (const String &key) const
String GetPropAsString (const String &key) const
String GetStringProp (const String &key) const
String GetStringProp (const String &key, const String &def) const
Real GetFloatProp (const String &key) const
Real GetFloatProp (const String &key, Real def) const
int GetIntProp (const String &key) const
int GetIntProp (const String &key, int def) const
bool GetBoolProp (const String &key) const
bool GetBoolProp (const String &key, bool def) const
std::map< String,
GenericPropValue
GetPropMap () const
std::vector< StringGetPropList () const

Friends

class ConstGenericPropContainer< EntityBase >

Handle validity

 operator bool () const
bool IsValid () const
impl::EntityImplPtrImpl ()
const impl::EntityImplPtrImpl () const
GenericPropContainerImplGpImpl ()
const GenericPropContainerImplGpImpl () const
void CheckValidity () const

Detailed Description

definition of EntityBase

Definition at line 30 of file entity_base.hh.


Constructor & Destructor Documentation

EntityBase ( const impl::EntityImplPtr impl)

Member Function Documentation

void CheckValidity ( ) const
protected
const String& GetName ( ) const

Get entity name.

See also:
EntityBase::SetName
GenericPropContainerImpl* GpImpl ( )
protected
const GenericPropContainerImpl* GpImpl ( ) const
protected
const impl::EntityImplPtr& Impl ( ) const
bool IsValid ( ) const
inline

check validity of handle

See also:
operator bool()

Reimplemented in EntityView.

Definition at line 62 of file entity_base.hh.

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.

Reimplemented in EntityView.

Definition at line 59 of file entity_base.hh.

void SetName ( const String ent_name)

Set entity name.

Parameters:
entity_nameis the new entity name.
See also:
EntityBase::GetName

Friends And Related Function Documentation

friend class ConstGenericPropContainer< EntityBase >
friend

Definition at line 33 of file entity_base.hh.


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