Class: DataSourceClock

DataSourceClock

new DataSourceClock()

Represents the clock settings required for a specific data source. These settings can be applied to Clock when loading the data source.

Members

clockRangeClockRange

Get or set the desired clock range settings. See Clock#clockRange.

clockStepClockStep

Get or set the required clock step settings. See Clock#clockStep.

currentTimeJulianDate

Get or set the current time required to load this data source. See Clock#currentTime.

readonly definitionChangedEvent

The event triggered when assigning a new attribute.

multiplierNumber

Get or set the desired clock multiplier. See Clock#multiplier.

startTimeJulianDate

Get or set the desired clock start time. See Clock#startTime.

stopTimeJulianDate

Get or set the desired clock stop time. See Clock#stopTime.

Methods

clone(result){DataSourceClock}

Copy the clock instance of the data source.

Name Type Description
result DataSourceClock optional

The object that stores the results.

Returns:
Type Description
DataSourceClock The modified result parameters, or a new instance (if not provided).

equals(other){Boolean}

If this DataSourceClock is equivalent to the other passed in, return true

Name Type Description
other DataSourceClock

Compare with other DataSourceClocks.

Returns:
Type Description
Boolean If DataSourceClocks are equal, it is true; Otherwise, it is false

getValue(){Clock}

Retrieve the value of the clock instance in the form of a Clock object.

Returns:
Type Description
Clock The modified result parameters, or a new instance (if not provided).

merge(source)

Assign each unspecified property on this object to the value of the same property on the provided source object.

Name Type Description
source DataSourceClock

To merge objects into this object.