LoadBodyGeneralized class

The LoadBodyGeneralized class gives you access to define load body generalized 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

LoadBodyGeneralized constants

Name Description
LoadBodyGeneralized.NODE Load is *LOAD_BODY_GENERALIZED.
LoadBodyGeneralized.SET_NODE Load is *LOAD_BODY_GENERALIZED_SET_NODE.
LoadBodyGeneralized.SET_PART LOAD is *LOAD_BODY_GENERALIZED_SET_PART.

LoadBodyGeneralized properties

Name Type Description
angtyp string Type of body loads
ax real Scale factor for acceleration in x-direction
ay real Scale factor for acceleration in y-direction
az real Scale factor for acceleration in z-direction
cid integer Coordinate system ID to define acceleration
drlcid real Curve ID for dynamic relaxation phase
exists (read only) logical true if load body generalized exists, false if referred to but not defined.
include integer The Include file number that the load body generalized is in.
lcid integer Curve ID
model (read only) integer The Model number that the load body generalized is in.
n1 integer Beginning Node ID for body force load or the node or Part set ID
n2 integer Ending Node ID for body force load. Set to zero if a set ID is defined
omx real Scale factor for x-angular velocity or acceleration
omy real Scale factor for y-angular velocity or acceleration
omz real Scale factor for z-angular velocity or acceleration
type constant The Load Node type, can be LoadBodyGeneralized.NODE or LoadBodyGeneralized.SET_NODE or LoadBodyGeneralized.SET_PART.
xc real X-center of rotation
yc real Y-center of rotation
zc real Z-center of rotation

Detailed Description

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

Constructor

new LoadBodyGeneralized(Model[Model], type[constant], n1[integer], n2[integer], lcid[integer], drlcid (optional)[integer], xc (optional)[real], yc (optional)[real], zc (optional)[real], ax (optional)[real], ay (optional)[real], az (optional)[real], omx (optional)[real], omy (optional)[real], omz (optional)[real], cid (optional)[integer], angtyp (optional)[string])

Description

Create a new LoadBodyGeneralized object.

