Description
The JsonInterface object allows FreeFlyer users to easily import and export JSON-formatted data. JSON, or JavaScript Object Notation, is a data file format that contains attribute-value pairs. The JsonInterface object is always used with a Struct that will contain the data to serialize to JSON format (or the data that has been deserialized from JSON format).
Inheritance Hierarchy: Object->JsonInterface
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
|
ComplexTypeBehavior
|
Specifies the behavior when serializing a structure with members that are non-fundamental types. Fundamental types include Variable, Array, String, StringArray, TimeSpan, and TimeSpanArray. Note that serialization of members that are a List of fundamental types is also supported.
|
Type: Variable
Access: Read/Write
|
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
|
MissingPropertyBehavior
|
Specifies the behavior when deserializing a JSON string and there is a field that is not in the structure.
|
Type: Variable
Access: Read/Write
|
NullValueBehavior
|
Specifies the behavior when reading null values from a JSON string. Note that when setting to a default value, -999 is used for Variable fields and an empty string is used for String fields. These values can be overidden with the @JsonNullValue annotation.
|
Type: Variable
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
|
|
Name
|
Description
|
ClearSavedStates
|
Clears previous saved states for this object.
|
Deserialize
|
Populate data for the specified structure from the deserialization of a JSON string.
|
DeserializeFromFile
|
Populate data for the specified structure from the deserialization of a JSON string contained in the specified file.
|
GetFromFile
|
Load the object state from the specified FreeFlyer object file.
|
GetFromString
|
Load the object state from the specified string.
|
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.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
Serialize
|
Serialize the specified structure to a JSON string.
|
SerializeToFile
|
Serialize the specified structure to a file.
|
|
See also
JSON-Formatted Data Guide
|
