PrescribedAccelerometerRigid class

The PrescribedAccelerometerRigid class gives you access to define *BOUNDARY_PRESCRIBED_ACCELEROMETER_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])
Total(Model[Model], exists (optional)[boolean])
UnflagAll(Model[Model], flag[Flag])

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])
GetRow(row[integer])
Keyword()
KeywordCards()
Next()
Previous()
RemoveRow(row[integer])
SetFlag(flag[Flag])
SetRow(row[integer], data[Array of data])
ViewParameters()
Warning(message[string], details (optional)[string])
Xrefs()
toString()

PrescribedAccelerometerRigid properties

Name	Type	Description
exists (read only)	logical	true if prescribed accelerometer rigid exists, false if referred to but not defined.
include	integer	The Include file number that the prescribed accelerometer rigid is in.
model (read only)	integer	The Model number that the prescribed accelerometer rigid is in.
nrow (read only)	integer	Number of accelerometer cards.
pid	integer	Part ID for rigid body whose motion is prescribed.
solv	integer	Solver type: 1 for Gaussian elimination or 2 for linear regression.

Detailed Description

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

Constructor

new PrescribedAccelerometerRigid(Model[Model], pid[integer], solv (optional)[integer])

Description

Create a new PrescribedAccelerometerRigid object.

Arguments

Model (Model)

Model that prescribed accelerometer rigid will be created in

pid (integer)

Part ID for rigid body whose motion is prescribed.

solv (optional) (integer)

Solver type

Returns

PrescribedAccelerometerRigid object

Return type

PrescribedAccelerometerRigid

Example

To create a new prescribed accelerometer rigid in model m with part ID 10 and solver type 2 (linear regression):

var par = new PrescribedAccelerometerRigid(m, 10, 2);

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a prescribed accelerometer rigid.

Arguments

Comment (Comment)

Comment that will be attached to the prescribed accelerometer rigid

Returns

No return value

Example

To associate comment c to the prescribed accelerometer rigid par:

par.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 accelerometer rigid par:

par.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the prescribed accelerometer rigid.

Arguments

flag (Flag)

Flag to clear on the prescribed accelerometer rigid

Returns

No return value

Example

To clear flag f for prescribed accelerometer rigid par:

par.ClearFlag(f);

Copy(range (optional)[boolean])

Description

Copies the prescribed accelerometer rigid. The target include of the copied prescribed accelerometer 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

PrescribedAccelerometerRigid object

Return type

PrescribedAccelerometerRigid

Example

To copy prescribed accelerometer rigid par into prescribed accelerometer rigid z:

var z = par.Copy();

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

Description

Starts an interactive editing panel to create a prescribed accelerometer rigid

Arguments

Model (Model)

Model that the prescribed accelerometer 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

PrescribedAccelerometerRigid object (or null if not made).

Return type

PrescribedAccelerometerRigid

Example

To start creating a prescribed accelerometer rigid in model m:

var par = PrescribedAccelerometerRigid.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a prescribed accelerometer rigid.

Arguments

Comment (Comment)

Comment that will be detached from the prescribed accelerometer rigid

Returns

No return value

Example

To detach comment c from the prescribed accelerometer rigid par:

par.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 accelerometer rigid par:

par.Edit();

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

Description

Adds an error for prescribed accelerometer 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 accelerometer rigid par:

par.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first prescribed accelerometer rigid in the model.

Arguments

Model (Model)

Model to get first prescribed accelerometer rigid in

Returns

PrescribedAccelerometerRigid object (or null if there are no prescribed accelerometer rigids in the model).

Return type

PrescribedAccelerometerRigid

Example

To get the first prescribed accelerometer rigid in model m:

var par = PrescribedAccelerometerRigid.First(m);

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

Description

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

Arguments

Model (Model)

Model that all prescribed accelerometer rigids will be flagged in

flag (Flag)

Flag to set on the prescribed accelerometer rigids

Returns

No return value

Example

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

PrescribedAccelerometerRigid.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the prescribed accelerometer rigid is flagged or not.

Arguments

flag (Flag)

Flag to test on the prescribed accelerometer rigid

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if prescribed accelerometer rigid par has flag f set on it:

if (par.Flagged(f) ) do_something...

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

Description

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

Arguments

Model (Model)

Model that all prescribed accelerometer rigids are in

func (function)

Function to call for each prescribed accelerometer 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 accelerometer rigids in model m:

PrescribedAccelerometerRigid.ForEach(m, test);
function test(par)
{
// par is PrescribedAccelerometerRigid object
}

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

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

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

Description

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

Arguments

Model (Model)

Model to get prescribed accelerometer rigids from

property (optional) (string)

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

Returns

Array of PrescribedAccelerometerRigid objects or properties

Return type

Array

Example

To make an array of PrescribedAccelerometerRigid objects for all of the prescribed accelerometer rigids in model m:

var a = PrescribedAccelerometerRigid.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a prescribed accelerometer 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 accelerometer rigid par:

var comm_array = par.GetComments();

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

Description

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

Arguments

Model (Model)

Model to get prescribed accelerometer rigids from

flag (Flag)

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

property (optional) (string)

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

Returns

Array of PrescribedAccelerometerRigid objects or properties

Return type

Array

Example

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

var par = PrescribedAccelerometerRigid.GetFlagged(m, f);

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

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

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

Description

Returns the PrescribedAccelerometerRigid object for a prescribed accelerometer rigid ID.

