Class: DataSourceClock

DataSourceClock

new DataSourceClock()

Represents desired clock settings for a particular DataSource. These settings may be applied to the Clock when the DataSource is loaded.
Source:

Members

clockRange :ClockRange

Gets or sets the desired clock range setting. See Clock#clockRange.
Type:
  • ClockRange
Source:

clockStep :ClockStep

Gets or sets the desired clock step setting. See Clock#clockStep.
Type:
  • ClockStep
Source:

currentTime :JulianDate

Gets or sets the desired current time when this data source is loaded. See Clock#currentTime.
Type:
Source:

(readonly) definitionChanged :Event

Gets the event that is raised whenever a new property is assigned.
Type:
Source:

multiplier :Number

Gets or sets the desired clock multiplier. See Clock#multiplier.
Type:
  • Number
Source:

startTime :JulianDate

Gets or sets the desired start time of the clock. See Clock#startTime.
Type:
Source:

stopTime :JulianDate

Gets or sets the desired stop time of the clock. See Clock#stopTime.
Type:
Source:

Methods

clone(resultopt) → {DataSourceClock}

Duplicates a DataSourceClock instance.
Parameters:
Name Type Attributes Description
result DataSourceClock <optional>
 The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new instance if one was not provided.
Type
DataSourceClock

equals(other) → {Boolean}

Returns true if this DataSourceClock is equivalent to the other
Parameters:
Name Type Description
other DataSourceClock The other DataSourceClock to compare to.
Source:
Returns:
true if the DataSourceClocks are equal; otherwise, false.
Type
Boolean

getValue() → {Clock}

Gets the value of this clock instance as a Clock object.
Source:
Returns:
The modified result parameter or a new instance if one was not provided.
Type
Clock

merge(source)

Assigns each unassigned property on this object to the value of the same property on the provided source object.
Parameters:
Name Type Description
source DataSourceClock The object to be merged into this object.
Source: