isee.NET Framework Documentation

Simulation Members

Simulation overview

Public Static (Shared) Methods

Equals (inherited from Object) Determines whether the specified Object instances are considered equal.
ReferenceEquals (inherited from Object) Determines whether the specified Object instances are the same instance.

Public Static (Shared) Events

Expired Fires when the state provider has expired the Simulation engine from the cache

Public Instance Constructors

Simulation Constructor Creates a new simulation class

Public Instance Properties

CurrentPauseInterval Returns an index representing the interval at which the simulation is paused. When the simulation is started, the CurrentPauseInterval is 1.
CurrentRun Returns the index number for the current run. CurrentRun is set to 1 when the simulation is initialized, and is incremented every time the Reset method is called. The number of elapsed runs is therefore always one fewer than the Current Run.
CurrentTime The current unit of time of the simulation If the simulation has not been run, the current time will be equal to start time.
Inputs A collection of Inputs
InterfaceXML The XML representation of the model interface that is exported within the TXM file
IsStopped Return true if the simulation has stopped. A simulation may be stopped by a message poster. Otherwise, check if CurrentTime is equal to TimeSpecs.StopTime to know if the simulation has reached the end.
MessagePosters An array of Message Posters
Model Path and filename of the TXM file for this Application.
NumberOfRuns The total number or runs for this session. At the beginning of each new run, the value is incremented. At the beginning of the first run, the NumberOfRuns is 1.
Outputs A collection of outputs
RegistrationNumber The NetSim registration number. Needed by the Simulation class to load the model.
SaveInterval Controls the period (expressed in units of time) between samples of simulation results that will be stored within the simulation engine.
SimStatus The status of the simulation. Running or Not Started Check the 'CurrentTime' property for the current time step
TimeSpecs The time spec information for the current model

Public Instance Methods

AddInput Add a new entity to control as an input
AddOutput Add a new model entity to the list of outputs
CreateNewRun Creates a new simulation run. Increments the run count and initializes the simulation.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetCheckbox Gets a Checkbox for the input entity specified. The Checkbox represents a switch defined on the interface layer of the model.
GetGraphPad Gets a graph pad that has been defined in the model interface
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetInput Gets a basic input for the entity specified
GetKnob Gets the Knob object that controls the entity specified.
GetListInputDevice Gets a list input device that is defined on the model interface layer
GetOutput Get a basic output for the entity specified
GetRadioButtonGroup Gets a RadioButtonGroup object. Use this method to access chained switches in the ithink/STELLA model
GetSlider Gets a slider that has been defined in the model interface
GetTablePad Gets a TablePad that has been defined in the model interface
GetType (inherited from Object) Gets the Type of the current instance.
GetWarningDevice Gets a Warning Device for the output entity specified.
ResetInputs Resets the model
Run Run the simulation one pause interval, or to the end if a pause interval has not been set
RunToEnd Forces the simulation to advance to stop time, regardless of the current pause interval
ToString (inherited from Object) Returns a String that represents the current Object.

Public Instance Events

Advance Fires when the simulation has been advanced one step
AdvancedToEnd Fires when RunToEnd has been called and the run is complete
AdvancedToPauseInterval Fires when the simulation has advanced to the next pause interval
MessagePosted Fires when a message defined in the model is posted, or tripped
NewRun Fires when the simulation has been reset
Stopped Fires when the simulation has been stopped because a message poster with a stop condition has been posted

Protected Instance Methods

Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

Simulation Class | iseesystems.iseeNET Namespace