PrescribedOrientationRigid class

The PrescribedOrientationRigid class gives you access to define *BOUNDARY_PRESCRIBED_ORIENTATION_RIGID cards in PRIMER. More...

The PRIMER JavaScript API provides many class constants, properties and methods. For Arup to be able to extend and enhance the API in the future any constant, property or method names beginning with a lowercase or uppercase letter are reserved.
If you need to add your own properties or methods to one of the existing classes then to avoid any potential future conflict you should ensure that the name begins with either an underscore (_) or a dollar sign ($) or the name is prefixed with your own unique identifier.
For example if company 'ABC' need to add a property called 'example' then to avoid any potential future conflict use one of:

_example
$example
ABC_example

Class functions

Create(Model[Model], modal (optional)[boolean])
First(Model[Model])
FlagAll(Model[Model], flag[Flag])
ForEach(Model[Model], func[function], extra (optional)[any])
GetAll(Model[Model], property (optional)[string])
GetFlagged(Model[Model], flag[Flag], property (optional)[string])
GetFromID(Model[Model], number[integer])
Last(Model[Model])
Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean])
SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean])
Total(Model[Model], exists (optional)[boolean])
UnflagAll(Model[Model], flag[Flag])
UnsketchAll(Model[Model], redraw (optional)[boolean])
UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean])

Member functions

AssociateComment(Comment[Comment])
Browse(modal (optional)[boolean])
ClearFlag(flag[Flag])
Copy(range (optional)[boolean])
DetachComment(Comment[Comment])
Edit(modal (optional)[boolean])
Error(message[string], details (optional)[string])
Flagged(flag[Flag])
GetComments()
GetParameter(prop[string])
Keyword()
KeywordCards()
Next()
Previous()
SetFlag(flag[Flag])
Sketch(redraw (optional)[boolean])
Unsketch(redraw (optional)[boolean])
ViewParameters()
Warning(message[string], details (optional)[string])
Xrefs()
toString()

PrescribedOrientationRigid constants

Name	Description
PrescribedOrientationRigid.ANGLES	Boundary is *BOUNDARY_PRESCRIBED_ORIENTATION_RIGID_ANGLES.
PrescribedOrientationRigid.DIRCOS	Boundary is *BOUNDARY_PRESCRIBED_ORIENTATION_RIGID_DIRCOS.
PrescribedOrientationRigid.EULERP	Boundary is *BOUNDARY_PRESCRIBED_ORIENTATION_RIGID_EULERP.
PrescribedOrientationRigid.VECTOR	Boundary is *BOUNDARY_PRESCRIBED_ORIENTATION_RIGID_VECTOR.

PrescribedOrientationRigid properties

