new Property()
The interface for all properties, which represent a value that can optionally vary over time.
This type defines an interface and cannot be instantiated directly.
Members
(readonly) definitionChanged :Event
Gets the event that is raised whenever the definition of this property changes.
The definition is considered to have changed if a call to getValue would return
a different result for the same time.
Type:
- Source:
(readonly) isConstant :Boolean
Gets a value indicating if this property is constant. A property is considered
constant if getValue always returns the same result for the current definition.
Type:
- Boolean
- Source:
Methods
equals(otheropt) → {Boolean}
Compares this property to the provided property and returns
true if they are equal, false otherwise.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
other |
Property |
<optional> |
The other property. |
- Source:
Returns:
true if left and right are equal, false otherwise.
- Type
- Boolean
getValue(time, resultopt) → {Object}
Gets the value of the property at the provided time.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
time |
JulianDate | The time for which to retrieve the value. | |
result |
Object |
<optional> |
The object to store the value into, if omitted, a new instance is created and returned. |
- Source:
Returns:
The modified result parameter or a new instance if the result parameter was not supplied.
- Type
- Object