Class: ConstantProperty

ConstantProperty

new ConstantProperty(valueopt)

A Property whose value does not change with respect to simulation time.
Parameters:
Name Type Attributes Description
value Object <optional>
 The property value.
Source:
See:
Throws:

Members

(readonly) definitionChanged :Event

Gets the event that is raised whenever the definition of this property changes. The definition is changed whenever setValue is called with data different than the current value.
Type:
Source:

(readonly) isConstant :Boolean

Gets a value indicating if this property is constant. This property always returns true.
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(timeopt, resultopt) → {Object}

Gets the value of the property.
Parameters:
Name Type Attributes Description
time JulianDate <optional>
 The time for which to retrieve the value. This parameter is unused since the value does not change with respect to time.
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

setValue(value)

Sets the value of the property.
Parameters:
Name Type Description
value Object The property value.
Source:
Throws: