Set XYZ Reference Frame Instrument Base Anchor Frame

Establishes the base reference frame for the XYZ Instrument.

 

Input Arguments

 

0

Collection Instrument ID

Instrument’s ID

The instrument ID of the instrument to edit.

1

Collection Object Name

Anchor Frame

Name of the frame to associate.

 

Return Arguments

None.

 

Returned Status

 

SUCCESS

The instrument was edited successful.

FAILURE

The instrument was not found.

 

Remarks

The position of an XYZ instrument is based on its reference frame. As the coordinates of this frame are adjusted the XYZ instruments position adjusts accordingly. This can be used to dynamically move a list of objects that are associ- ated with the XYZ instrument through editing the position and orientation of the base reference frame.