Name	Type	Description
birth	real	Time prior to which the body moves freely under the action of other agents.
body	integer	Reference axes: 0 for rotations about axes fixed in PIDA or 1 for those fixed in PIDB.
death	real	Time when the body is freed from the restriction.
exists (read only)	logical	true if prescribed orientation rigid exists, false if referred to but not defined.
heading	string	PrescribedOrientationRigid heading
id	logical	true if _ID option is set, false if not.
include	integer	The Include file number that the prescribed orientation rigid is in.
intrp	integer	Interpolation method: 1 for linear interpolation or 2 for cubic spline interpolation.
intrp	integer	Interpolation method: 1 for linear interpolation or 2 for cubic spline interpolation.
iseq	integer	Specifies the sequence in which the rotations are performed.
ishft	integer	Angle shift: 1 for unaltered angle curves or 2 for angle data shift in LCIDQi curves eliminating discontinuities.
lcidc11	integer	Load curve ID specifying direction cosine C11 as function of time.
lcidc12	integer	Load curve ID specifying direction cosine C12 as function of time.
lcidc13	integer	Load curve ID specifying direction cosine C13 as function of time.
lcidc21	integer	Load curve ID specifying direction cosine C21 as function of time.
lcidc22	integer	Load curve ID specifying direction cosine C22 as function of time.
lcidc23	integer	Load curve ID specifying direction cosine C23 as function of time.
lcidc31	integer	Load curve ID specifying direction cosine C31 as function of time.
lcidc32	integer	Load curve ID specifying direction cosine C32 as function of time.
lcidc33	integer	Load curve ID specifying direction cosine C33 as function of time.
lcide1	integer	Load curve ID specifying Euler parameter e1 as function of time.
lcide2	integer	Load curve ID specifying Euler parameter e2 as function of time.
lcide3	integer	Load curve ID specifying Euler parameter e3 as function of time.
lcide4	integer	Load curve ID specifying Euler parameter e4 as function of time.
lcidq1	integer	Load curve ID specifying orientation angle q1 as function of time.
lcidq2	integer	Load curve ID specifying orientation angle q2 as function of time.
lcidq3	integer	Load curve ID specifying orientation angle q3 as function of time.
lcids	integer	Load curve ID specifying spin speed of PIDB about axis parallel to vector.
lcidv1	integer	Load curve ID specifying vector measure number v1 as function of time.
lcidv2	integer	Load curve ID specifying vector measure number v2 as function of time.
lcidv3	integer	Load curve ID specifying vector measure number v3 as function of time.
model (read only)	integer	The Model number that the prescribed orientation rigid is in.
option	constant	The Boundary Prescribed Orientation Rigid option. Can be PrescribedOrientationRigid.DIRCOS, PrescribedOrientationRigid.ANGLES, PrescribedOrientationRigid.EULERP or PrescribedOrientationRigid.VECTOR.
pida	integer	Part ID for rigid body A.
pidb	integer	Part ID for rigid body B whose orientation is prescribed.
toffset	integer	Time offset flag.
valspin	real	Constant value for spin speed of PIDB about axis parallel to vector. Used when LCIDS is 0.

Detailed Description

The PrescribedOrientationRigid class allows you to create, modify, edit and manipulate boundary prescribed orientation rigid cards. See the documentation below for more details.

Constructor

new PrescribedOrientationRigid(Model[Model], option[constant], pidb[integer], label (optional)[integer], heading (optional)[string])

Description

Create a new PrescribedOrientationRigid object.

Arguments

Model (Model)

Model that prescribed orientation rigid will be created in

option (constant)

Suffix for boundary prescribed orientation rigid. Can be PrescribedOrientationRigid.DIRCOS PrescribedOrientationRigid.ANGLES PrescribedOrientationRigid.EULERP PrescribedOrientationRigid.VECTOR

pidb (integer)

Part ID for rigid body B whose orientation is prescribed.

label (optional) (integer)

PrescribedOrientationRigid number

heading (optional) (string)

Title for the PrescribedOrientationRigid

Returns

PrescribedOrientationRigid object

Return type

PrescribedOrientationRigid

Example

To create a new prescribed orientation rigid in model m with part ID 10 and suffix _DIRCOS:

var por = new PrescribedOrientationRigid(m, PrescribedOrientationRigid.DIRCOS, 10);

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a prescribed orientation rigid.

Arguments

Comment (Comment)

Comment that will be attached to the prescribed orientation rigid

Returns

No return value

Example

To associate comment c to the prescribed orientation rigid por:

por.AssociateComment(c);

Browse(modal (optional)[boolean])

Description

Starts an edit panel in Browse mode.

Arguments

modal (optional) (boolean)

If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

Returns

no return value

Example

To Browse prescribed orientation rigid por:

por.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the prescribed orientation rigid.

Arguments

flag (Flag)

Flag to clear on the prescribed orientation rigid

Returns

No return value

Example

To clear flag f for prescribed orientation rigid por:

por.ClearFlag(f);

Copy(range (optional)[boolean])

Description

Copies the prescribed orientation rigid. The target include of the copied prescribed orientation rigid can be set using Options.copy_target_include.

Arguments

