Sage Modeling and Simulation Library

ExecController Members

The ExecController type exposes the following members.

Constructors


  Name Description
Public method ExecController(IModel, Double, Int32)
Initializes a new instance of the ExecController class. The model is used as UserData.
Frame rate must be from zero to 25. If zero, no constraint is imposed.
Public method ExecController(IExecutive, Double, Int32, Object)
Initializes a new instance of the ExecController class. The caller may specify userData.
Frame rate must be from zero to 25. If zero, no contraint is imposed.
Public method ExecController(Double, Int32, Object)
Initializes a new instance of the ExecController class. The caller may specify userData.
Frame rate must be from zero to 25. If zero, no contraint is imposed. For this constructor, the executive will be set while the model sets its ExecController.

Methods


  Name Description
Public method Dispose
Public method Equals(System.Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method SetExecutive
Sets the executive on which this controller will operate. This API should only be called once. The ExecController cannot be targeted to control a different executive.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)

Properties


  Name Description
Public property Disable
Public property FrameRate
Gets or sets the frame rate - an integer that represents the preferred number of rendering callbacks received per second.
Public property LinearScale
Gets or sets the linear scale of run speed to sim speed. For example, for a sim that runs 100 x faster than a real-world clock, the linear scale would be 100.
Public property RateString
A user-friendly representation of the simulation speed.
Public property Scale
Gets or sets the logarithmic scale of run speed to sim speed. For example, for a sim that runs 100 x faster than a real-world clock, use a scale of 2.0.

Events


  Name Description
Public event Render
This event is expected to drive rendering at the prescribed frame rate.