This is the documentation for Enlighten.
class Enlighten SystemGrouping
class Enlighten::SystemGrouping
A groupings of instances into systems.
Functions
| Name | Description |
|---|---|
| AddInstance(Geo::s32, Geo::s32) | Adds an instance with a given ID to a system. |
| AddSystem(Geo::s32) | Adds a system to the grouping with a maximum instance capacity. |
| Create(Geo::s32) | Creates a system grouping for a given number of systems. |
| GetInstance(Geo::s32, Geo::s32) | Returns the global ID for an instance in a system. |
| GetNumInstances() | Returns the total number of instances in the grouping. |
| GetNumInstances(Geo::s32) | Returns the number of instances in a system. |
| GetNumSystems() | Returns the number of systems in the grouping. |
| Release() | Deletes the system grouping. |
| Release() | Free this object that was created within the Enlighten libraries. |
bool Enlighten::SystemGrouping::AddInstance
public: bool AddInstance
(
Geo::s32 sysIdx,
Geo::s32 gId
)
Adds an instance with a given ID to a system.
Parameters
| [in] | sysIdx | The system the instance gets added to. |
| [in] | gId | The global ID of the instance. |
Returns
true if the instance is successfully added.
bool Enlighten::SystemGrouping::AddSystem
public: bool AddSystem
(
Geo::s32 capacity
)
Adds a system to the grouping with a maximum instance capacity.
Parameters
| [in] | capacity | Maximum number of instances the added system can contain. |
Returns
true if the system is successfully added.
static SystemGrouping* Enlighten::SystemGrouping::Create
public: SystemGrouping * Create
(
Geo::s32 numSystems
)
Creates a system grouping for a given number of systems.
Parameters
| [in] | numSystems | Number of systems in the grouping. |
Geo::s32 Enlighten::SystemGrouping::GetInstance
public: Geo::s32 GetInstance
(
Geo::s32 sysIdx,
Geo::s32 instIdx
) const
Returns the global ID for an instance in a system.
Parameters
| [in] | sysIdx | The considered system. |
| [in] | instIdx | The instance index within the system. |
Geo::s32 Enlighten::SystemGrouping::GetNumInstances
public: Geo::s32 GetNumInstances() const
Returns the total number of instances in the grouping.
Geo::s32 Enlighten::SystemGrouping::GetNumInstances
public: Geo::s32 GetNumInstances
(
Geo::s32 sysIdx
) const
Returns the number of instances in a system.
Parameters
| [in] | sysIdx | The considered system. |
Geo::s32 Enlighten::SystemGrouping::GetNumSystems
public: Geo::s32 GetNumSystems() const
Returns the number of systems in the grouping.
void Enlighten::SystemGrouping::Release
public: virtual void Release()
Deletes the system grouping.
virtual void Geo::IGeoReleasable::Release
public: void Release()
Free this object that was created within the Enlighten libraries.
Expect this to behave in a similar way to calling 'delete(this)'