range (optional) (boolean)

If you want to keep the copied item in the range specified for the current include. Default value is false. To set current include, use Include.MakeCurrentLayer().

Returns

PrescribedOrientationRigid object

Return type

PrescribedOrientationRigid

Example

To copy prescribed orientation rigid por into prescribed orientation rigid z:

var z = por.Copy();

Create(Model[Model], modal (optional)[boolean]) [static]

Description

Starts an interactive editing panel to create a prescribed orientation rigid

Arguments

Model (Model)

Model that the prescribed orientation rigid will be created in.

modal (optional) (boolean)

If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

Returns

PrescribedOrientationRigid object (or null if not made).

Return type

PrescribedOrientationRigid

Example

To start creating a prescribed orientation rigid in model m:

var por = PrescribedOrientationRigid.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a prescribed orientation rigid.

Arguments

Comment (Comment)

Comment that will be detached from the prescribed orientation rigid

Returns

No return value

Example

To detach comment c from the prescribed orientation rigid por:

por.DetachComment(c);

Edit(modal (optional)[boolean])

Description

Starts an interactive editing panel.

Arguments

modal (optional) (boolean)

If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

Returns

no return value

Example

To Edit prescribed orientation rigid por:

por.Edit();

Error(message[string], details (optional)[string])

Description

Adds an error for prescribed orientation rigid. For more details on checking see the Check class.

Arguments

message (string)

The error message to give

details (optional) (string)

An optional detailed error message

Returns

No return value

Example

To add an error message "My custom error" for prescribed orientation rigid por:

por.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first prescribed orientation rigid in the model.

Arguments

Model (Model)

Model to get first prescribed orientation rigid in

Returns

PrescribedOrientationRigid object (or null if there are no prescribed orientation rigids in the model).

Return type

PrescribedOrientationRigid

Example

To get the first prescribed orientation rigid in model m:

var por = PrescribedOrientationRigid.First(m);

FlagAll(Model[Model], flag[Flag]) [static]

Description

Flags all of the prescribed orientation rigids in the model with a defined flag.

Arguments

Model (Model)

Model that all prescribed orientation rigids will be flagged in

flag (Flag)

Flag to set on the prescribed orientation rigids

Returns

No return value

Example

To flag all of the prescribed orientation rigids with flag f in model m:

PrescribedOrientationRigid.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the prescribed orientation rigid is flagged or not.

Arguments

flag (Flag)

Flag to test on the prescribed orientation rigid

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if prescribed orientation rigid por has flag f set on it:

if (por.Flagged(f) ) do_something...

ForEach(Model[Model], func[function], extra (optional)[any]) [static]

Description

Calls a function for each prescribed orientation rigid in the model.
Note that ForEach has been designed to make looping over prescribed orientation rigids as fast as possible and so has some limitations.
Firstly, a single temporary PrescribedOrientationRigid object is created and on each function call it is updated with the current prescribed orientation rigid data. This means that you should not try to store the PrescribedOrientationRigid object for later use (e.g. in an array) as it is temporary.
Secondly, you cannot create new prescribed orientation rigids inside a ForEach loop.

Arguments

Model (Model)

Model that all prescribed orientation rigids are in

func (function)

Function to call for each prescribed orientation rigid

extra (optional) (any)

An optional extra object/array/string etc that will appended to arguments when calling the function

Returns

No return value

Example

To call function test for all of the prescribed orientation rigids in model m:

PrescribedOrientationRigid.ForEach(m, test);
function test(por)
{
// por is PrescribedOrientationRigid object
}

To call function test for all of the prescribed orientation rigids in model m with optional object:

var data = { x:0, y:0 };
PrescribedOrientationRigid.ForEach(m, test, data);
function test(por, extra)
{
// por is PrescribedOrientationRigid object
// extra is data
}

GetAll(Model[Model], property (optional)[string]) [static]

Description

