EntityBase Class Reference

definition of EntityBase More...

#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)

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

Member Function Documentation

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

Get entity name.

See also:
EntityBase::SetName
const GenericPropContainerImpl* GpImpl (  )  const [protected]
GenericPropContainerImpl* GpImpl (  )  [protected]
const impl::EntityImplPtr& Impl (  )  const
impl::EntityImplPtr& Impl (  ) 
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:
ent_name is 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:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Generated on 1 Mar 2018 for OpenStructure by  doxygen 1.6.1