class Enlighten SystemGrouping

This is the documentation for Enlighten.

class Enlighten SystemGrouping

class Enlighten::SystemGrouping

    └>Geo::IGeoReleasable

A groupings of instances into systems.

Functions

Name

Description

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.