DampingPartStructural class

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

DampingPartStructural constants

Name Description
DampingPartStructural.PART PART is *DAMPING_PART_STRUCTURAL.
DampingPartStructural.SET SET is *DAMPING_PART_STRUCTURAL_SET.

DampingPartStructural properties

Name Type Description
coef real Structural damping coefficient
exists (read only) logical true if damping part structural exists, false if referred to but not defined.
id integer Part/part set id
include integer The Include file number that the damping part structural is in.
model (read only) integer The Model number that the damping part structural is in.
type constant The DampingPartStructural type. Can be:

Detailed Description

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

Constructor

new DampingPartStructural(Model[Model], type[constant], id[integer], coef (optional)[real])

Description

Create a new DampingPartStructural object for *DAMPING_PART_STRUCTURAL.

Arguments

  • Model (Model)

    Model that damping part structural will be created in

  • type (constant)

    Damping part structural type. Can be DampingPartStructural.PART or DampingPartStructural.SET.

  • id (integer)

    Part/part set id

  • coef (optional) (real)

    Structural damping coefficient

    Returns

    DampingPartStructural object

    Return type

    DampingPartStructural

    Example

    To create a new damping part structural (of type PART) in model m with id, coef set to 11, 2.5 respectively: 

    var ps = new DampingPartStructural(m, DampingPartStructural.PART, 11, 2.5);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a damping part structural.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the damping part structural

    Returns

    No return value

    Example

    To associate comment c to the damping part structural ps: 

    ps.AssociateComment(c);

    Blank()

    Description

    Blanks the damping part structural

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank damping part structural ps: 

    ps.Blank();

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

    Description

    Blanks all of the damping part structurals in the model.

    Arguments

  • Model (Model)

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

    DampingPartStructural.BlankAll(m);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

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

    DampingPartStructural.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the damping part structural is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if damping part structural ps is blanked: 

    if (ps.Blanked() ) do_something...

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the damping part structural.

    Arguments

  • flag (Flag)

    Flag to clear on the damping part structural

    Returns

    No return value

    Example

    To clear flag f for damping part structural ps: 

    ps.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    DampingPartStructural object

    Return type

    DampingPartStructural

    Example

    To copy damping part structural ps into damping part structural z: 

    var z = ps.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a damping part structural.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the damping part structural

    Returns

    No return value

    Example

    To detach comment c from the damping part structural ps: 

    ps.DetachComment(c);

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

    Description

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

    ps.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first damping part structural in the model.

    Arguments

  • Model (Model)

    Model to get first damping part structural in

    Returns

    DampingPartStructural object (or null if there are no damping part structurals in the model).

    Return type

    DampingPartStructural

    Example

    To get the first damping part structural in model m: 

    var ps = DampingPartStructural.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all damping part structurals will be flagged in

  • flag (Flag)

    Flag to set on the damping part structurals

    Returns

    No return value

    Example

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

    DampingPartStructural.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the damping part structural is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the damping part structural

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if damping part structural ps has flag f set on it: 

    if (ps.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all damping part structurals are in

  • func (function)

    Function to call for each damping part structural

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

    DampingPartStructural.ForEach(m, test);
function test(ps)
{
// ps is DampingPartStructural object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get damping part structurals from

  • property (optional) (string)

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

    Returns

    Array of DampingPartStructural objects or properties

    Return type

    Array

    Example

    To make an array of DampingPartStructural objects for all of the damping part structurals in model m: 

    var a = DampingPartStructural.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a damping part structural.

    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 structural ps: 

    var comm_array = ps.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get damping part structurals from

  • flag (Flag)

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

  • property (optional) (string)

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

    Returns

    Array of DampingPartStructural objects or properties

    Return type

    Array

    Example

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

    var ps = DampingPartStructural.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 structurals in model m flagged with f: 

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

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

    Description

    Returns the DampingPartStructural object for a damping part structural ID.

    Arguments

  • Model (Model)

    Model to find the damping part structural in

  • number (integer)

    number of the damping part structural you want the DampingPartStructural object for

    Returns

    DampingPartStructural object (or null if damping part structural does not exist).

    Return type

    DampingPartStructural

    Example

    To get the DampingPartStructural object for damping part structural 100 in model m 

    var ps = DampingPartStructural.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    damping part structural property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if DampingPartStructural property ps.example is a parameter: 

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

    To check if DampingPartStructural property ps.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this damping part structural (*DAMPING_PART_STRUCTURAL). Note that a carriage return is not added. See also DampingPartStructural.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for damping part structural m: 

    var key = fr.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for damping part structural fr: 

    var cards = fr.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last damping part structural in the model.

    Arguments

  • Model (Model)

    Model to get last damping part structural in

    Returns

    DampingPartStructural object (or null if there are no damping part structurals in the model).

    Return type

    DampingPartStructural

    Example

    To get the last damping part structural in model m: 

    var ps = DampingPartStructural.Last(m);

    Next()

    Description

    Returns the next damping part structural in the model.

    Arguments

    No arguments

    Returns

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

    Return type

    DampingPartStructural

    Example

    To get the damping part structural in model m after damping part structural ps: 

    var ps = ps.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 structural.

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

    DampingPartStructural object (or null if not picked)

    Return type

    DampingPartStructural

    Example

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

    var ps = DampingPartStructural.Pick('Pick damping part structural from screen', m);

    Previous()

    Description

    Returns the previous damping part structural in the model.

    Arguments

    No arguments

    Returns

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

    Return type

    DampingPartStructural

    Example

    To get the damping part structural in model m before damping part structural ps: 

    var ps = ps.Previous();

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting damping part structurals

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

    Return type

    Number

    Example

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

    DampingPartStructural.Select(f, 'Select damping part structurals', m);

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

    DampingPartStructural.Select(f, 'Select damping part structurals', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the damping part structural.

    Arguments

  • flag (Flag)

    Flag to set on the damping part structural

    Returns

    No return value

    Example

    To set flag f for damping part structural ps: 

    ps.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the damping part structural is sketched. If omitted redraw is true. If you want to sketch several damping part structurals 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 structural ps: 

    ps.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

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

  • redraw (optional) (boolean)

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

    DampingPartStructural.SketchFlagged(m, flag);

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

    Description

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

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of damping part structurals

    Return type

    Number

    Example

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

    var total = DampingPartStructural.Total(m);

    Unblank()

    Description

    Unblanks the damping part structural

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank damping part structural ps: 

    ps.Unblank();

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

    Description

    Unblanks all of the damping part structurals in the model.

    Arguments

  • Model (Model)

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

    DampingPartStructural.UnblankAll(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that the flagged damping part structurals will be unblanked in

  • flag (Flag)

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

    DampingPartStructural.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the damping part structurals

    Returns

    No return value

    Example

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

    DampingPartStructural.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the damping part structural.

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the damping part structural is unsketched. If omitted redraw is true. If you want to unsketch several damping part structurals 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 structural ps: 

    ps.Unsketch();

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

    Description

    Unsketches all damping part structurals.

    Arguments

  • Model (Model)

    Model that all damping part structurals will be unblanked in

  • redraw (optional) (boolean)

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

    DampingPartStructural.UnsketchAll(m);

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

    Description

    Unsketches all flagged damping part structurals in the model.

    Arguments

  • Model (Model)

    Model that all damping part structurals will be unsketched in

  • flag (Flag)

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

  • redraw (optional) (boolean)

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

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

    DampingPartStructural object.

    Return type

    DampingPartStructural

    Example

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

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

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

    Description

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

    ps.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this damping part structural.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for damping part structural ps: 

    var xrefs = ps.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for damping part structural ps in keyword format 

    var s = fr.toString();