State

Definition

Represents the current progression of the object as it advances from setup, processing data, to termination. These states can be used for setting up or declaring various resources and properties.

More detailed explanation of various states along with examples can be found in the OnStateChange() method section of this help guide. You can also attempt to set a new State using the SetState() method.

Property Value

An enum value representing the current state of the object. Possible values are:

State	Description
SetDefaults	Default values are set (pushed to UI).
Configure	User the presses the OK or Apply button.
Active	Object is configured and is ready to receive instructions.
DataLoaded	All data series have been loaded.
Historical	Begins to process historical data.
Transition	Finished processing historical data.
Realtime	Begins to process realtime data.
Terminated	Begins to shut down.

Syntax

State

Examples

Understanding the sequence of States

1 protected override void OnStateChange()
2 {
3   Print(DateTime.Now + ": Current State is State." + State);
4 }

Using State to only process real-time data

1 protected override void OnBarUpdate()
2 {
3    // only process real-time OnBarUpdate events
4    if (State == State.Historical)
5      return;
6        
7    //rest of logic           
8 }