Arguments

  • Model (Model)

    Model that load body generalized will be created in

  • type (constant)

    Specify the type of load body generalized (Can be LoadBodyGeneralized.NODE or LoadBodyGeneralized.SET_NODE or LoadBodyGeneralized.SET_PART)

  • n1 (integer)

    Beginning Node ID for body force load or the node or Part set ID

  • n2 (integer)

    Ending Node ID for body force load. Set to zero if a set ID is defined

  • lcid (integer)

    Curve ID

  • drlcid (optional) (integer)

    Curve ID for dynamic relaxation phase

  • xc (optional) (real)

    X-center of rotation

  • yc (optional) (real)

    Y-center of rotation

  • zc (optional) (real)

    Z-center of rotation

  • ax (optional) (real)

    Scale factor for acceleration in x-direction

  • ay (optional) (real)

    Scale factor for acceleration in y-direction

  • az (optional) (real)

    Scale factor for acceleration in z-direction

  • omx (optional) (real)

    Scale factor for x-angular velocity or acceleration

  • omy (optional) (real)

    Scale factor for y-angular velocity or acceleration

  • omz (optional) (real)

    Scale factor for z-angular velocity or acceleration

  • cid (optional) (integer)

    Coordinate system ID to define acceleration

  • angtyp (optional) (string)

    Type of body loads

    Returns

    LoadBodyGeneralized object

    Return type

    LoadBodyGeneralized

    Example

    To create a new load body generalized in model m, of type SET_NODE, with LCID 9 and N2 is 2 

    var b = new LoadBodyGeneralized(m, LoadBodyGeneralized.SET_NODE, 100, 2, 9);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a load body generalized.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the load body generalized

    Returns

    No return value

    Example

    To associate comment c to the load body generalized lbg: 

    lbg.AssociateComment(c);

    Blank()

    Description

    Blanks the load body generalized

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank load body generalized lbg: 

    lbg.Blank();

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

    Description

    Blanks all of the load body generalizeds in the model.

    Arguments

  • Model (Model)

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

    LoadBodyGeneralized.BlankAll(m);

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

    Description

    Blanks all of the flagged load body generalizeds in the model.

    Arguments

  • Model (Model)

    Model that all the flagged load body generalizeds will be blanked in

  • flag (Flag)

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

    LoadBodyGeneralized.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the load body generalized is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if load body generalized lbg is blanked: 

    if (lbg.Blanked() ) do_something...

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the load body generalized.

    Arguments

  • flag (Flag)

    Flag to clear on the load body generalized

    Returns

    No return value

    Example

    To clear flag f for load body generalized lbg: 

    lbg.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    LoadBodyGeneralized object

    Return type

    LoadBodyGeneralized

    Example

    To copy load body generalized lbg into load body generalized z: 

    var z = lbg.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a load body generalized.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the load body generalized

    Returns

    No return value

    Example

    To detach comment c from the load body generalized lbg: 

    lbg.DetachComment(c);

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

    Description

    Adds an error for load body generalized. 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 body generalized lbg: 

    lbg.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first load body generalized in the model.

    Arguments

  • Model (Model)

    Model to get first load body generalized in

    Returns

    LoadBodyGeneralized object (or null if there are no load body generalizeds in the model).

    Return type

    LoadBodyGeneralized

    Example

    To get the first load body generalized in model m: 

    var lbg = LoadBodyGeneralized.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all load body generalizeds will be flagged in

  • flag (Flag)

    Flag to set on the load body generalizeds

    Returns

    No return value

    Example

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

    LoadBodyGeneralized.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the load body generalized is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the load body generalized

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if load body generalized lbg has flag f set on it: 

    if (lbg.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all load body generalizeds are in

  • func (function)

    Function to call for each load body generalized

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

    LoadBodyGeneralized.ForEach(m, test);
function test(lbg)
{
// lbg is LoadBodyGeneralized object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get load body generalizeds from

  • property (optional) (string)

    Name for property to get for all load body generalizeds in the model

    Returns

    Array of LoadBodyGeneralized objects or properties

    Return type

    Array

    Example

    To make an array of LoadBodyGeneralized objects for all of the load body generalizeds in model m: 

    var a = LoadBodyGeneralized.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a load body generalized.

    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 body generalized lbg: 

    var comm_array = lbg.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get load body generalizeds from

  • flag (Flag)

    Flag set on the load body generalizeds that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged load body generalizeds in the model

    Returns

    Array of LoadBodyGeneralized objects or properties

    Return type

    Array

    Example

    To make an array of LoadBodyGeneralized objects for all of the load body generalizeds in model m flagged with f: 

    var lbg = LoadBodyGeneralized.GetFlagged(m, f);

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

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

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

    Description

    Returns the LoadBodyGeneralized object for a load body generalized ID.

    Arguments

  • Model (Model)

    Model to find the load body generalized in

  • number (integer)

    number of the load body generalized you want the LoadBodyGeneralized object for

    Returns

    LoadBodyGeneralized object (or null if load body generalized does not exist).

    Return type

    LoadBodyGeneralized

    Example

    To get the LoadBodyGeneralized object for load body generalized 100 in model m 

    var lbg = LoadBodyGeneralized.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    load body generalized property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if LoadBodyGeneralized property lbg.example is a parameter: 

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

    To check if LoadBodyGeneralized property lbg.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for load body generalized m: 

    var key = m.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for load body generalized l: 

    var cards = l.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last load body generalized in the model.

    Arguments

  • Model (Model)

    Model to get last load body generalized in

    Returns

    LoadBodyGeneralized object (or null if there are no load body generalizeds in the model).

    Return type

    LoadBodyGeneralized

    Example

    To get the last load body generalized in model m: 

    var lbg = LoadBodyGeneralized.Last(m);

    Next()

    Description

    Returns the next load body generalized in the model.

    Arguments

    No arguments

    Returns

    LoadBodyGeneralized object (or null if there are no more load body generalizeds in the model).

    Return type

    LoadBodyGeneralized

    Example

    To get the load body generalized in model m after load body generalized lbg: 

    var lbg = lbg.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 body generalized.

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

    LoadBodyGeneralized object (or null if not picked)

    Return type

    LoadBodyGeneralized

    Example

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

    var lbg = LoadBodyGeneralized.Pick('Pick load body generalized from screen', m);

    Previous()

    Description

    Returns the previous load body generalized in the model.

    Arguments

    No arguments

    Returns

    LoadBodyGeneralized object (or null if there are no more load body generalizeds in the model).

    Return type

    LoadBodyGeneralized

    Example

    To get the load body generalized in model m before load body generalized lbg: 

    var lbg = lbg.Previous();

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting load body generalizeds

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

    Return type

    Number

    Example

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

    LoadBodyGeneralized.Select(f, 'Select load body generalizeds', m);

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

    LoadBodyGeneralized.Select(f, 'Select load body generalizeds', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the load body generalized.

    Arguments

  • flag (Flag)

    Flag to set on the load body generalized

    Returns

    No return value

    Example

    To set flag f for load body generalized lbg: 

    lbg.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch load body generalized lbg: 

    lbg.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged load body generalizeds will be sketched in

  • flag (Flag)

    Flag set on the load body generalizeds that you want to sketch

  • redraw (optional) (boolean)

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

    LoadBodyGeneralized.SketchFlagged(m, flag);

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

    Description

    Returns the total number of load body generalizeds in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of load body generalizeds

    Return type

    Number

    Example

    To get the total number of load body generalizeds in model m: 

    var total = LoadBodyGeneralized.Total(m);

    Unblank()

    Description

    Unblanks the load body generalized

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank load body generalized lbg: 

    lbg.Unblank();

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

    Description

    Unblanks all of the load body generalizeds in the model.

    Arguments

  • Model (Model)

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

    LoadBodyGeneralized.UnblankAll(m);

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

    Description

    Unblanks all of the flagged load body generalizeds in the model.

    Arguments

  • Model (Model)

    Model that the flagged load body generalizeds will be unblanked in

  • flag (Flag)

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

    LoadBodyGeneralized.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the load body generalizeds

    Returns

    No return value

    Example

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

    LoadBodyGeneralized.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the load body generalized.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch load body generalized lbg: 

    lbg.Unsketch();

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

    Description

    Unsketches all load body generalizeds.

    Arguments

  • Model (Model)

    Model that all load body generalizeds will be unblanked in

  • redraw (optional) (boolean)

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

    LoadBodyGeneralized.UnsketchAll(m);

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

    Description

    Unsketches all flagged load body generalizeds in the model.

    Arguments

  • Model (Model)

    Model that all load body generalizeds will be unsketched in

  • flag (Flag)

    Flag set on the load body generalizeds that you want to unsketch

  • redraw (optional) (boolean)

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

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

    LoadBodyGeneralized object.

    Return type

    LoadBodyGeneralized

    Example

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

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

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

    Description

    Adds a warning for load body generalized. 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 body generalized lbg: 

    lbg.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this load body generalized.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for load body generalized lbg: 

    var xrefs = lbg.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for load body generalized l in keyword format 

    var s = l.toString();