WatchWindow Object

 Top  Previous  Next

Description

A WatchWindow creates an output window that displays a list of expressions and their current values in a color-coded tabular format.

 

Inheritance Hierarchy: Object->OutputWindow->WatchWindow

 

Available In Editions:

Engineer

Mission

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Constructors

 

Signatures

Description

WatchWindow({Object} itemsToWatch, Variable updateOnStep)

Creates a new WatchWindow which will report the objects specified by itemsToWatch and whose update mode is specified by updateOnStep.

 

 

 

Properties

 

Name

Description

Attributes

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

ID

The unique ID number used to reference the visualization output window.

Type:   Variable

Access: Read-Only

LineLabels

Labels for the elements in the WatchWindow.

Type:   StringArray

Access: Read/Write

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

TargetDisplayMode

If the window is updated automatically, this property determines how the window updates will be controlled when a targeting loop is entered.

Type:   String

Access: Read/Write

WindowTitle

Sets the title for the output window.

Type:   String

Access: Read/Write

 
 

 

Methods

 

Name

Description

BeginBatchUpdate

This method marks the beginning of a period where any update to the window will be queued and only processed when the WatchWindow.EndBatchUpdate method is called.

ClearSavedStates

Clears previous saved states for this object.

CloseWindow

Closes the window.

EndBatchUpdate

Processes all updates to the window that have occurred since the WatchWindow.BeginBatchUpdate method was called.

GetFromFile

Load the object state from the specified FreeFlyer object file.

GetFromString

Load the object state from the specified string.

NewWindow

Resets the OutputWindow so that a new window will be created next time Update is called.

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.

Resume

Causes the window to resume updating.

Save

Save the object's state so that it can be restored later.

SaveImage

Saves an image of the OutputWindow to a file. Note that this only works with FF.exe if the --windowed-output-mode switch is used.

Suspend

Causes the window to ignore updates until Resume is called.

Update

Updates the window contents using current object values.

 
 

 

Deprecated Methods

 

Name

Description

Maximize

Maximizes the window.

 

This method has been Deprecated. Please use OutputLayout.SetWindowState method instead.

Minimize

Minimizes the window.

 

This method has been Deprecated. Please use OutputLayout.SetWindowState method instead.

 
 

 

 

See also

WatchWindow Guide