hecl
High-Level Extensible Combiner Language and Resource Database
Public Types | Public Member Functions | Friends | List of all members
HECL::Runtime::Group Class Reference

Interface representing a load-ordered group of runtime objects. More...

#include <HECLRuntime.hpp>

Inheritance diagram for HECL::Runtime::Group:
Inheritance graph
Collaboration diagram for HECL::Runtime::Group:
Collaboration graph

Public Types

typedef std::vector< std::weak_ptr< const class RuntimeObjectBase > > GroupObjectsVector
 
- Public Types inherited from HECL::Runtime::Entity
enum  Type { ENTITY_NONE, ENTITY_OBJECT, ENTITY_GROUP }
 

Public Member Functions

const GroupObjectsVector & getObjects () const
 
- 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...
 

Friends

class HECLRuntime
 

Detailed Description

Interface representing a load-ordered group of runtime objects.

HLPK files perform all data retrieval using the notion of 'groups' Groups are a collection of data objects that have been sequentially packed in the package file and are constructed in the indexed order of the group.

RuntimeGroup objects are internally created and weakly-referenced by CRuntime. RuntimeObject objects are weakly-referenced by RuntimeGroup; they're strongly referenced by application systems as long as they're needed.

DO NOT CONSTRUCT THIS DIRECTLY!!


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