NodalForceGroup (Nfgr) class

The NodalForceGroup class gives you access to database nodal force group 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

NodalForceGroup properties

Name Type Description
cid integer Coordinate System ID.
exists (read only) logical true if nodal force group exists, false if referred to but not defined.
id integer Database Nodal Force Group number (identical to label).
include integer The Include file number that the nodal force group is in.
label integer Database Nodal Force Group number.
model (read only) integer The Model number that the nodal force group is in.
nsid integer Set Node Set ID.

Detailed Description

The NodalForceGroup class allows you to create, modify, edit and manipulate nodal force group cards. See the documentation below for more details.

For convenience "Nfgr" can also be used as the class name instead of "NodalForceGroup".

Constructor

new NodalForceGroup(Model[Model], nsid[integer], cid (optional)[integer])

Description

Create a new NodalForceGroup object.

Arguments

  • Model (Model)

    Model that nodal force group will be created in

  • nsid (integer)

    Set Node Set ID.

  • cid (optional) (integer)

    Coordinate System ID.

    Returns

    NodalForceGroup object

    Return type

    NodalForceGroup

    Example

    To create a new nodal force group in model m with nsid 100: 

    var nfg = new NodalForceGroup(m, 100);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a nodal force group.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the nodal force group

    Returns

    No return value

    Example

    To associate comment c to the nodal force group nfg: 

    nfg.AssociateComment(c);

    Blank()

    Description

    Blanks the nodal force group

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank nodal force group nfg: 

    nfg.Blank();

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

    Description

    Blanks all of the nodal force groups in the model.

    Arguments

  • Model (Model)

    Model that all nodal force groups 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 nodal force groups in model m: 

    NodalForceGroup.BlankAll(m);

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

    Description

    Blanks all of the flagged nodal force groups in the model.

    Arguments

  • Model (Model)

    Model that all the flagged nodal force groups will be blanked in

  • flag (Flag)

    Flag set on the nodal force groups 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 nodal force groups in model m flagged with f: 

    NodalForceGroup.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the nodal force group is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if nodal force group nfg is blanked: 

    if (nfg.Blanked() ) do_something...

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the nodal force group.

    Arguments

  • flag (Flag)

    Flag to clear on the nodal force group

    Returns

    No return value

    Example

    To clear flag f for nodal force group nfg: 

    nfg.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

    Copies the nodal force group. The target include of the copied nodal force group 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

    NodalForceGroup object

    Return type

    NodalForceGroup

    Example

    To copy nodal force group nfg into nodal force group z: 

    var z = nfg.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a nodal force group.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the nodal force group

    Returns

    No return value

    Example

    To detach comment c from the nodal force group nfg: 

    nfg.DetachComment(c);

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

    Description

    Adds an error for nodal force group. 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 nodal force group nfg: 

    nfg.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first nodal force group in the model.

    Arguments

  • Model (Model)

    Model to get first nodal force group in

    Returns

    NodalForceGroup object (or null if there are no nodal force groups in the model).

    Return type

    NodalForceGroup

    Example

    To get the first nodal force group in model m: 

    var nfg = NodalForceGroup.First(m);

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

    Description

    Flags all of the nodal force groups in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all nodal force groups will be flagged in

  • flag (Flag)

    Flag to set on the nodal force groups

    Returns

    No return value

    Example

    To flag all of the nodal force groups with flag f in model m: 

    NodalForceGroup.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the nodal force group is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the nodal force group

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if nodal force group nfg has flag f set on it: 

    if (nfg.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all nodal force groups are in

  • func (function)

    Function to call for each nodal force group

  • 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 nodal force groups in model m: 

    NodalForceGroup.ForEach(m, test);
function test(nfg)
{
// nfg is NodalForceGroup object
}

    To call function test for all of the nodal force groups in model m with optional object: 

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

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

    Description

    Returns an array of NodalForceGroup objects or properties for all of the nodal force groups in a model in PRIMER. If the optional property argument is not given then an array of NodalForceGroup objects is returned. If the property argument is given, that property value for each nodal force group is returned in the array instead of a NodalForceGroup object

    Arguments

  • Model (Model)

    Model to get nodal force groups from

  • property (optional) (string)

    Name for property to get for all nodal force groups in the model

    Returns

    Array of NodalForceGroup objects or properties

    Return type

    Array

    Example

    To make an array of NodalForceGroup objects for all of the nodal force groups in model m: 

    var a = NodalForceGroup.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a nodal force group.

    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 nodal force group nfg: 

    var comm_array = nfg.GetComments();

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

    Description

    Returns an array of NodalForceGroup objects for all of the flagged nodal force groups in a model in PRIMER If the optional property argument is not given then an array of NodalForceGroup objects is returned. If the property argument is given, then that property value for each nodal force group is returned in the array instead of a NodalForceGroup object

    Arguments

  • Model (Model)

    Model to get nodal force groups from

  • flag (Flag)

    Flag set on the nodal force groups that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged nodal force groups in the model

    Returns

    Array of NodalForceGroup objects or properties

    Return type

    Array

    Example

    To make an array of NodalForceGroup objects for all of the nodal force groups in model m flagged with f: 

    var nfg = NodalForceGroup.GetFlagged(m, f);

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

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

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

    Description

    Returns the NodalForceGroup object for a nodal force group ID.

    Arguments

  • Model (Model)

    Model to find the nodal force group in

  • number (integer)

    number of the nodal force group you want the NodalForceGroup object for

    Returns

    NodalForceGroup object (or null if nodal force group does not exist).

    Return type

    NodalForceGroup

    Example

    To get the NodalForceGroup object for nodal force group 100 in model m 

    var nfg = NodalForceGroup.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    nodal force group property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if NodalForceGroup property nfg.example is a parameter: 

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

    To check if NodalForceGroup property nfg.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this nodal force group. Note that a carriage return is not added. See also NodalForceGroup.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for nodal force group nfg: 

    var key = nfg.Keyword();

    KeywordCards()

    Description

    Returns the keyword cards for the nodal force group. Note that a carriage return is not added. See also NodalForceGroup.Keyword()

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for nodal force group nfg: 

    var cards = nfg.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last nodal force group in the model.

    Arguments

  • Model (Model)

    Model to get last nodal force group in

    Returns

    NodalForceGroup object (or null if there are no nodal force groups in the model).

    Return type

    NodalForceGroup

    Example

    To get the last nodal force group in model m: 

    var nfg = NodalForceGroup.Last(m);

    Next()

    Description

    Returns the next nodal force group in the model.

    Arguments

    No arguments

    Returns

    NodalForceGroup object (or null if there are no more nodal force groups in the model).

    Return type

    NodalForceGroup

    Example

    To get the nodal force group in model m after nodal force group nfg: 

    var nfg = nfg.Next();

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

    Description

    Allows the user to pick a nodal force group.

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

    NodalForceGroup object (or null if not picked)

    Return type

    NodalForceGroup

    Example

    To pick a nodal force group from model m giving the prompt 'Pick nodal force group from screen': 

    var nfg = NodalForceGroup.Pick('Pick nodal force group from screen', m);

    Previous()

    Description

    Returns the previous nodal force group in the model.

    Arguments

    No arguments

    Returns

    NodalForceGroup object (or null if there are no more nodal force groups in the model).

    Return type

    NodalForceGroup

    Example

    To get the nodal force group in model m before nodal force group nfg: 

    var nfg = nfg.Previous();

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

    Description

    Allows the user to select nodal force groups using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting nodal force groups

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

    To select nodal force groups from model m, flagging those selected with flag f, giving the prompt 'Select nodal force groups': 

    NodalForceGroup.Select(f, 'Select nodal force groups', m);

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

    NodalForceGroup.Select(f, 'Select nodal force groups', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the nodal force group.

    Arguments

  • flag (Flag)

    Flag to set on the nodal force group

    Returns

    No return value

    Example

    To set flag f for nodal force group nfg: 

    nfg.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the nodal force group. The nodal force group will be sketched until you either call NodalForceGroup.Unsketch(), NodalForceGroup.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch nodal force group nfg: 

    nfg.Sketch();

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

    Description

    Sketches all of the flagged nodal force groups in the model. The nodal force groups will be sketched until you either call NodalForceGroup.Unsketch(), NodalForceGroup.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

    Arguments

  • Model (Model)

    Model that all the flagged nodal force groups will be sketched in

  • flag (Flag)

    Flag set on the nodal force groups that you want to sketch

  • redraw (optional) (boolean)

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

    NodalForceGroup.SketchFlagged(m, flag);

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

    Description

    Returns the total number of nodal force groups in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of nodal force groups

    Return type

    Number

    Example

    To get the total number of nodal force groups in model m: 

    var total = NodalForceGroup.Total(m);

    Unblank()

    Description

    Unblanks the nodal force group

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank nodal force group nfg: 

    nfg.Unblank();

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

    Description

    Unblanks all of the nodal force groups in the model.

    Arguments

  • Model (Model)

    Model that all nodal force groups 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 nodal force groups in model m: 

    NodalForceGroup.UnblankAll(m);

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

    Description

    Unblanks all of the flagged nodal force groups in the model.

    Arguments

  • Model (Model)

    Model that the flagged nodal force groups will be unblanked in

  • flag (Flag)

    Flag set on the nodal force groups 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 nodal force groups in model m flagged with f: 

    NodalForceGroup.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the nodal force groups in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all nodal force groups will be unset in

  • flag (Flag)

    Flag to unset on the nodal force groups

    Returns

    No return value

    Example

    To unset the flag f on all the nodal force groups in model m: 

    NodalForceGroup.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the nodal force group.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch nodal force group nfg: 

    nfg.Unsketch();

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

    Description

    Unsketches all nodal force groups.

    Arguments

  • Model (Model)

    Model that all nodal force groups will be unblanked in

  • redraw (optional) (boolean)

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

    NodalForceGroup.UnsketchAll(m);

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

    Description

    Unsketches all flagged nodal force groups in the model.

    Arguments

  • Model (Model)

    Model that all nodal force groups will be unsketched in

  • flag (Flag)

    Flag set on the nodal force groups that you want to unsketch

  • redraw (optional) (boolean)

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

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

    NodalForceGroup object.

    Return type

    NodalForceGroup

    Example

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

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

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

    Description

    Adds a warning for nodal force group. 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 nodal force group nfg: 

    nfg.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this nodal force group.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for nodal force group nfg: 

    var xrefs = nfg.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for nodal force group n in keyword format 

    var s = n.toString();