new ConstantProperty
A Property whose value does not change with respect to simulation time. If the value is a non-basic type, then it must provide clone and equals functions.
Parameters:
Name | Type | Argument | Description |
---|---|---|---|
value |
Object |
<optional> |
The property value. |
Throws:
-
DeveloperError : value.clone is a required function.
-
DeveloperError : value.equals is a required function.
Members
-
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.
-
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.
-
isConstant :Boolean
-
Gets a value indicating if this property is constant. This property always returns
true
. -
isConstant :Boolean
-
Gets a value indicating if this property is constant. This property always returns
true
.
Methods
-
equals
-
Compares this property to the provided property and returns
true
if they are equal,false
otherwise.Parameters:
Name Type Argument Description other
Property <optional>
The other property. Returns:
Booleantrue
if left and right are equal,false
otherwise. -
getValue
-
Gets the value of the property.
Parameters:
Name Type Argument 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. Returns:
Object The modified result parameter or a new instance if the result parameter was not supplied. -
setValue
-
Sets the value of the property. If the value is a non-basic type, then it must provide clone and equals functions.
Parameters:
Name Type Description value
Object The property value. Throws:
-
DeveloperError : value.clone is a required function.
-
DeveloperError : value.equals is a required function.
-