Photon Quantum 3.0.0

Public Member Functions | Protected Member Functions | Properties | List of all members
Quantum.SystemGroup Class Reference

The base class for a hierarchy of systems. More...

Inheritance diagram for Quantum.SystemGroup:
Quantum.SystemBase

Public Member Functions

 SystemGroup (String name, params SystemBase[] children)
 Create a new system group. More...
 
override void OnDisabled (Frame f)
 Is called when the system was disabled for example after Frame.SystemDisable(Type).
 
override void OnEnabled (Frame f)
 Is called when the system was enabled for example after calling Frame.SystemEnable<T>() or during QuantumGame.InitSystems(Photon.Deterministic.DeterministicFrame).
 
- Public Member Functions inherited from Quantum.SystemBase
 SystemBase ()
 Constructor. More...
 
 SystemBase (string scheduleSample)
 Create a new instance and setting the sample name. More...
 
virtual void OnInit (Frame f)
 Is called when the system is initialized. More...
 
TaskHandle OnSchedule (Frame f, TaskHandle taskHandle)
 Creates the task graph for the system. More...
 

Protected Member Functions

sealed override TaskHandle Schedule (Frame f, TaskHandle taskHandle)
 Add the child systems the the task hierarchy. More...
 

Properties

sealed override IEnumerable< SystemBaseChildSystems [get]
 
- Properties inherited from Quantum.SystemBase
virtual IEnumerable< SystemBaseChildSystems [get]
 The enumerable child systems. More...
 
IEnumerable< SystemBaseHierarchy [get]
 Creates the complete sub graph of child systems. More...
 
SystemBase ParentSystem [get]
 The parent system in the system hierarchy. More...
 
Int32 RuntimeIndex [get, set]
 A unique index assigned to identify systems at runtime. More...
 
virtual Boolean StartEnabled [get, set]
 Set to true when the simulation should start with this system enabled. More...
 

Detailed Description

The base class for a hierarchy of systems.

Constructor & Destructor Documentation

◆ SystemGroup()

Quantum.SystemGroup.SystemGroup ( String  name,
params SystemBase[]  children 
)
inline

Create a new system group.

Parameters
nameThe name of the system.
childrenThe child systems.

Member Function Documentation

◆ Schedule()

sealed override TaskHandle Quantum.SystemGroup.Schedule ( Frame  f,
TaskHandle  taskHandle 
)
inlineprotectedvirtual

Add the child systems the the task hierarchy.

Parameters
fThe referenced frame.
taskHandleThe initial task handle.
Returns
The final task graph.

Implements Quantum.SystemBase.