Returns an array of PrescribedOrientationRigid objects or properties for all of the prescribed orientation rigids in a model in PRIMER. If the optional property argument is not given then an array of PrescribedOrientationRigid objects is returned. If the property argument is given, that property value for each prescribed orientation rigid is returned in the array instead of a PrescribedOrientationRigid object

Arguments

Model (Model)

Model to get prescribed orientation rigids from

property (optional) (string)

Name for property to get for all prescribed orientation rigids in the model

Returns

Array of PrescribedOrientationRigid objects or properties

Return type

Array

Example

To make an array of PrescribedOrientationRigid objects for all of the prescribed orientation rigids in model m:

var a = PrescribedOrientationRigid.GetAll(m);

To return an array containing the value of property 'foo' (for example 'x' for a node) for each prescribed orientation rigid in model m:

var a = PrescribedOrientationRigid.GetAll(m, 'foo');

GetComments()

Description

Extracts the comments associated to a prescribed orientation rigid.

Arguments

No arguments

Returns

Array of Comment objects (or null if there are no comments associated to the node).

Return type

Array

Example

To get the array of comments associated to the prescribed orientation rigid por:

var comm_array = por.GetComments();

GetFlagged(Model[Model], flag[Flag], property (optional)[string]) [static]

Description

Returns an array of PrescribedOrientationRigid objects for all of the flagged prescribed orientation rigids in a model in PRIMER If the optional property argument is not given then an array of PrescribedOrientationRigid objects is returned. If the property argument is given, then that property value for each prescribed orientation rigid is returned in the array instead of a PrescribedOrientationRigid object

Arguments

Model (Model)

Model to get prescribed orientation rigids from

flag (Flag)

Flag set on the prescribed orientation rigids that you want to retrieve

property (optional) (string)

Name for property to get for all flagged prescribed orientation rigids in the model

Returns

Array of PrescribedOrientationRigid objects or properties

Return type

Array

Example

To make an array of PrescribedOrientationRigid objects for all of the prescribed orientation rigids in model m flagged with f:

var por = PrescribedOrientationRigid.GetFlagged(m, f);

To return an array containing the value of property 'foo' (for example 'x' for a node) for all of the prescribed orientation rigids in model m flagged with f:

var a = PrescribedOrientationRigid.GetFlagged(m, f, 'foo');

GetFromID(Model[Model], number[integer]) [static]

Description

Returns the PrescribedOrientationRigid object for a prescribed orientation rigid ID.

Arguments

Model (Model)

Model to find the prescribed orientation rigid in

number (integer)

number of the prescribed orientation rigid you want the PrescribedOrientationRigid object for

Returns

PrescribedOrientationRigid object (or null if prescribed orientation rigid does not exist).

Return type

PrescribedOrientationRigid

Example

To get the PrescribedOrientationRigid object for prescribed orientation rigid 100 in model m

var por = PrescribedOrientationRigid.GetFromID(m, 100);

GetParameter(prop[string])

Description

Checks if a PrescribedOrientationRigid property is a parameter or not. Note that object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. For this function to work the JavaScript interpreter must use the parameter name instead of the value. This can be done by setting the Options.property_parameter_names option to true before calling the function and then resetting it to false afterwards.. This behaviour can also temporarily be switched by using the PrescribedOrientationRigid.ViewParameters() method and 'method chaining' (see the examples below).

Arguments

prop (string)

prescribed orientation rigid property to get parameter for

Returns

Parameter object if property is a parameter, null if not.

Return type

Parameter

Example

To check if PrescribedOrientationRigid property por.example is a parameter:

Options.property_parameter_names = true;
if (por.GetParameter(por.example) ) do_something...
Options.property_parameter_names = false;

To check if PrescribedOrientationRigid property por.example is a parameter by using the GetParameter method:

if (por.ViewParameters().GetParameter(por.example) ) do_something...

Keyword()

Description

Returns the keyword for this prescribed orientation rigid. Note that a carriage return is not added. See also PrescribedOrientationRigid.KeywordCards()

