LoadGravity class

The LoadGravity class gives you access to define *LOAD_GRAVITY_PART 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

LoadGravity constants

Name Description
LoadGravity.PART LOAD is *LOAD_GRAVITY_PART.
LoadGravity.SET_PART LOAD is *LOAD_GRAVITY_PART_SET.

LoadGravity properties

Name Type Description
accel real Acceleration (will be multiplied by factor from curve)
dof integer Direction: enter 1, 2 or 3 for x, y, or z
exists (read only) logical true if load gravity exists, false if referred to but not defined.
include integer The Include file number that the load gravity is in.
lc integer Curve ID. Load curve defining factor vs. time (or zero if STGA, STGR are defined)
lcdr integer Curve ID. Load curve defining factor vs. time during dynamic relaxation
model (read only) integer The Model number that the load gravity is in.
pid integer Part ID or Part set ID
stga integer Construction Stages ID at which part is added (optional)
stgr integer Construction Stages ID at which part is removed (optional)
type constant The Load Gravity type. Can be LoadGravity.PART or LoadGravity.SET_PART.

Detailed Description

The LoadGravity class allows you to create, modify, edit and manipulate *LOAD_GRAVITY_PART cards. See the documentation below for more details.

Constructor

new LoadGravity(Model[Model], type[constant], pid[integer], dof[integer], lc[integer], accel[real], lcdr[integer], stga (optional)[integer], stgr (optional)[integer])

Description

Create a new LoadGravity object.