Arguments

Model (Model)

Model to find the prescribed accelerometer rigid in

number (integer)

number of the prescribed accelerometer rigid you want the PrescribedAccelerometerRigid object for

Returns

PrescribedAccelerometerRigid object (or null if prescribed accelerometer rigid does not exist).

Return type

PrescribedAccelerometerRigid

Example

To get the PrescribedAccelerometerRigid object for prescribed accelerometer rigid 100 in model m

var par = PrescribedAccelerometerRigid.GetFromID(m, 100);

GetParameter(prop[string])

Description

Checks if a PrescribedAccelerometerRigid 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 PrescribedAccelerometerRigid.ViewParameters() method and 'method chaining' (see the examples below).

Arguments

prop (string)

prescribed accelerometer rigid property to get parameter for

Returns

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

Return type

Parameter

Example

To check if PrescribedAccelerometerRigid property par.example is a parameter:

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

To check if PrescribedAccelerometerRigid property par.example is a parameter by using the GetParameter method:

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

GetRow(row[integer])

Description

Returns the data for a row in the prescribed accelerometer rigid.

Arguments

row (integer)

The row you want the data for. Note row indices start at 0.

Returns

An array of numbers containing the row variables NID, CID, LCIDX, LCIDY and LCIDZ.

Return type

Number

Example

To get the data for the 2nd row in prescribed accelerometer rigid par:

var data = par.GetRow(1);

Keyword()

Description

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

Arguments

No arguments

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for prescribed accelerometer rigid par:

var key = par.Keyword();

KeywordCards()

Description

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

Arguments

No arguments

Returns

string containing the cards.

Return type

String

Example

To get the cards for prescribed accelerometer rigid par:

var cards = par.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last prescribed accelerometer rigid in the model.

Arguments

Model (Model)

Model to get last prescribed accelerometer rigid in

Returns

PrescribedAccelerometerRigid object (or null if there are no prescribed accelerometer rigids in the model).

Return type

PrescribedAccelerometerRigid

Example

To get the last prescribed accelerometer rigid in model m:

var par = PrescribedAccelerometerRigid.Last(m);

Next()

Description

Returns the next prescribed accelerometer rigid in the model.

Arguments

No arguments

Returns

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

Return type

PrescribedAccelerometerRigid

Example

To get the prescribed accelerometer rigid in model m after prescribed accelerometer rigid par:

var par = par.Next();

Previous()

Description

Returns the previous prescribed accelerometer rigid in the model.

Arguments

No arguments

Returns

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

Return type

PrescribedAccelerometerRigid

Example

To get the prescribed accelerometer rigid in model m before prescribed accelerometer rigid par:

var par = par.Previous();

RemoveRow(row[integer])

Description

Removes the data for a row in *BOUNDARY_PRESCRIBED_ACCELEROMETER_RIGID.

Arguments

row (integer)

The row you want to remove the data for. Note that row indices start at 0.

Returns

No return value.

Example

To remove the second row of data for prescribed accelerometer rigid par:

par.RemoveRow(1);

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

Description

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

Arguments

flag (Flag)

Flag to use when selecting prescribed accelerometer 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 accelerometer rigids from that model can be selected. If the argument is a Flag then only prescribed accelerometer rigids that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any prescribed accelerometer 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 accelerometer rigids selected or null if menu cancelled

Return type

Number

Example

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

PrescribedAccelerometerRigid.Select(f, 'Select prescribed accelerometer rigids', m);

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

PrescribedAccelerometerRigid.Select(f, 'Select prescribed accelerometer rigids', l);

SetFlag(flag[Flag])

Description

Sets a flag on the prescribed accelerometer rigid.

Arguments

flag (Flag)

Flag to set on the prescribed accelerometer rigid

Returns

No return value

Example

To set flag f for prescribed accelerometer rigid par:

par.SetFlag(f);

SetRow(row[integer], data[Array of data])

Description

Sets the data for a row in *BOUNDARY_PRESCRIBED_ACCELEROMETER_RIGID.

Arguments

row (integer)

The row you want to set the data for. Note that row indices start at 0.

data (Array of data)

The data you want to set the row to

Returns

No return value.

Example

To set the second row of data for prescribed accelerometer rigid par to be node 11, coordinate system 12, and load curves 13, 14, 15:

var array = [11, 12, 13, 14, 15];
par.SetRow(1, array);

To append a new row of data (using the same array of values):

par.SetRow(par.nrow, array);

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

Description

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

Arguments

Model (Model)

Model to get total for

exists (optional) (boolean)

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

Returns

number of prescribed accelerometer rigids

Return type

Number

Example

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

var total = PrescribedAccelerometerRigid.Total(m);

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

Description

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

Arguments

Model (Model)

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

flag (Flag)

Flag to unset on the prescribed accelerometer rigids

Returns

No return value

Example

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

PrescribedAccelerometerRigid.UnflagAll(m, f);

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

PrescribedAccelerometerRigid object.

Return type

PrescribedAccelerometerRigid

Example

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

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

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

Description

Adds a warning for prescribed accelerometer 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 accelerometer rigid par:

par.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this prescribed accelerometer rigid.

Arguments

No arguments

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for prescribed accelerometer rigid par:

var xrefs = par.Xrefs();

toString()

Description

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

Arguments

No arguments

Returns

string

Return type

String

Example

To get data for prescribed accelerometer rigid par in keyword format

var s = par.toString();