Arguments

No arguments

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for prescribed orientation rigid por:

var key = por.Keyword();

KeywordCards()

Description

Returns the keyword cards for the prescribed orientation rigid. Note that a carriage return is not added. See also PrescribedOrientationRigid.Keyword()

Arguments

No arguments

Returns

string containing the cards.

Return type

String

Example

To get the cards for prescribed orientation rigid por:

var cards = por.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last prescribed orientation rigid in the model.

Arguments

Model (Model)

Model to get last prescribed orientation rigid in

Returns

PrescribedOrientationRigid object (or null if there are no prescribed orientation rigids in the model).

Return type

PrescribedOrientationRigid

Example

To get the last prescribed orientation rigid in model m:

var por = PrescribedOrientationRigid.Last(m);

Next()

Description

Returns the next prescribed orientation rigid in the model.

Arguments

No arguments

Returns

PrescribedOrientationRigid object (or null if there are no more prescribed orientation rigids in the model).

Return type

PrescribedOrientationRigid

Example

To get the prescribed orientation rigid in model m after prescribed orientation rigid por:

var por = por.Next();

Previous()

Description

Returns the previous prescribed orientation rigid in the model.

Arguments

No arguments

Returns

PrescribedOrientationRigid object (or null if there are no more prescribed orientation rigids in the model).

Return type

PrescribedOrientationRigid

Example

To get the prescribed orientation rigid in model m before prescribed orientation rigid por:

var por = por.Previous();

Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean]) [static]

Description

Allows the user to select prescribed orientation rigids using standard PRIMER object menus.

Arguments

flag (Flag)

Flag to use when selecting prescribed orientation rigids

prompt (string)

Text to display as a prompt to the user

limit (optional) (Model or Flag)

If the argument is a Model then only prescribed orientation rigids from that model can be selected. If the argument is a Flag then only prescribed orientation rigids that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any prescribed orientation rigids can be selected. from any model.

modal (optional) (boolean)

If selection is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the selection will be modal.

Returns

Number of prescribed orientation rigids selected or null if menu cancelled

Return type

Number

Example

To select prescribed orientation rigids from model m, flagging those selected with flag f, giving the prompt 'Select prescribed orientation rigids':

PrescribedOrientationRigid.Select(f, 'Select prescribed orientation rigids', m);

To select prescribed orientation rigids, flagging those selected with flag f but limiting selection to prescribed orientation rigids flagged with flag l, giving the prompt 'Select prescribed orientation rigids':

PrescribedOrientationRigid.Select(f, 'Select prescribed orientation rigids', l);

SetFlag(flag[Flag])

Description

Sets a flag on the prescribed orientation rigid.

Arguments

flag (Flag)

Flag to set on the prescribed orientation rigid

Returns

No return value

Example

To set flag f for prescribed orientation rigid por:

por.SetFlag(f);

Sketch(redraw (optional)[boolean])

Description

Sketches the prescribed orientation rigid. The prescribed orientation rigid will be sketched until you either call PrescribedOrientationRigid.Unsketch(), PrescribedOrientationRigid.UnsketchAll(), Model.UnsketchAll(), or delete the model

Arguments

redraw (optional) (boolean)

If model should be redrawn or not after the prescribed orientation rigid is sketched. If omitted redraw is true. If you want to sketch several prescribed orientation rigids and only redraw after the last one then use false for redraw and call View.Redraw().

Returns

No return value

Example

To sketch prescribed orientation rigid por:

por.Sketch();

SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

Description

Sketches all of the flagged prescribed orientation rigids in the model. The prescribed orientation rigids will be sketched until you either call PrescribedOrientationRigid.Unsketch(), PrescribedOrientationRigid.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

Arguments

Model (Model)

Model that all the flagged prescribed orientation rigids will be sketched in

flag (Flag)

Flag set on the prescribed orientation rigids that you want to sketch

redraw (optional) (boolean)

