new DataSource
Defines the interface for data sources, which turn arbitrary data into a DynamicObjectCollection for generic consumption. This object is an interface for documentation purposes and is not intended to be instantiated directly.
Members
-
getName
-
Gets the name of this data source.
Methods
-
getChangedEvent
-
Gets an event that will be raised when non-time-Varying data changes or if the return value of getIsTimeVarying changes.
Returns:
Event The event. -
getClock
-
Gets the top level clock associated with this data source, or undefined if no clock exists.
Returns:
DynamicClock The clock associated with this data source, or undefined if none exists. -
getDynamicObjectCollection
-
Gets the DynamicObjectCollection generated by this data source.
Returns:
DynamicObjectCollection The collection of objects generated by this data source. -
getErrorEvent
-
Gets an event that will be raised if an error is encountered during processing.
Returns:
Event The event. -
getIsTimeVarying
-
Gets a value indicating if the data varies with simulation time. If the return value of this function changes, the changed event will be raised.
Returns:
Boolean True if the data is varies with simulation time, false otherwise.