HECL::Runtime::ObjectBase Class Reference

Base object to subclass for integrating with key runtime operations. More...

#include <HECLRuntime.hpp>

Inheritance diagram for HECL::Runtime::ObjectBase:

Collaboration diagram for HECL::Runtime::ObjectBase:

Public Member Functions
	ObjectBase (const Group *group, const std::string &path)
const Group *	getParentGroup ()
	Get parent group of object. More...
Public Member Functions inherited from HECL::Runtime::Entity
Type	getType () const
	Get type of runtime object. More...
const std::string &	getPath () const
	Get database entity path. More...
bool	isLoaded () const
	Determine if object is fully loaded and constructed. More...

Protected Member Functions
virtual bool	_objectFinishedLoading (const void *data, size_t len)
	Optional subclass method called on background thread or in response to interrupt when data is ready. More...
virtual void	_objectWillUnload ()
	Optional subclass method called in response to reference-count dropping to 0.

Additional Inherited Members
Public Types inherited from HECL::Runtime::Entity
enum	Type { ENTITY_NONE, ENTITY_OBJECT, ENTITY_GROUP }

Detailed Description

Base object to subclass for integrating with key runtime operations.

All runtime objects are provided with IDataObject pointers to their database entries. Subclasses register themselves with a type registry so instances are automatically constructed when performing operations like runtime-integration.

DO NOT CONSTRUCT THIS OR SUBCLASSES DIRECTLY!!

Member Function Documentation

virtual bool HECL::Runtime::ObjectBase::_objectFinishedLoading ( const void *  data, size_t  len  )

inlineprotectedvirtual

Optional subclass method called on background thread or in response to interrupt when data is ready.

Parameters

data	fully-loaded data buffer
len	length of buffer

Returns

true when data is successfully integrated into the runtime

const Group* HECL::Runtime::ObjectBase::getParentGroup ( )

inline

Get parent group of object.

Returns

Borrowed pointer of parent RuntimeGroup

---

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

• include/HECLRuntime.hpp