LoadNode class

The LoadNode class gives you access to define load node 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

LoadNode constants

Name Description
LoadNode.POINT Load is *LOAD_NODE_POINT.
LoadNode.SET LOAD is *LOAD_NODE_SET.
LoadNode.SET_ONCE LOAD is *LOAD_NODE_SET_ONCE.

LoadNode properties

Name Type Description
cid integer Coordinate system ID
dof integer Applicable degrees-of-freedom
exists (read only) logical true if load node exists, false if referred to but not defined.
include integer The Include file number that the load node 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 node is in.
nid integer Node ID or node set ID
sf real Curve scale factor
type constant The Load Node type. Can be LoadNode.POINT or LoadNode.SET. LoadNode.SET_ONCE.

Detailed Description

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

Constructor

new LoadNode(Model[Model], type[constant], nid[integer], dof[integer], lcid[integer], sf (optional)[real], cid (optional)[integer], m1 (optional)[integer], m2 (optional)[integer], m3 (optional)[integer], lcidsf (optional)[integer])

Description

Create a new LoadNode object.

Arguments

  • Model (Model)

    Model that load node will be created in

  • type (constant)

    Specify the type of load node (Can be LoadNode.POINT or LoadNode.SET) LoadNode.SET_ONCE)

  • nid (integer)

    Node ID or node set 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

  • lcidsf (optional) (integer)

    Curve ID

    Returns

    LoadNode object

    Return type

    LoadNode

    Example

    To create a new load node in model m, of type SET, with loadcurve 9 and a scale factor of 0.5 

    var b = new LoadNode(m, LoadNode.SET, 100, 2, 9, 0.5);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a load node.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the load node

    Returns

    No return value

    Example

    To associate comment c to the load node ln: 

    ln.AssociateComment(c);

    Blank()

    Description

    Blanks the load node

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank load node ln: 

    ln.Blank();

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

    Description

    Blanks all of the load nodes in the model.

    Arguments

  • Model (Model)

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

    LoadNode.BlankAll(m);

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

    Description

    Blanks all of the flagged load nodes in the model.

    Arguments

  • Model (Model)

    Model that all the flagged load nodes will be blanked in

  • flag (Flag)

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

    LoadNode.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the load node is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if load node ln is blanked: 

    if (ln.Blanked() ) do_something...

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the load node.

    Arguments

  • flag (Flag)

    Flag to clear on the load node

    Returns

    No return value

    Example

    To clear flag f for load node ln: 

    ln.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    LoadNode object

    Return type

    LoadNode

    Example

    To copy load node ln into load node z: 

    var z = ln.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a load node.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the load node

    Returns

    No return value

    Example

    To detach comment c from the load node ln: 

    ln.DetachComment(c);

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

    Description

    Adds an error for load node. 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 node ln: 

    ln.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first load node in the model.

    Arguments

  • Model (Model)

    Model to get first load node in

    Returns

    LoadNode object (or null if there are no load nodes in the model).

    Return type

    LoadNode

    Example

    To get the first load node in model m: 

    var ln = LoadNode.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all load nodes will be flagged in

  • flag (Flag)

    Flag to set on the load nodes

    Returns

    No return value

    Example

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

    LoadNode.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the load node is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the load node

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if load node ln has flag f set on it: 

    if (ln.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all load nodes are in

  • func (function)

    Function to call for each load node

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

    LoadNode.ForEach(m, test);
function test(ln)
{
// ln is LoadNode object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get load nodes from

  • property (optional) (string)

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

    Returns

    Array of LoadNode objects or properties

    Return type

    Array

    Example

    To make an array of LoadNode objects for all of the load nodes in model m: 

    var a = LoadNode.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a load node.

    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 node ln: 

    var comm_array = ln.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get load nodes from

  • flag (Flag)

    Flag set on the load nodes that you want to retrieve

  • property (optional) (string)

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

    Returns

    Array of LoadNode objects or properties

    Return type

    Array

    Example

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

    var ln = LoadNode.GetFlagged(m, f);

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

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

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

    Description

    Returns the LoadNode object for a load node ID.

    Arguments

  • Model (Model)

    Model to find the load node in

  • number (integer)

    number of the load node you want the LoadNode object for

    Returns

    LoadNode object (or null if load node does not exist).

    Return type

    LoadNode

    Example

    To get the LoadNode object for load node 100 in model m 

    var ln = LoadNode.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    load node property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if LoadNode property ln.example is a parameter: 

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

    To check if LoadNode property ln.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this load node (*LOAD_NODE_xxxx). Note that a carriage return is not added. See also LoadNode.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for load node m: 

    var key = m.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for load node l: 

    var cards = l.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last load node in the model.

    Arguments

  • Model (Model)

    Model to get last load node in

    Returns

    LoadNode object (or null if there are no load nodes in the model).

    Return type

    LoadNode

    Example

    To get the last load node in model m: 

    var ln = LoadNode.Last(m);

    Next()

    Description

    Returns the next load node in the model.

    Arguments

    No arguments

    Returns

    LoadNode object (or null if there are no more load nodes in the model).

    Return type

    LoadNode

    Example

    To get the load node in model m after load node ln: 

    var ln = ln.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 node.

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

    LoadNode object (or null if not picked)

    Return type

    LoadNode

    Example

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

    var ln = LoadNode.Pick('Pick load node from screen', m);

    Previous()

    Description

    Returns the previous load node in the model.

    Arguments

    No arguments

    Returns

    LoadNode object (or null if there are no more load nodes in the model).

    Return type

    LoadNode

    Example

    To get the load node in model m before load node ln: 

    var ln = ln.Previous();

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting load nodes

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

    Return type

    Number

    Example

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

    LoadNode.Select(f, 'Select load nodes', m);

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

    LoadNode.Select(f, 'Select load nodes', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the load node.

    Arguments

  • flag (Flag)

    Flag to set on the load node

    Returns

    No return value

    Example

    To set flag f for load node ln: 

    ln.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch load node ln: 

    ln.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged load nodes will be sketched in

  • flag (Flag)

    Flag set on the load nodes that you want to sketch

  • redraw (optional) (boolean)

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

    LoadNode.SketchFlagged(m, flag);

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

    Description

    Returns the total number of load nodes in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of load nodes

    Return type

    Number

    Example

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

    var total = LoadNode.Total(m);

    Unblank()

    Description

    Unblanks the load node

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank load node ln: 

    ln.Unblank();

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

    Description

    Unblanks all of the load nodes in the model.

    Arguments

  • Model (Model)

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

    LoadNode.UnblankAll(m);

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

    Description

    Unblanks all of the flagged load nodes in the model.

    Arguments

  • Model (Model)

    Model that the flagged load nodes will be unblanked in

  • flag (Flag)

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

    LoadNode.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the load nodes

    Returns

    No return value

    Example

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

    LoadNode.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the load node.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch load node ln: 

    ln.Unsketch();

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

    Description

    Unsketches all load nodes.

    Arguments

  • Model (Model)

    Model that all load nodes will be unblanked in

  • redraw (optional) (boolean)

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

    LoadNode.UnsketchAll(m);

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

    Description

    Unsketches all flagged load nodes in the model.

    Arguments

  • Model (Model)

    Model that all load nodes will be unsketched in

  • flag (Flag)

    Flag set on the load nodes that you want to unsketch

  • redraw (optional) (boolean)

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

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

    LoadNode object.

    Return type

    LoadNode

    Example

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

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

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

    Description

    Adds a warning for load node. 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 node ln: 

    ln.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this load node.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for load node ln: 

    var xrefs = ln.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for load node l in keyword format 

    var s = l.toString();