LoadRemovePart class

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

LoadRemovePart constants

Name Description
LoadRemovePart.PART LOAD is *LOAD_REMOVE_PART.
LoadRemovePart.SET_PART LOAD is *LOAD_REMOVE_PART_SET.

LoadRemovePart properties

Name Type Description
exists (read only) logical true if load remove_part exists, false if referred to but not defined.
include integer The Include file number that the load remove_part is in.
model (read only) integer The Model number that the load remove_part is in.
pid integer Part ID or Part Set ID
stgr integer Construction Stages ID at which part is removed.
time0 real Time at which stress reduction starts.
time1 real Time at which stresses become zero and elements are deleted.
type constant The Load RemovePart type. Can be LoadRemovePart.PART or LoadRemovePart.SET_PART.

Detailed Description

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

Constructor

new LoadRemovePart(Model[Model], type[constant], pid[integer], time0 (optional)[real], time1 (optional)[real], stgr (optional)[integer])

Description

Create a new LoadRemovePart object.

Arguments

  • Model (Model)

    Model that LoadRemovePart will be created in

  • type (constant)

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

  • pid (integer)

    Part ID or Part Set ID

  • time0 (optional) (real)

    Time at which stress reduction starts.

  • time1 (optional) (real)

    Time at which stresses become zero and elements are deleted.

  • stgr (optional) (integer)

    Construction Stage ID at which part is removed.

    Returns

    LoadRemovePart object

    Return type

    LoadRemovePart

    Example

    To create a new load remove_part in model m, of type PART, with pid 100, time0 2.5 and time1 4.5. 

    var l_r_p = new LoadRemovePart(m, LoadRemovePart.PART, 100, 2.5, 4.5);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a load remove_part.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the load remove_part

    Returns

    No return value

    Example

    To associate comment c to the load remove_part l_r_p: 

    l_r_p.AssociateComment(c);

    Blank()

    Description

    Blanks the load remove_part

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank load remove_part l_r_p: 

    l_r_p.Blank();

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

    Description

    Blanks all of the load remove_parts in the model.

    Arguments

  • Model (Model)

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

    LoadRemovePart.BlankAll(m);

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

    Description

    Blanks all of the flagged load remove_parts in the model.

    Arguments

  • Model (Model)

    Model that all the flagged load remove_parts will be blanked in

  • flag (Flag)

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

    LoadRemovePart.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the load remove_part is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if load remove_part l_r_p is blanked: 

    if (l_r_p.Blanked() ) do_something...

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the load remove_part.

    Arguments

  • flag (Flag)

    Flag to clear on the load remove_part

    Returns

    No return value

    Example

    To clear flag f for load remove_part l_r_p: 

    l_r_p.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    LoadRemovePart object

    Return type

    LoadRemovePart

    Example

    To copy load remove_part l_r_p into load remove_part z: 

    var z = l_r_p.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a load remove_part.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the load remove_part

    Returns

    No return value

    Example

    To detach comment c from the load remove_part l_r_p: 

    l_r_p.DetachComment(c);

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

    Description

    Adds an error for load remove_part. 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 remove_part l_r_p: 

    l_r_p.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first load remove_part in the model.

    Arguments

  • Model (Model)

    Model to get first load remove_part in

    Returns

    LoadRemovePart object (or null if there are no load remove_parts in the model).

    Return type

    LoadRemovePart

    Example

    To get the first load remove_part in model m: 

    var l_r_p = LoadRemovePart.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all load remove_parts will be flagged in

  • flag (Flag)

    Flag to set on the load remove_parts

    Returns

    No return value

    Example

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

    LoadRemovePart.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the load remove_part is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the load remove_part

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if load remove_part l_r_p has flag f set on it: 

    if (l_r_p.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all load remove_parts are in

  • func (function)

    Function to call for each load remove_part

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

    LoadRemovePart.ForEach(m, test);
function test(l_r_p)
{
// l_r_p is LoadRemovePart object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get load remove_parts from

  • property (optional) (string)

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

    Returns

    Array of LoadRemovePart objects or properties

    Return type

    Array

    Example

    To make an array of LoadRemovePart objects for all of the load remove_parts in model m: 

    var a = LoadRemovePart.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a load remove_part.

    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 remove_part l_r_p: 

    var comm_array = l_r_p.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get load remove_parts from

  • flag (Flag)

    Flag set on the load remove_parts that you want to retrieve

  • property (optional) (string)

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

    Returns

    Array of LoadRemovePart objects or properties

    Return type

    Array

    Example

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

    var l_r_p = LoadRemovePart.GetFlagged(m, f);

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

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

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

    Description

    Returns the LoadRemovePart object for a load remove_part ID.

    Arguments

  • Model (Model)

    Model to find the load remove_part in

  • number (integer)

    number of the load remove_part you want the LoadRemovePart object for

    Returns

    LoadRemovePart object (or null if load remove_part does not exist).

    Return type

    LoadRemovePart

    Example

    To get the LoadRemovePart object for load remove_part 100 in model m 

    var l_r_p = LoadRemovePart.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    load remove_part property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if LoadRemovePart property l_r_p.example is a parameter: 

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

    To check if LoadRemovePart property l_r_p.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for LoadRemovePart l_r_p: 

    var key = l_r_p.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for LoadRemovePart l_r_p: 

    var cards = l_r_p.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last load remove_part in the model.

    Arguments

  • Model (Model)

    Model to get last load remove_part in

    Returns

    LoadRemovePart object (or null if there are no load remove_parts in the model).

    Return type

    LoadRemovePart

    Example

    To get the last load remove_part in model m: 

    var l_r_p = LoadRemovePart.Last(m);

    Next()

    Description

    Returns the next load remove_part in the model.

    Arguments

    No arguments

    Returns

    LoadRemovePart object (or null if there are no more load remove_parts in the model).

    Return type

    LoadRemovePart

    Example

    To get the load remove_part in model m after load remove_part l_r_p: 

    var l_r_p = l_r_p.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 remove_part.

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

    LoadRemovePart object (or null if not picked)

    Return type

    LoadRemovePart

    Example

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

    var l_r_p = LoadRemovePart.Pick('Pick load remove_part from screen', m);

    Previous()

    Description

    Returns the previous load remove_part in the model.

    Arguments

    No arguments

    Returns

    LoadRemovePart object (or null if there are no more load remove_parts in the model).

    Return type

    LoadRemovePart

    Example

    To get the load remove_part in model m before load remove_part l_r_p: 

    var l_r_p = l_r_p.Previous();

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting load remove_parts

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

    Return type

    Number

    Example

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

    LoadRemovePart.Select(f, 'Select load remove_parts', m);

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

    LoadRemovePart.Select(f, 'Select load remove_parts', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the load remove_part.

    Arguments

  • flag (Flag)

    Flag to set on the load remove_part

    Returns

    No return value

    Example

    To set flag f for load remove_part l_r_p: 

    l_r_p.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch load remove_part l_r_p: 

    l_r_p.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged load remove_parts will be sketched in

  • flag (Flag)

    Flag set on the load remove_parts that you want to sketch

  • redraw (optional) (boolean)

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

    LoadRemovePart.SketchFlagged(m, flag);

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

    Description

    Returns the total number of load remove_parts in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of load remove_parts

    Return type

    Number

    Example

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

    var total = LoadRemovePart.Total(m);

    Unblank()

    Description

    Unblanks the load remove_part

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank load remove_part l_r_p: 

    l_r_p.Unblank();

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

    Description

    Unblanks all of the load remove_parts in the model.

    Arguments

  • Model (Model)

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

    LoadRemovePart.UnblankAll(m);

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

    Description

    Unblanks all of the flagged load remove_parts in the model.

    Arguments

  • Model (Model)

    Model that the flagged load remove_parts will be unblanked in

  • flag (Flag)

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

    LoadRemovePart.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the load remove_parts

    Returns

    No return value

    Example

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

    LoadRemovePart.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the load remove_part.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch load remove_part l_r_p: 

    l_r_p.Unsketch();

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

    Description

    Unsketches all load remove_parts.

    Arguments

  • Model (Model)

    Model that all load remove_parts will be unblanked in

  • redraw (optional) (boolean)

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

    LoadRemovePart.UnsketchAll(m);

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

    Description

    Unsketches all flagged load remove_parts in the model.

    Arguments

  • Model (Model)

    Model that all load remove_parts will be unsketched in

  • flag (Flag)

    Flag set on the load remove_parts that you want to unsketch

  • redraw (optional) (boolean)

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

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

    LoadRemovePart object.

    Return type

    LoadRemovePart

    Example

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

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

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

    Description

    Adds a warning for load remove_part. 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 remove_part l_r_p: 

    l_r_p.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this load remove_part.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for load remove_part l_r_p: 

    var xrefs = l_r_p.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for LoadRemovePart l_r_p in keyword format 

    var s = l_r_p.toString();