DampingRelative class

The DampingRelative class gives you access to define damping relative 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

DampingRelative properties

Name Type Description
cdamp real Fraction of critical damping
dv2 real Constant for velocity squared term
exists (read only) logical true if damping relative exists, false if referred to but not defined.
freq real Target frequency
include integer The Include file number that the damping relative is in.
lcid integer Fraction of cricitcal damping vs time
model (read only) integer The Model number that the damping relative is in.
pidrb integer Part Rigid body ID
psid integer Set Part set ID.

Detailed Description

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

Constructor

new DampingRelative(Model[Model], pidrb[integer], psid[integer], cdamp (optional)[real], freq (optional)[real], dv2 (optional)[real], lcid (optional)[integer])

Description

Create a new DampingRelative object for *DAMPING_RELATIVE.

Arguments

  • Model (Model)

    Model that damping relative will be created in

  • pidrb (integer)

    Part Rigid body ID

  • psid (integer)

    Set Part set ID.

  • cdamp (optional) (real)

    Fraction of critical damping

  • freq (optional) (real)

    Target frequency

  • dv2 (optional) (real)

    Constant for velocity squared term

  • lcid (optional) (integer)

    Fraction of cricitcal damping vs time

    Returns

    DampingRelative object

    Return type

    DampingRelative

    Example

    To create a new damping relative (of no type) in model m with pidrb, psid, cdamp, freq, dv2, lcid set to 10, 20, 3.5, 4.5, 5.5, 60 respectively: 

    var r = new DampingRelative(m, 10, 20, 3.5, 4.5, 5.5, 60);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a damping relative.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the damping relative

    Returns

    No return value

    Example

    To associate comment c to the damping relative r: 

    r.AssociateComment(c);

    Blank()

    Description

    Blanks the damping relative

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank damping relative r: 

    r.Blank();

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

    Description

    Blanks all of the damping relatives in the model.

    Arguments

  • Model (Model)

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

    DampingRelative.BlankAll(m);

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

    Description

    Blanks all of the flagged damping relatives in the model.

    Arguments

  • Model (Model)

    Model that all the flagged damping relatives will be blanked in

  • flag (Flag)

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

    DampingRelative.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the damping relative is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if damping relative r is blanked: 

    if (r.Blanked() ) do_something...

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the damping relative.

    Arguments

  • flag (Flag)

    Flag to clear on the damping relative

    Returns

    No return value

    Example

    To clear flag f for damping relative r: 

    r.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    DampingRelative object

    Return type

    DampingRelative

    Example

    To copy damping relative r into damping relative z: 

    var z = r.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a damping relative.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the damping relative

    Returns

    No return value

    Example

    To detach comment c from the damping relative r: 

    r.DetachComment(c);

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

    Description

    Adds an error for damping relative. 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 relative r: 

    r.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first damping relative in the model.

    Arguments

  • Model (Model)

    Model to get first damping relative in

    Returns

    DampingRelative object (or null if there are no damping relatives in the model).

    Return type

    DampingRelative

    Example

    To get the first damping relative in model m: 

    var r = DampingRelative.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all damping relatives will be flagged in

  • flag (Flag)

    Flag to set on the damping relatives

    Returns

    No return value

    Example

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

    DampingRelative.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the damping relative is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the damping relative

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if damping relative r has flag f set on it: 

    if (r.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all damping relatives are in

  • func (function)

    Function to call for each damping relative

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

    DampingRelative.ForEach(m, test);
function test(r)
{
// r is DampingRelative object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get damping relatives from

  • property (optional) (string)

    Name for property to get for all damping relatives in the model

    Returns

    Array of DampingRelative objects or properties

    Return type

    Array

    Example

    To make an array of DampingRelative objects for all of the damping relatives in model m: 

    var a = DampingRelative.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a damping relative.

    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 relative r: 

    var comm_array = r.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get damping relatives from

  • flag (Flag)

    Flag set on the damping relatives that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged damping relatives in the model

    Returns

    Array of DampingRelative objects or properties

    Return type

    Array

    Example

    To make an array of DampingRelative objects for all of the damping relatives in model m flagged with f: 

    var r = DampingRelative.GetFlagged(m, f);

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

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

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

    Description

    Returns the DampingRelative object for a damping relative ID.

    Arguments

  • Model (Model)

    Model to find the damping relative in

  • number (integer)

    number of the damping relative you want the DampingRelative object for

    Returns

    DampingRelative object (or null if damping relative does not exist).

    Return type

    DampingRelative

    Example

    To get the DampingRelative object for damping relative 100 in model m 

    var r = DampingRelative.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    damping relative property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if DampingRelative property r.example is a parameter: 

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

    To check if DampingRelative property r.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this damping relative (*DAMPING_RELATIVE). Note that a carriage return is not added. See also DampingRelative.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for damping relative m: 

    var key = r.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for damping relative fr: 

    var cards = r.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last damping relative in the model.

    Arguments

  • Model (Model)

    Model to get last damping relative in

    Returns

    DampingRelative object (or null if there are no damping relatives in the model).

    Return type

    DampingRelative

    Example

    To get the last damping relative in model m: 

    var r = DampingRelative.Last(m);

    Next()

    Description

    Returns the next damping relative in the model.

    Arguments

    No arguments

    Returns

    DampingRelative object (or null if there are no more damping relatives in the model).

    Return type

    DampingRelative

    Example

    To get the damping relative in model m after damping relative r: 

    var r = r.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 relative.

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

    DampingRelative object (or null if not picked)

    Return type

    DampingRelative

    Example

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

    var r = DampingRelative.Pick('Pick damping relative from screen', m);

    Previous()

    Description

    Returns the previous damping relative in the model.

    Arguments

    No arguments

    Returns

    DampingRelative object (or null if there are no more damping relatives in the model).

    Return type

    DampingRelative

    Example

    To get the damping relative in model m before damping relative r: 

    var r = r.Previous();

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting damping relatives

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

    Return type

    Number

    Example

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

    DampingRelative.Select(f, 'Select damping relatives', m);

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

    DampingRelative.Select(f, 'Select damping relatives', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the damping relative.

    Arguments

  • flag (Flag)

    Flag to set on the damping relative

    Returns

    No return value

    Example

    To set flag f for damping relative r: 

    r.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch damping relative r: 

    r.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged damping relatives will be sketched in

  • flag (Flag)

    Flag set on the damping relatives that you want to sketch

  • redraw (optional) (boolean)

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

    DampingRelative.SketchFlagged(m, flag);

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

    Description

    Returns the total number of damping relatives in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of damping relatives

    Return type

    Number

    Example

    To get the total number of damping relatives in model m: 

    var total = DampingRelative.Total(m);

    Unblank()

    Description

    Unblanks the damping relative

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank damping relative r: 

    r.Unblank();

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

    Description

    Unblanks all of the damping relatives in the model.

    Arguments

  • Model (Model)

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

    DampingRelative.UnblankAll(m);

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

    Description

    Unblanks all of the flagged damping relatives in the model.

    Arguments

  • Model (Model)

    Model that the flagged damping relatives will be unblanked in

  • flag (Flag)

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

    DampingRelative.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the damping relatives

    Returns

    No return value

    Example

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

    DampingRelative.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the damping relative.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch damping relative r: 

    r.Unsketch();

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

    Description

    Unsketches all damping relatives.

    Arguments

  • Model (Model)

    Model that all damping relatives will be unblanked in

  • redraw (optional) (boolean)

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

    DampingRelative.UnsketchAll(m);

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

    Description

    Unsketches all flagged damping relatives in the model.

    Arguments

  • Model (Model)

    Model that all damping relatives will be unsketched in

  • flag (Flag)

    Flag set on the damping relatives that you want to unsketch

  • redraw (optional) (boolean)

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

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

    DampingRelative object.

    Return type

    DampingRelative

    Example

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

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

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

    Description

    Adds a warning for damping relative. 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 relative r: 

    r.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this damping relative.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for damping relative r: 

    var xrefs = r.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for damping relative r in keyword format 

    var s = r.toString();