Class: ConstantProperty

ConstantProperty

new ConstantProperty(value)

The value of Property does not change with simulation time.

Name Type Description
value * optional

Attribute value

See:

Members

readonly definitionChangedEvent

Retrieve the event triggered whenever the definition of this attribute changes. Whenever setValue is called, if the data is different from the current value, the definition will change.

readonly isConstantBoolean

Get a boolean value indicating whether the property is a constant. This attribute always returns true.

Methods

equals(other){Boolean}

Compare this attribute with the provided attribute, return true if they are equal, otherwise return false.

Name Type Description
other Property optional

A property.

Returns:
Type Description
Boolean If left and right are equal, it is true; otherwise, it is false.

getValue(time, result){Object}

Retrieve attribute values.

Name Type Description
time JulianDate optional

The time to retrieve the attribute value. This parameter will not be used because the attribute value does not change over time.

result Object optional

If the object storing numerical values is omitted, a new instance will be created and returned.

Returns:
Type Description
Object The modified result parameters, or a new instance (if no result parameters are provided).

setValue(value)

Set attribute values.

Name Type Description
value *

Attribute value.

toString(){String}

Create a string representing the value of this attribute.

Returns:
Type Description
String A string representing the value of an attribute.

valueOf(){*}

Get attribute values

Returns:
Type Description
* The value of this attribute.