Description
The Diagnostics object type has a number of static properties and methods on it to enable error messages captured by Try blocks to be diagnosed and have their details reported. This object is not creatable in script.
Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.
Inheritance Hierarchy: Object->Diagnostics
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in millisecond timing precision mode.
Click here to see the documentation for this object in nanosecond timing precision mode.
Name
|
Description
|
Attributes
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
Name
|
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
|
|
Name
|
Description
|
ClearSavedStates
|
Clears previous saved states for this object.
|
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.
|
|
Name
|
Description
|
Attributes
|
ErrorCount
|
Returns the number of logged error messages suppressed using a Try command since the beginning of this Mission Plan's execution.
|
Type: Variable
Access: Read-Only
|
ErrorMessages
|
Returns a StringArray containing logged error messages suppressed using a Try command since the beginning of this Mission Plan's execution. Error messages will consist of the error message and the line number where it occurred.
The text of FreeFlyer error messages can change between versions of FreeFlyer, so it is recommended to not build logic around the contents of these messages.
|
Type: StringArray
Access: Read-Only
|
MaxStoredErrorMessages
|
The maximum number of error messages to store. Once this value is exceeded, the oldest messages will be dropped until the total is less-than-or-equal-to the maximum.
|
Type: Variable
Access: Read/Write
|
|
Name
|
Description
|
ClearErrorMessages
|
Clears the Diagnostics.ErrorMessages StringArray.
|
GetLastErrorMessages
|
Reports any error messages suppressed using a Try command since this method was previously called, then calls ClearErrorMessages(). Error messages will consist of the error message and the line number where it occurred.
The text of FreeFlyer error messages can change between versions of FreeFlyer, so it is recommended to not build logic around the contents of these messages.
|
ReportErrorMessage
|
Reports a user defined error message through FreeFlyer's message reporting mechanism.
|
ReportWarningMessage
|
Reports a user defined warning message through FreeFlyer's message reporting mechanism.
|
|
See also
Error Diagnostics Guide
Try Command
|
