Adds a reference frame object to the ReferenceFrame object container in the data model. Note that reference frames are not created with transformations, which must be added separately.
Note: Reference frames are not available if at least one side of an interface is an FMU participant.
Optionally, a parent reference frame may be defined using the argument noted under Optional Keyword Arguments.
Cannot be run after participants have started.
Returns the name of the reference frame added.
For more information on the object created, see ReferenceFrame.
Optional Keyword Arguments
- ParentReferenceFrame : string
String indicating the name of a valid reference frame that will be parent to the added reference frame.
If the argument is not provided, then the GlobalReferenceFrame will be added as the default parent reference frame.
Return Type
String
Examples
Example 18: Add a reference frame with Global Reference Frame as parent
AddReferenceFrame() 'Frame-1'
Example 19: Add a parented reference frame
AddReferenceFrame(ParentReferenceFrame = 'Frame-3') 'Frame-4'