Description
A Variable object represents a number. Variables can be used as counters in For loops, indices in Arrays, flags for conditional control, mathematical operations, and more. See the Matrix, Array, and Variable Math Script Reference for more information. You can assign Variable objects using the = operator.
Inheritance Hierarchy: Object->Variable
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in nanosecond timing precision mode.
Click here to see the documentation for this object in millisecond timing precision mode.
Name
|
Description
|
Attributes
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
DisplayName
|
The name displayed for this object in output windows such as views, plots, and reports.
|
Type: String
Access: Read/Write
|
ObjectId
|
The unique identifier for the object.
|
Type: Variable
Access: Read-Only
|
ObjectType
|
The type of the object.
|
Type: String
Access: Read-Only
|
Value
|
The numeric value of the Variable.
|
Type: Variable
Access: Read/Write
|
|
Name
|
Description
|
And
|
Returns the bitwise AND of the two variable values.
|
ClearSavedStates
|
Clears previous saved states for this object.
|
EncodeAsType
|
Encodes a Variable value into a binary-formatted String using the specified data format.
|
Format
|
Converts the number held by the calling object into a string based on the specified format specifiers. The format specifiers are standard C/C++ specifiers as used with the sprintf function. The Format method converts a double precision floating point value to a string; the IFormat method should be used to convert an integer value to a string.
|
GetFromFile
|
Load the object state from the specified FreeFlyer object file.
|
GetFromString
|
Load the object state from the specified string.
|
IFormat
|
Converts the number held by the calling object into a string based on the specified format specifiers. The format specifiers are standard C/C++ specifiers as used with the sprintf function. The IFormat method converts an integer value to a string; the Format method should be used to convert a double precision floating point value to a string.
|
Or
|
Returns the bitwise OR of the two variable values.
|
PutToFile
|
Convert the object state to FreeFlyer object xml and write to a file.
|
PutToString
|
Convert the object state to FreeFlyer object xml and return as a string.
|
ReferenceEquals
|
Returns 1 if the argument refers to the calling object and 0 otherwise.
|
Repeat
|
Returns a matrix consisting of the specified value repeated the specified number of times.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
ToString
|
Converts the value to a string.
|
ToTimeSpan
|
Converts the value of the Variable to a TimeSpan using the specified units. The level of precision of the conversion to the TimeSpan is a function of the underlying units of the data stored in the Variable.
|
|
See also
Parsing Dates and Times
Matrix, Array, and Variable Math Guide
|