If model should be redrawn or not after the prescribed orientation rigids are sketched. If omitted redraw is true. If you want to sketch flagged prescribed orientation rigids several times and only redraw after the last one then use false for redraw and call View.Redraw().

Returns

No return value

Example

To sketch all prescribed orientation rigids flagged with flag in model m:

PrescribedOrientationRigid.SketchFlagged(m, flag);

Total(Model[Model], exists (optional)[boolean]) [static]

Description

Returns the total number of prescribed orientation rigids in the model.

Arguments

Model (Model)

Model to get total for

exists (optional) (boolean)

true if only existing prescribed orientation rigids should be counted. If false or omitted referenced but undefined prescribed orientation rigids will also be included in the total.

Returns

number of prescribed orientation rigids

Return type

Number

Example

To get the total number of prescribed orientation rigids in model m:

var total = PrescribedOrientationRigid.Total(m);

UnflagAll(Model[Model], flag[Flag]) [static]

Description

Unsets a defined flag on all of the prescribed orientation rigids in the model.

Arguments

Model (Model)

Model that the defined flag for all prescribed orientation rigids will be unset in

flag (Flag)

Flag to unset on the prescribed orientation rigids

Returns

No return value

Example

To unset the flag f on all the prescribed orientation rigids in model m:

PrescribedOrientationRigid.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the prescribed orientation rigid.

Arguments

redraw (optional) (boolean)

If model should be redrawn or not after the prescribed orientation rigid is unsketched. If omitted redraw is true. If you want to unsketch several prescribed orientation rigids and only redraw after the last one then use false for redraw and call View.Redraw().

Returns

No return value

Example

To unsketch prescribed orientation rigid por:

por.Unsketch();

UnsketchAll(Model[Model], redraw (optional)[boolean]) [static]

Description

Unsketches all prescribed orientation rigids.

Arguments

Model (Model)

Model that all prescribed orientation rigids will be unblanked in

redraw (optional) (boolean)

If model should be redrawn or not after the prescribed orientation rigids are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw().

Returns

No return value

Example

To unsketch all prescribed orientation rigids in model m:

PrescribedOrientationRigid.UnsketchAll(m);

UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

Description

Unsketches all flagged prescribed orientation rigids in the model.

Arguments

Model (Model)

Model that all prescribed orientation rigids will be unsketched in

flag (Flag)

Flag set on the prescribed orientation rigids that you want to unsketch

redraw (optional) (boolean)

Returns

No return value

Example

To unsketch all prescribed orientation rigids flagged with flag in model m:

PrescribedOrientationRigid.UnsketchAll(m, flag);

ViewParameters()

Description

Object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. This function temporarily changes the behaviour so that if a property is a parameter the parameter name is returned instead. This can be used with 'method chaining' (see the example below) to make sure a property argument is correct.

Arguments

No arguments

Returns

PrescribedOrientationRigid object.

Return type

PrescribedOrientationRigid

Example

To check if PrescribedOrientationRigid property por.example is a parameter by using the PrescribedOrientationRigid.GetParameter() method:

if (por.ViewParameters().GetParameter(por.example) ) do_something...

Warning(message[string], details (optional)[string])

Description

Adds a warning for prescribed orientation rigid. For more details on checking see the Check class.

Arguments

message (string)

The warning message to give

details (optional) (string)

An optional detailed warning message

Returns

No return value

Example

To add a warning message "My custom warning" for prescribed orientation rigid por:

por.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this prescribed orientation rigid.

Arguments

No arguments

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for prescribed orientation rigid por:

var xrefs = por.Xrefs();

toString()

Description

Creates a string containing the prescribed orientation rigid data in keyword format. Note that this contains the keyword header and the keyword cards. See also PrescribedOrientationRigid.Keyword() and PrescribedOrientationRigid.KeywordCards().

Arguments

No arguments

Returns

string

Return type

String

Example

To get data for prescribed orientation rigid por in keyword format

var s = por.toString();