Arguments

  • Model (Model)

    Model that LoadGravity will be created in

  • type (constant)

    Specify the type of LoadGravity (Can be LoadGravity.PART or LoadGravity.SET_PART

  • pid (integer)

    Part ID or Part set ID

  • dof (integer)

    Direction: enter 1, 2 or 3 for x, y or z

  • lc (integer)

    Curve ID. Load curve defining factor vs. time (or zero if STGA, STGR are defined)

  • accel (real)

    Acceleration (will be multiplied by factor from curve)

  • lcdr (integer)

    Curve ID. Load curve defining factor vs. time during dynamic relaxation

  • stga (optional) (integer)

    Construction Stage ID at which part is added

  • stgr (optional) (integer)

    Construction Stage ID at which part is removed

    Returns

    LoadGravity object

    Return type

    LoadGravity

    Example

    To create a new load gravity in model m, of type SET, with dof 2, loadcurve 9, acceleration of 0.5, and lcdr 10 

    var lg = new LoadGravity(m, LoadGravity.PART, 100, 2, 9, 0.5, 10);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a load gravity.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the load gravity

    Returns

    No return value

    Example

    To associate comment c to the load gravity lg: 

    lg.AssociateComment(c);

    Blank()

    Description

    Blanks the load gravity

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank load gravity lg: 

    lg.Blank();

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

    Description

    Blanks all of the load gravitys in the model.

    Arguments

  • Model (Model)

    Model that all load gravitys 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 gravitys in model m: 

    LoadGravity.BlankAll(m);

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

    Description

    Blanks all of the flagged load gravitys in the model.

    Arguments

  • Model (Model)

    Model that all the flagged load gravitys will be blanked in

  • flag (Flag)

    Flag set on the load gravitys 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 gravitys in model m flagged with f: 

    LoadGravity.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the load gravity is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if load gravity lg is blanked: 

    if (lg.Blanked() ) do_something...

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the load gravity.

    Arguments

  • flag (Flag)

    Flag to clear on the load gravity

    Returns

    No return value

    Example

    To clear flag f for load gravity lg: 

    lg.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    LoadGravity object

    Return type

    LoadGravity

    Example

    To copy load gravity lg into load gravity z: 

    var z = lg.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a load gravity.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the load gravity

    Returns

    No return value

    Example

    To detach comment c from the load gravity lg: 

    lg.DetachComment(c);

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

    Description

    Adds an error for load gravity. 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 gravity lg: 

    lg.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first load gravity in the model.

    Arguments

  • Model (Model)

    Model to get first load gravity in

    Returns

    LoadGravity object (or null if there are no load gravitys in the model).

    Return type

    LoadGravity

    Example

    To get the first load gravity in model m: 

    var lg = LoadGravity.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all load gravitys will be flagged in

  • flag (Flag)

    Flag to set on the load gravitys

    Returns

    No return value

    Example

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

    LoadGravity.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the load gravity is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the load gravity

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if load gravity lg has flag f set on it: 

    if (lg.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all load gravitys are in

  • func (function)

    Function to call for each load gravity

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

    LoadGravity.ForEach(m, test);
function test(lg)
{
// lg is LoadGravity object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get load gravitys from

  • property (optional) (string)

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

    Returns

    Array of LoadGravity objects or properties

    Return type

    Array

    Example

    To make an array of LoadGravity objects for all of the load gravitys in model m: 

    var a = LoadGravity.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a load gravity.

    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 gravity lg: 

    var comm_array = lg.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get load gravitys from

  • flag (Flag)

    Flag set on the load gravitys that you want to retrieve

  • property (optional) (string)

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

    Returns

    Array of LoadGravity objects or properties

    Return type

    Array

    Example

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

    var lg = LoadGravity.GetFlagged(m, f);

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

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

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

    Description

    Returns the LoadGravity object for a load gravity ID.

    Arguments

  • Model (Model)

    Model to find the load gravity in

  • number (integer)

    number of the load gravity you want the LoadGravity object for

    Returns

    LoadGravity object (or null if load gravity does not exist).

    Return type

    LoadGravity

    Example

    To get the LoadGravity object for load gravity 100 in model m 

    var lg = LoadGravity.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    load gravity property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if LoadGravity property lg.example is a parameter: 

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

    To check if LoadGravity property lg.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this LoadGravity (*LOAD_GRAVITY_PART). Note that a carriage return is not added. See also LoadGravity.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for LoadGravity lg: 

    var key = lg.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for LoadGravity lg: 

    var cards = lg.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last load gravity in the model.

    Arguments

  • Model (Model)

    Model to get last load gravity in

    Returns

    LoadGravity object (or null if there are no load gravitys in the model).

    Return type

    LoadGravity

    Example

    To get the last load gravity in model m: 

    var lg = LoadGravity.Last(m);

    Next()

    Description

    Returns the next load gravity in the model.

    Arguments

    No arguments

    Returns

    LoadGravity object (or null if there are no more load gravitys in the model).

    Return type

    LoadGravity

    Example

    To get the load gravity in model m after load gravity lg: 

    var lg = lg.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 gravity.

    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 gravitys from that model can be picked. If the argument is a Flag then only load gravitys that are flagged with limit can be selected. If omitted, or null, any load gravitys 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

    LoadGravity object (or null if not picked)

    Return type

    LoadGravity

    Example

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

    var lg = LoadGravity.Pick('Pick load gravity from screen', m);

    Previous()

    Description

    Returns the previous load gravity in the model.

    Arguments

    No arguments

    Returns

    LoadGravity object (or null if there are no more load gravitys in the model).

    Return type

    LoadGravity

    Example

    To get the load gravity in model m before load gravity lg: 

    var lg = lg.Previous();

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting load gravitys

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

    Return type

    Number

    Example

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

    LoadGravity.Select(f, 'Select load gravitys', m);

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

    LoadGravity.Select(f, 'Select load gravitys', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the load gravity.

    Arguments

  • flag (Flag)

    Flag to set on the load gravity

    Returns

    No return value

    Example

    To set flag f for load gravity lg: 

    lg.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch load gravity lg: 

    lg.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged load gravitys will be sketched in

  • flag (Flag)

    Flag set on the load gravitys that you want to sketch

  • redraw (optional) (boolean)

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

    LoadGravity.SketchFlagged(m, flag);

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

    Description

    Returns the total number of load gravitys in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of load gravitys

    Return type

    Number

    Example

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

    var total = LoadGravity.Total(m);

    Unblank()

    Description

    Unblanks the load gravity

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank load gravity lg: 

    lg.Unblank();

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

    Description

    Unblanks all of the load gravitys in the model.

    Arguments

  • Model (Model)

    Model that all load gravitys 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 gravitys in model m: 

    LoadGravity.UnblankAll(m);

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

    Description

    Unblanks all of the flagged load gravitys in the model.

    Arguments

  • Model (Model)

    Model that the flagged load gravitys will be unblanked in

  • flag (Flag)

    Flag set on the load gravitys 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 gravitys in model m flagged with f: 

    LoadGravity.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the load gravitys

    Returns

    No return value

    Example

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

    LoadGravity.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the load gravity.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch load gravity lg: 

    lg.Unsketch();

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

    Description

    Unsketches all load gravitys.

    Arguments

  • Model (Model)

    Model that all load gravitys will be unblanked in

  • redraw (optional) (boolean)

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

    LoadGravity.UnsketchAll(m);

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

    Description

    Unsketches all flagged load gravitys in the model.

    Arguments

  • Model (Model)

    Model that all load gravitys will be unsketched in

  • flag (Flag)

    Flag set on the load gravitys that you want to unsketch

  • redraw (optional) (boolean)

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

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

    LoadGravity object.

    Return type

    LoadGravity

    Example

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

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

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

    Description

    Adds a warning for load gravity. 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 gravity lg: 

    lg.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this load gravity.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for load gravity lg: 

    var xrefs = lg.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for LoadGravity lg in keyword format 

    var s = lg.toString();