ReferenceGeometry class

The ReferenceGeometry class gives you access to define airbag reference geometry 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

ReferenceGeometry properties

Name Type Description
aid integer ReferenceGeometry number. Also see the label property which is an alternative name for this.
birth logical Turns _BIRTH on or off
birth_time real Birth time
exists (read only) logical true if airbag reference geometry exists, false if referred to but not defined.
id logical Turns _ID on or OFF
include integer The Include file number that the airbag reference geometry is in.
iout integer Flag for outputting the current reference node coordinates
label integer ReferenceGeometry number. Also see the aid property which is an alternative name for this.
model (read only) integer The Model number that the airbag reference geometry is in.
nido integer Node number for origin
rdt logical Turns _RDT on or OFF
sx real Scale factor in X direction
sy real Scale factor in Y direction
sz real Scale factor in Z direction

Detailed Description

The ReferenceGeometry class allows you to create, modify, edit and manipulate airbag reference geometry cards. See the documentation below for more details.

Constructor

new ReferenceGeometry(Model[Model], aid (optional)[integer])

Description

Create a new ReferenceGeometry object.

Arguments

  • Model (Model)

    Model that ReferenceGeometry will be created in

  • aid (optional) (integer)

    ReferenceGeometry number to set _ID suffix

    Returns

    ReferenceGeometry object

    Return type

    ReferenceGeometry

    Example

    To create a new ReferenceGeometry in model m 

    var a = new ReferenceGeometry(m);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a airbag reference geometry.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the airbag reference geometry

    Returns

    No return value

    Example

    To associate comment c to the airbag reference geometry a: 

    a.AssociateComment(c);

    Browse(modal (optional)[boolean])

    Description

    Starts an edit panel in Browse mode.

    Arguments

  • modal (optional) (boolean)

    If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

    Returns

    no return value

    Example

    To Browse airbag reference geometry a: 

    a.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the airbag reference geometry.

    Arguments

  • flag (Flag)

    Flag to clear on the airbag reference geometry

    Returns

    No return value

    Example

    To clear flag f for airbag reference geometry a: 

    a.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

    Copies the airbag reference geometry. The target include of the copied airbag reference geometry 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

    ReferenceGeometry object

    Return type

    ReferenceGeometry

    Example

    To copy airbag reference geometry a into airbag reference geometry z: 

    var z = a.Copy();

    Create(Model[Model], modal (optional)[boolean]) [static]

    Description

    Starts an interactive editing panel to create a airbag reference geometry

    Arguments

  • Model (Model)

    Model that the airbag reference geometry will be created in.

  • modal (optional) (boolean)

    If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

    Returns

    ReferenceGeometry object (or null if not made).

    Return type

    ReferenceGeometry

    Example

    To start creating a airbag reference geometry in model m: 

    var a = ReferenceGeometry.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a airbag reference geometry.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the airbag reference geometry

    Returns

    No return value

    Example

    To detach comment c from the airbag reference geometry a: 

    a.DetachComment(c);

    Edit(modal (optional)[boolean])

    Description

    Starts an interactive editing panel.

    Arguments

  • modal (optional) (boolean)

    If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

    Returns

    no return value

    Example

    To Edit airbag reference geometry a: 

    a.Edit();

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

    Description

    Adds an error for airbag reference geometry. 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 airbag reference geometry a: 

    a.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first airbag reference geometry in the model.

    Arguments

  • Model (Model)

    Model to get first airbag reference geometry in

    Returns

    ReferenceGeometry object (or null if there are no airbag reference geometrys in the model).

    Return type

    ReferenceGeometry

    Example

    To get the first airbag reference geometry in model m: 

    var a = ReferenceGeometry.First(m);

    FirstFreeLabel(Model[Model], layer (optional)[Include number]) [static]

    Description

    Returns the first free airbag reference geometry label in the model. Also see ReferenceGeometry.LastFreeLabel(), ReferenceGeometry.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

    Model to get first free airbag reference geometry label in

  • layer (optional) (Include number)

    Include file (0 for the main file) to search for labels in (Equivalent to First free in layer in editing panels). If omitted the whole model will be used (Equivalent to First free in editing panels).

    Returns

    ReferenceGeometry label.

    Return type

    Number

    Example

    To get the first free airbag reference geometry label in model m: 

    var label = ReferenceGeometry.FirstFreeLabel(m);

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

    Description

    Flags all of the airbag reference geometrys in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all airbag reference geometrys will be flagged in

  • flag (Flag)

    Flag to set on the airbag reference geometrys

    Returns

    No return value

    Example

    To flag all of the airbag reference geometrys with flag f in model m: 

    ReferenceGeometry.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the airbag reference geometry is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the airbag reference geometry

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if airbag reference geometry a has flag f set on it: 

    if (a.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all airbag reference geometrys are in

  • func (function)

    Function to call for each airbag reference geometry

  • 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 airbag reference geometrys in model m: 

    ReferenceGeometry.ForEach(m, test);
function test(a)
{
// a is ReferenceGeometry object
}

    To call function test for all of the airbag reference geometrys in model m with optional object: 

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

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

    Description

    Returns an array of ReferenceGeometry objects or properties for all of the airbag reference geometrys in a model in PRIMER. If the optional property argument is not given then an array of ReferenceGeometry objects is returned. If the property argument is given, that property value for each airbag reference geometry is returned in the array instead of a ReferenceGeometry object

    Arguments

  • Model (Model)

    Model to get airbag reference geometrys from

  • property (optional) (string)

    Name for property to get for all airbag reference geometrys in the model

    Returns

    Array of ReferenceGeometry objects or properties

    Return type

    Array

    Example

    To make an array of ReferenceGeometry objects for all of the airbag reference geometrys in model m: 

    var a = ReferenceGeometry.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a airbag reference geometry.

    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 airbag reference geometry a: 

    var comm_array = a.GetComments();

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

    Description

    Returns an array of ReferenceGeometry objects for all of the flagged airbag reference geometrys in a model in PRIMER If the optional property argument is not given then an array of ReferenceGeometry objects is returned. If the property argument is given, then that property value for each airbag reference geometry is returned in the array instead of a ReferenceGeometry object

    Arguments

  • Model (Model)

    Model to get airbag reference geometrys from

  • flag (Flag)

    Flag set on the airbag reference geometrys that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged airbag reference geometrys in the model

    Returns

    Array of ReferenceGeometry objects or properties

    Return type

    Array

    Example

    To make an array of ReferenceGeometry objects for all of the airbag reference geometrys in model m flagged with f: 

    var a = ReferenceGeometry.GetFlagged(m, f);

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

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

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

    Description

    Returns the ReferenceGeometry object for a airbag reference geometry ID.

    Arguments

  • Model (Model)

    Model to find the airbag reference geometry in

  • number (integer)

    number of the airbag reference geometry you want the ReferenceGeometry object for

    Returns

    ReferenceGeometry object (or null if airbag reference geometry does not exist).

    Return type

    ReferenceGeometry

    Example

    To get the ReferenceGeometry object for airbag reference geometry 100 in model m 

    var a = ReferenceGeometry.GetFromID(m, 100);

    GetNode(nid[integer])

    Description

    Returns the reference geometry coordinates for the node

    Arguments

  • nid (integer)

    Node ID

    Returns

    An array containing the three reference coordinates (or null if the node is not on the reference geometry)

    Return type

    Array

    Example

    To get the reference coordinates of node number nid on reference geometry a 

    var coords = a.GetNode(nid);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    airbag reference geometry property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if ReferenceGeometry property a.example is a parameter: 

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

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

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for reference_geometry m: 

    var key = m.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for airbag reference geometry a: 

    var cards = b.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last airbag reference geometry in the model.

    Arguments

  • Model (Model)

    Model to get last airbag reference geometry in

    Returns

    ReferenceGeometry object (or null if there are no airbag reference geometrys in the model).

    Return type

    ReferenceGeometry

    Example

    To get the last airbag reference geometry in model m: 

    var a = ReferenceGeometry.Last(m);

    LastFreeLabel(Model[Model], layer (optional)[Include number]) [static]

    Description

    Returns the last free airbag reference geometry label in the model. Also see ReferenceGeometry.FirstFreeLabel(), ReferenceGeometry.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get last free airbag reference geometry label in

  • layer (optional) (Include number)

    Include file (0 for the main file) to search for labels in (Equivalent to Highest free in layer in editing panels). If omitted the whole model will be used.

    Returns

    ReferenceGeometry label.

    Return type

    Number

    Example

    To get the last free airbag reference geometry label in model m: 

    var label = ReferenceGeometry.LastFreeLabel(m);

    Next()

    Description

    Returns the next airbag reference geometry in the model.

    Arguments

    No arguments

    Returns

    ReferenceGeometry object (or null if there are no more airbag reference geometrys in the model).

    Return type

    ReferenceGeometry

    Example

    To get the airbag reference geometry in model m after airbag reference geometry a: 

    var a = a.Next();

    NextFreeLabel(Model[Model], layer (optional)[Include number]) [static]

    Description

    Returns the next free (highest+1) airbag reference geometry label in the model. Also see ReferenceGeometry.FirstFreeLabel(), ReferenceGeometry.LastFreeLabel() and Model.NextFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get next free airbag reference geometry label in

  • layer (optional) (Include number)

    Include file (0 for the main file) to search for labels in (Equivalent to Highest+1 in layer in editing panels). If omitted the whole model will be used (Equivalent to Highest+1 in editing panels).

    Returns

    ReferenceGeometry label.

    Return type

    Number

    Example

    To get the next free airbag reference geometry label in model m: 

    var label = ReferenceGeometry.NextFreeLabel(m);

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

    Description

    Allows the user to pick a airbag reference geometry.

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

    ReferenceGeometry object (or null if not picked)

    Return type

    ReferenceGeometry

    Example

    To pick a airbag reference geometry from model m giving the prompt 'Pick airbag reference geometry from screen': 

    var a = ReferenceGeometry.Pick('Pick airbag reference geometry from screen', m);

    Previous()

    Description

    Returns the previous airbag reference geometry in the model.

    Arguments

    No arguments

    Returns

    ReferenceGeometry object (or null if there are no more airbag reference geometrys in the model).

    Return type

    ReferenceGeometry

    Example

    To get the airbag reference geometry in model m before airbag reference geometry a: 

    var a = a.Previous();

    RemoveNode(nid[integer])

    Description

    Removes a node from the reference geometry if it is on it

    Arguments

  • nid (integer)

    Node ID

    Returns

    No return value.

    Example

    To remove node 11 from reference geometry a: 

    a.RemoveNode(11);

    RenumberAll(Model[Model], start[integer]) [static]

    Description

    Renumbers all of the airbag reference geometrys in the model.

    Arguments

  • Model (Model)

    Model that all airbag reference geometrys will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the airbag reference geometrys in model m, from 1000000: 

    ReferenceGeometry.RenumberAll(m, 1000000);

    RenumberFlagged(Model[Model], flag[Flag], start[integer]) [static]

    Description

    Renumbers all of the flagged airbag reference geometrys in the model.

    Arguments

  • Model (Model)

    Model that all the flagged airbag reference geometrys will be renumbered in

  • flag (Flag)

    Flag set on the airbag reference geometrys that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the airbag reference geometrys in model m flagged with f, from 1000000: 

    ReferenceGeometry.RenumberFlagged(m, f, 1000000);

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

    Description

    Allows the user to select airbag reference geometrys using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting airbag reference geometrys

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

    To select airbag reference geometrys from model m, flagging those selected with flag f, giving the prompt 'Select airbag reference geometrys': 

    ReferenceGeometry.Select(f, 'Select airbag reference geometrys', m);

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

    ReferenceGeometry.Select(f, 'Select airbag reference geometrys', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the airbag reference geometry.

    Arguments

  • flag (Flag)

    Flag to set on the airbag reference geometry

    Returns

    No return value

    Example

    To set flag f for airbag reference geometry a: 

    a.SetFlag(f);

    SetNode(nid[integer], x[real], y[real], z[real])

    Description

    Adds a node to the reference geometry if not already there, otherwise just changes the coordinates

    Arguments

  • nid (integer)

    Node ID

  • x (real)

    X reference coordinate

  • y (real)

    Y reference coordinate

  • z (real)

    Z reference coordinate

    Returns

    No return value.

    Example

    To add node 11 to reference geometry a with coordinates 12.0, 13.0, 14.0 

    a.SetNode(11, 12.0, 13.0, 14.0);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the airbag reference geometry. The airbag reference geometry will be sketched until you either call ReferenceGeometry.Unsketch(), ReferenceGeometry.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch airbag reference geometry a: 

    a.Sketch();

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

    Description

    Sketches all of the flagged airbag reference geometrys in the model. The airbag reference geometrys will be sketched until you either call ReferenceGeometry.Unsketch(), ReferenceGeometry.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

    Arguments

  • Model (Model)

    Model that all the flagged airbag reference geometrys will be sketched in

  • flag (Flag)

    Flag set on the airbag reference geometrys that you want to sketch

  • redraw (optional) (boolean)

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

    ReferenceGeometry.SketchFlagged(m, flag);

    Spool()

    Description

    Spools a reference geometry, entry by entry. See also ReferenceGeometry.StartSpool

    Arguments

    No arguments

    Returns

    An array containing the node ID and the three coordinates. Returns 0 if no more items

    Return type

    Array

    Example

    To spool reference geometry a: 

    var array;
a.StartSpool();
while (array = a.Spool())
{
    do something...
}

    StartSpool()

    Description

    Starts a reference geometry spooling operation. See also ReferenceGeometry.Spool

    Arguments

    No arguments

    Returns

    No return value

    Example

    To start spooling reference geometry a: 

    a.StartSpool();

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

    Description

    Returns the total number of airbag reference geometrys in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of airbag reference geometrys

    Return type

    Number

    Example

    To get the total number of airbag reference geometrys in model m: 

    var total = ReferenceGeometry.Total(m);

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

    Description

    Unsets a defined flag on all of the airbag reference geometrys in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all airbag reference geometrys will be unset in

  • flag (Flag)

    Flag to unset on the airbag reference geometrys

    Returns

    No return value

    Example

    To unset the flag f on all the airbag reference geometrys in model m: 

    ReferenceGeometry.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the airbag reference geometry.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch airbag reference geometry a: 

    a.Unsketch();

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

    Description

    Unsketches all airbag reference geometrys.

    Arguments

  • Model (Model)

    Model that all airbag reference geometrys will be unblanked in

  • redraw (optional) (boolean)

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

    ReferenceGeometry.UnsketchAll(m);

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

    Description

    Unsketches all flagged airbag reference geometrys in the model.

    Arguments

  • Model (Model)

    Model that all airbag reference geometrys will be unsketched in

  • flag (Flag)

    Flag set on the airbag reference geometrys that you want to unsketch

  • redraw (optional) (boolean)

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

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

    ReferenceGeometry object.

    Return type

    ReferenceGeometry

    Example

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

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

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

    Description

    Adds a warning for airbag reference geometry. 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 airbag reference geometry a: 

    a.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this airbag reference geometry.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for airbag reference geometry a: 

    var xrefs = a.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for ReferenceGeometry rdt in keyword format 

    var s = rdt.toString();