LoadRigidBody class

The LoadRigidBody class gives you access to define load rigidbody 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:

Class functions

Member functions

LoadRigidBody properties

Name Type Description
cid integer Coordinate system ID
dof integer Applicable degrees-of-freedom
exists (read only) logical true if load rigidbody exists, false if referred to but not defined.
include integer The Include file number that the load rigidbody is in.
lcid integer Curve ID
m1 integer Node 1 ID
m2 integer Node 2 ID
m3 integer Node 3 ID
model (read only) integer The Model number that the load rigidbody is in.
pid integer Part ID
sf real Curve scale factor

Detailed Description

The LoadRigidBody class allows you to create, modify, edit and manipulate load rigidbody cards. See the documentation below for more details.

Constructor

new LoadRigidBody(Model[Model], pid[integer], dof[integer], lcid[integer], sf (optional)[real], cid (optional)[integer], m1 (optional)[integer], m2 (optional)[integer], m3 (optional)[integer])

Description

Create a new LoadRigidBody object.

Arguments

  • Model (Model)

    Model that load rigidbody will be created in

  • pid (integer)

    Part ID

  • dof (integer)

    Applicable degrees-of-freedom

  • lcid (integer)

    Curve ID

  • sf (optional) (real)

    Curve scale factor

  • cid (optional) (integer)

    Coordinate system ID

  • m1 (optional) (integer)

    Node 1 ID

  • m2 (optional) (integer)

    Node 2 ID

  • m3 (optional) (integer)

    Node 3 ID

    Returns

    LoadRigidBody object

    Return type

    LoadRigidBody

    Example

    To create a new load rigidbody in model m, for part 100, with loadcurve 9 and a scale factor of 0.5 

    var lrb = new LoadRigidBody(m, 100, 2, 9, 0.5);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a load rigidbody.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the load rigidbody

    Returns

    No return value

    Example

    To associate comment c to the load rigidbody lrb: 

    lrb.AssociateComment(c);

    Blank()

    Description

    Blanks the load rigidbody

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank load rigidbody lrb: 

    lrb.Blank();

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

    Description

    Blanks all of the load rigidbodies in the model.

    Arguments

  • Model (Model)

    Model that all load rigidbodies will be blanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To blank all of the load rigidbodies in model m: 

    LoadRigidBody.BlankAll(m);

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

    Description

    Blanks all of the flagged load rigidbodies in the model.

    Arguments

  • Model (Model)

    Model that all the flagged load rigidbodies will be blanked in

  • flag (Flag)

    Flag set on the load rigidbodies that you want to blank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To blank all of the load rigidbodies in model m flagged with f: 

    LoadRigidBody.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the load rigidbody is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if load rigidbody lrb is blanked: 

    if (lrb.Blanked() ) do_something...

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the load rigidbody.

    Arguments

  • flag (Flag)

    Flag to clear on the load rigidbody

    Returns

    No return value

    Example

    To clear flag f for load rigidbody lrb: 

    lrb.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

    Copies the load rigidbody. The target include of the copied load rigidbody 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

    LoadRigidBody object

    Return type

    LoadRigidBody

    Example

    To copy load rigidbody lrb into load rigidbody z: 

    var z = lrb.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a load rigidbody.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the load rigidbody

    Returns

    No return value

    Example

    To detach comment c from the load rigidbody lrb: 

    lrb.DetachComment(c);

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

    Description

    Adds an error for load rigidbody. 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 load rigidbody lrb: 

    lrb.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first load rigidbody in the model.

    Arguments

  • Model (Model)

    Model to get first load rigidbody in

    Returns

    LoadRigidBody object (or null if there are no load rigidbodies in the model).

    Return type

    LoadRigidBody

    Example

    To get the first load rigidbody in model m: 

    var lrb = LoadRigidBody.First(m);

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

    Description

    Flags all of the load rigidbodies in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all load rigidbodies will be flagged in

  • flag (Flag)

    Flag to set on the load rigidbodies

    Returns

    No return value

    Example

    To flag all of the load rigidbodies with flag f in model m: 

    LoadRigidBody.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the load rigidbody is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the load rigidbody

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if load rigidbody lrb has flag f set on it: 

    if (lrb.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all load rigidbodies are in

  • func (function)

    Function to call for each load rigidbody

  • 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 load rigidbodies in model m: 

    LoadRigidBody.ForEach(m, test);
function test(lrb)
{
// lrb is LoadRigidBody object
}

    To call function test for all of the load rigidbodies in model m with optional object: 

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

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

    Description

    Returns an array of LoadRigidBody objects or properties for all of the load rigidbodies in a model in PRIMER. If the optional property argument is not given then an array of LoadRigidBody objects is returned. If the property argument is given, that property value for each load rigidbody is returned in the array instead of a LoadRigidBody object

    Arguments

  • Model (Model)

    Model to get load rigidbodies from

  • property (optional) (string)

    Name for property to get for all load rigidbodies in the model

    Returns

    Array of LoadRigidBody objects or properties

    Return type

    Array

    Example

    To make an array of LoadRigidBody objects for all of the load rigidbodies in model m: 

    var a = LoadRigidBody.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a load rigidbody.

    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 load rigidbody lrb: 

    var comm_array = lrb.GetComments();

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

    Description

    Returns an array of LoadRigidBody objects for all of the flagged load rigidbodies in a model in PRIMER If the optional property argument is not given then an array of LoadRigidBody objects is returned. If the property argument is given, then that property value for each load rigidbody is returned in the array instead of a LoadRigidBody object

    Arguments

  • Model (Model)

    Model to get load rigidbodies from

  • flag (Flag)

    Flag set on the load rigidbodies that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged load rigidbodies in the model

    Returns

    Array of LoadRigidBody objects or properties

    Return type

    Array

    Example

    To make an array of LoadRigidBody objects for all of the load rigidbodies in model m flagged with f: 

    var lrb = LoadRigidBody.GetFlagged(m, f);

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

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

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

    Description

    Returns the LoadRigidBody object for a load rigidbody ID.

    Arguments

  • Model (Model)

    Model to find the load rigidbody in

  • number (integer)

    number of the load rigidbody you want the LoadRigidBody object for

    Returns

    LoadRigidBody object (or null if load rigidbody does not exist).

    Return type

    LoadRigidBody

    Example

    To get the LoadRigidBody object for load rigidbody 100 in model m 

    var lrb = LoadRigidBody.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    load rigidbody property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if LoadRigidBody property lrb.example is a parameter: 

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

    To check if LoadRigidBody property lrb.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this load rigidbody (*LOAD_RIGIDBODY). Note that a carriage return is not added. See also LoadRigidBody.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for load rigidbody lrb: 

    var key = lrb.Keyword();

    KeywordCards()

    Description

    Returns the keyword cards for the load rigidbody. Note that a carriage return is not added. See also LoadRigidBody.Keyword()

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for load rigidbody lrb: 

    var cards = lrb.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last load rigidbody in the model.

    Arguments

  • Model (Model)

    Model to get last load rigidbody in

    Returns

    LoadRigidBody object (or null if there are no load rigidbodies in the model).

    Return type

    LoadRigidBody

    Example

    To get the last load rigidbody in model m: 

    var lrb = LoadRigidBody.Last(m);

    Next()

    Description

    Returns the next load rigidbody in the model.

    Arguments

    No arguments

    Returns

    LoadRigidBody object (or null if there are no more load rigidbodies in the model).

    Return type

    LoadRigidBody

    Example

    To get the load rigidbody in model m after load rigidbody lrb: 

    var lrb = lrb.Next();

    Pick(prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean], button text (optional)[string]) [static]

    Description

    Allows the user to pick a load rigidbody.

    Arguments

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

    If the argument is a Model then only load rigidbodies from that model can be picked. If the argument is a Flag then only load rigidbodies that are flagged with limit can be selected. If omitted, or null, any load rigidbodies from any model can be selected. from any model.

  • modal (optional) (boolean)

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

  • button text (optional) (string)

    By default the window with the prompt will have a button labelled 'Cancel' which if pressed will cancel the pick and return null. If you want to change the text on the button use this argument. If omitted 'Cancel' will be used.

    Returns

    LoadRigidBody object (or null if not picked)

    Return type

    LoadRigidBody

    Example

    To pick a load rigidbody from model m giving the prompt 'Pick load rigidbody from screen': 

    var lrb = LoadRigidBody.Pick('Pick load rigidbody from screen', m);

    Previous()

    Description

    Returns the previous load rigidbody in the model.

    Arguments

    No arguments

    Returns

    LoadRigidBody object (or null if there are no more load rigidbodies in the model).

    Return type

    LoadRigidBody

    Example

    To get the load rigidbody in model m before load rigidbody lrb: 

    var lrb = lrb.Previous();

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

    Description

    Allows the user to select load rigidbodies using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting load rigidbodies

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

    To select load rigidbodies from model m, flagging those selected with flag f, giving the prompt 'Select load rigidbodies': 

    LoadRigidBody.Select(f, 'Select load rigidbodies', m);

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

    LoadRigidBody.Select(f, 'Select load rigidbodies', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the load rigidbody.

    Arguments

  • flag (Flag)

    Flag to set on the load rigidbody

    Returns

    No return value

    Example

    To set flag f for load rigidbody lrb: 

    lrb.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the load rigidbody. The load rigidbody will be sketched until you either call LoadRigidBody.Unsketch(), LoadRigidBody.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch load rigidbody lrb: 

    lrb.Sketch();

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

    Description

    Sketches all of the flagged load rigidbodies in the model. The load rigidbodies will be sketched until you either call LoadRigidBody.Unsketch(), LoadRigidBody.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

    Arguments

  • Model (Model)

    Model that all the flagged load rigidbodies will be sketched in

  • flag (Flag)

    Flag set on the load rigidbodies that you want to sketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the load rigidbodies are sketched. If omitted redraw is true. If you want to sketch flagged load rigidbodies 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 load rigidbodies flagged with flag in model m: 

    LoadRigidBody.SketchFlagged(m, flag);

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

    Description

    Returns the total number of load rigidbodies in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of load rigidbodies

    Return type

    Number

    Example

    To get the total number of load rigidbodies in model m: 

    var total = LoadRigidBody.Total(m);

    Unblank()

    Description

    Unblanks the load rigidbody

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank load rigidbody lrb: 

    lrb.Unblank();

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

    Description

    Unblanks all of the load rigidbodies in the model.

    Arguments

  • Model (Model)

    Model that all load rigidbodies will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To unblank all of the load rigidbodies in model m: 

    LoadRigidBody.UnblankAll(m);

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

    Description

    Unblanks all of the flagged load rigidbodies in the model.

    Arguments

  • Model (Model)

    Model that the flagged load rigidbodies will be unblanked in

  • flag (Flag)

    Flag set on the load rigidbodies that you want to unblank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To unblank all of the load rigidbodies in model m flagged with f: 

    LoadRigidBody.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the load rigidbodies in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all load rigidbodies will be unset in

  • flag (Flag)

    Flag to unset on the load rigidbodies

    Returns

    No return value

    Example

    To unset the flag f on all the load rigidbodies in model m: 

    LoadRigidBody.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the load rigidbody.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch load rigidbody lrb: 

    lrb.Unsketch();

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

    Description

    Unsketches all load rigidbodies.

    Arguments

  • Model (Model)

    Model that all load rigidbodies will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not after the load rigidbodies 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 load rigidbodies in model m: 

    LoadRigidBody.UnsketchAll(m);

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

    Description

    Unsketches all flagged load rigidbodies in the model.

    Arguments

  • Model (Model)

    Model that all load rigidbodies will be unsketched in

  • flag (Flag)

    Flag set on the load rigidbodies that you want to unsketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the load rigidbodies 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 load rigidbodies flagged with flag in model m: 

    LoadRigidBody.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

    LoadRigidBody object.

    Return type

    LoadRigidBody

    Example

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

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

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

    Description

    Adds a warning for load rigidbody. 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 load rigidbody lrb: 

    lrb.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this load rigidbody.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for load rigidbody lrb: 

    var xrefs = lrb.Xrefs();

    toString()

    Description

    Creates a string containing the load rigidbody data in keyword format. Note that this contains the keyword header and the keyword cards. See also LoadRigidBody.Keyword() and LoadRigidBody.KeywordCards().

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for load rigidbody lrb in keyword format 

    var s = lrb.toString();