DampingPartMass class

The DampingPartMass class gives you access to define damping part mass 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

DampingPartMass constants

Name Description
DampingPartMass.PART PART is *DAMPING_PART_MASS.
DampingPartMass.SET SET is *DAMPING_PART_MASS_SET.

DampingPartMass properties

Name Type Description
exists (read only) logical true if damping part mass exists, false if referred to but not defined.
flag integer Flag for scale factors
id integer Part/part set id
include integer The Include file number that the damping part mass is in.
lcid integer LC: Damping vs time
model (read only) integer The Model number that the damping part mass is in.
sf real Scale factor on loadcurve
srx real Rotational x scale factor
sry real Rotational y scale factor
srz real Rotational z scale factor
stx real Translational x scale factor
sty real Translational y scale factor
stz real Translational z scale factor
type constant The DampingPartMass type. Can be:

Detailed Description

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

Constructor

new DampingPartMass(Model[Model], type[constant], id[integer], lcid[integer], sf (optional)[real], flag (optional)[integer], stx (optional)[real], sty (optional)[real], stz (optional)[real], srx (optional)[real], sry (optional)[real], srz (optional)[real])

Description

Create a new DampingPartMass object for *DAMPING_PART_MASS.

Arguments

  • Model (Model)

    Model that damping part mass will be created in

  • type (constant)

    Damping part mass type. Can be DampingPartMass.PART or DampingPartMass.SET.

  • id (integer)

    Part/part set id

  • lcid (integer)

    LC: Damping vs time

  • sf (optional) (real)

    Scale factor on loadcurve

  • flag (optional) (integer)

    Flag for scale factors

  • stx (optional) (real)

    Translational x scale factor

  • sty (optional) (real)

    Translational y scale factor

  • stz (optional) (real)

    Translational z scale factor

  • srx (optional) (real)

    Rotational x scale factor

  • sry (optional) (real)

    Rotational y scale factor

  • srz (optional) (real)

    Rotational z scale factor

    Returns

    DampingPartMass object

    Return type

    DampingPartMass

    Example

    To create a new damping part mass (of type PART) in model m with id, lcid, sf, flag set to 11, 12, 3.5, 1 respectively: 

    var pm = new DampingPartMass(m, DampingPartMass.PART, 11, 12, 3.5, 1);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a damping part mass.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the damping part mass

    Returns

    No return value

    Example

    To associate comment c to the damping part mass pm: 

    pm.AssociateComment(c);

    Blank()

    Description

    Blanks the damping part mass

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank damping part mass pm: 

    pm.Blank();

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

    Description

    Blanks all of the damping part masss in the model.

    Arguments

  • Model (Model)

    Model that all damping part masss 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 damping part masss in model m: 

    DampingPartMass.BlankAll(m);

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

    Description

    Blanks all of the flagged damping part masss in the model.

    Arguments

  • Model (Model)

    Model that all the flagged damping part masss will be blanked in

  • flag (Flag)

    Flag set on the damping part masss 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 damping part masss in model m flagged with f: 

    DampingPartMass.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the damping part mass is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if damping part mass pm is blanked: 

    if (pm.Blanked() ) do_something...

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the damping part mass.

    Arguments

  • flag (Flag)

    Flag to clear on the damping part mass

    Returns

    No return value

    Example

    To clear flag f for damping part mass pm: 

    pm.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

    Copies the damping part mass. The target include of the copied damping part mass 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

    DampingPartMass object

    Return type

    DampingPartMass

    Example

    To copy damping part mass pm into damping part mass z: 

    var z = pm.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a damping part mass.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the damping part mass

    Returns

    No return value

    Example

    To detach comment c from the damping part mass pm: 

    pm.DetachComment(c);

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

    Description

    Adds an error for damping part mass. 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 damping part mass pm: 

    pm.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first damping part mass in the model.

    Arguments

  • Model (Model)

    Model to get first damping part mass in

    Returns

    DampingPartMass object (or null if there are no damping part masss in the model).

    Return type

    DampingPartMass

    Example

    To get the first damping part mass in model m: 

    var pm = DampingPartMass.First(m);

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

    Description

    Flags all of the damping part masss in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all damping part masss will be flagged in

  • flag (Flag)

    Flag to set on the damping part masss

    Returns

    No return value

    Example

    To flag all of the damping part masss with flag f in model m: 

    DampingPartMass.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the damping part mass is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the damping part mass

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if damping part mass pm has flag f set on it: 

    if (pm.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all damping part masss are in

  • func (function)

    Function to call for each damping part mass

  • 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 damping part masss in model m: 

    DampingPartMass.ForEach(m, test);
function test(pm)
{
// pm is DampingPartMass object
}

    To call function test for all of the damping part masss in model m with optional object: 

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

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

    Description

    Returns an array of DampingPartMass objects or properties for all of the damping part masss in a model in PRIMER. If the optional property argument is not given then an array of DampingPartMass objects is returned. If the property argument is given, that property value for each damping part mass is returned in the array instead of a DampingPartMass object

    Arguments

  • Model (Model)

    Model to get damping part masss from

  • property (optional) (string)

    Name for property to get for all damping part masss in the model

    Returns

    Array of DampingPartMass objects or properties

    Return type

    Array

    Example

    To make an array of DampingPartMass objects for all of the damping part masss in model m: 

    var a = DampingPartMass.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a damping part mass.

    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 damping part mass pm: 

    var comm_array = pm.GetComments();

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

    Description

    Returns an array of DampingPartMass objects for all of the flagged damping part masss in a model in PRIMER If the optional property argument is not given then an array of DampingPartMass objects is returned. If the property argument is given, then that property value for each damping part mass is returned in the array instead of a DampingPartMass object

    Arguments

  • Model (Model)

    Model to get damping part masss from

  • flag (Flag)

    Flag set on the damping part masss that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged damping part masss in the model

    Returns

    Array of DampingPartMass objects or properties

    Return type

    Array

    Example

    To make an array of DampingPartMass objects for all of the damping part masss in model m flagged with f: 

    var pm = DampingPartMass.GetFlagged(m, f);

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

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

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

    Description

    Returns the DampingPartMass object for a damping part mass ID.

    Arguments

  • Model (Model)

    Model to find the damping part mass in

  • number (integer)

    number of the damping part mass you want the DampingPartMass object for

    Returns

    DampingPartMass object (or null if damping part mass does not exist).

    Return type

    DampingPartMass

    Example

    To get the DampingPartMass object for damping part mass 100 in model m 

    var pm = DampingPartMass.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    damping part mass property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if DampingPartMass property pm.example is a parameter: 

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

    To check if DampingPartMass property pm.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this damping part mass (*DAMPING_PART_MASS). Note that a carriage return is not added. See also DampingPartMass.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for damping part mass m: 

    var key = fr.Keyword();

    KeywordCards()

    Description

    Returns the keyword cards for the damping part mass. Note that a carriage return is not added. See also DampingPartMass.Keyword()

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for damping part mass fr: 

    var cards = fr.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last damping part mass in the model.

    Arguments

  • Model (Model)

    Model to get last damping part mass in

    Returns

    DampingPartMass object (or null if there are no damping part masss in the model).

    Return type

    DampingPartMass

    Example

    To get the last damping part mass in model m: 

    var pm = DampingPartMass.Last(m);

    Next()

    Description

    Returns the next damping part mass in the model.

    Arguments

    No arguments

    Returns

    DampingPartMass object (or null if there are no more damping part masss in the model).

    Return type

    DampingPartMass

    Example

    To get the damping part mass in model m after damping part mass pm: 

    var pm = pm.Next();

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

    Description

    Allows the user to pick a damping part mass.

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

    DampingPartMass object (or null if not picked)

    Return type

    DampingPartMass

    Example

    To pick a damping part mass from model m giving the prompt 'Pick damping part mass from screen': 

    var pm = DampingPartMass.Pick('Pick damping part mass from screen', m);

    Previous()

    Description

    Returns the previous damping part mass in the model.

    Arguments

    No arguments

    Returns

    DampingPartMass object (or null if there are no more damping part masss in the model).

    Return type

    DampingPartMass

    Example

    To get the damping part mass in model m before damping part mass pm: 

    var pm = pm.Previous();

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

    Description

    Allows the user to select damping part masss using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting damping part masss

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

    To select damping part masss from model m, flagging those selected with flag f, giving the prompt 'Select damping part masss': 

    DampingPartMass.Select(f, 'Select damping part masss', m);

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

    DampingPartMass.Select(f, 'Select damping part masss', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the damping part mass.

    Arguments

  • flag (Flag)

    Flag to set on the damping part mass

    Returns

    No return value

    Example

    To set flag f for damping part mass pm: 

    pm.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the damping part mass. The damping part mass will be sketched until you either call DampingPartMass.Unsketch(), DampingPartMass.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch damping part mass pm: 

    pm.Sketch();

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

    Description

    Sketches all of the flagged damping part masss in the model. The damping part masss will be sketched until you either call DampingPartMass.Unsketch(), DampingPartMass.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

    Arguments

  • Model (Model)

    Model that all the flagged damping part masss will be sketched in

  • flag (Flag)

    Flag set on the damping part masss that you want to sketch

  • redraw (optional) (boolean)

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

    DampingPartMass.SketchFlagged(m, flag);

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

    Description

    Returns the total number of damping part masss in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of damping part masss

    Return type

    Number

    Example

    To get the total number of damping part masss in model m: 

    var total = DampingPartMass.Total(m);

    Unblank()

    Description

    Unblanks the damping part mass

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank damping part mass pm: 

    pm.Unblank();

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

    Description

    Unblanks all of the damping part masss in the model.

    Arguments

  • Model (Model)

    Model that all damping part masss 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 damping part masss in model m: 

    DampingPartMass.UnblankAll(m);

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

    Description

    Unblanks all of the flagged damping part masss in the model.

    Arguments

  • Model (Model)

    Model that the flagged damping part masss will be unblanked in

  • flag (Flag)

    Flag set on the damping part masss 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 damping part masss in model m flagged with f: 

    DampingPartMass.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the damping part masss in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all damping part masss will be unset in

  • flag (Flag)

    Flag to unset on the damping part masss

    Returns

    No return value

    Example

    To unset the flag f on all the damping part masss in model m: 

    DampingPartMass.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the damping part mass.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch damping part mass pm: 

    pm.Unsketch();

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

    Description

    Unsketches all damping part masss.

    Arguments

  • Model (Model)

    Model that all damping part masss will be unblanked in

  • redraw (optional) (boolean)

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

    DampingPartMass.UnsketchAll(m);

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

    Description

    Unsketches all flagged damping part masss in the model.

    Arguments

  • Model (Model)

    Model that all damping part masss will be unsketched in

  • flag (Flag)

    Flag set on the damping part masss that you want to unsketch

  • redraw (optional) (boolean)

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

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

    DampingPartMass object.

    Return type

    DampingPartMass

    Example

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

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

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

    Description

    Adds a warning for damping part mass. 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 damping part mass pm: 

    pm.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this damping part mass.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for damping part mass pm: 

    var xrefs = pm.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for damping part mass pm in keyword format 

    var s = fr.toString();