ShellReferenceGeometry class

The ShellReferenceGeometry class gives you access to airbag shell 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

ShellReferenceGeometry properties

Name Type Description
aid integer ShellReferenceGeometry number. Also see the label property which is an alternative name for this.
exists (read only) logical true if airbag shell 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 shell reference geometry is in.
iout integer Flag for outputting the current reference node coordinates
label integer ShellReferenceGeometry number. Also see the aid property which is an alternative name for this.
model (read only) integer The Model number that the airbag shell reference geometry is in.
nid 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 ShellReferenceGeometry class allows you to create, modify, edit and manipulate airbag shell reference geometry cards. See the documentation below for more details.

Constructor

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

Description

Create a new ShellReferenceGeometry object.

Arguments

  • Model (Model)

    Model that ShellReferenceGeometry will be created in

  • aid (optional) (integer)

    ShellReferenceGeometry number to set _ID suffix

    Returns

    ShellReferenceGeometry object

    Return type

    ShellReferenceGeometry

    Example

    To create a new ShellReferenceGeometry in model m 

    var a = new ShellReferenceGeometry(m);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a airbag shell reference geometry.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the airbag shell reference geometry

    Returns

    No return value

    Example

    To associate comment c to the airbag shell 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 shell reference geometry a: 

    a.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the airbag shell reference geometry.

    Arguments

  • flag (Flag)

    Flag to clear on the airbag shell reference geometry

    Returns

    No return value

    Example

    To clear flag f for airbag shell reference geometry a: 

    a.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    ShellReferenceGeometry object

    Return type

    ShellReferenceGeometry

    Example

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

    var z = a.Copy();

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

    Description

    Starts an interactive editing panel to create a airbag shell reference geometry

    Arguments

  • Model (Model)

    Model that the airbag shell 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

    ShellReferenceGeometry object (or null if not made).

    Return type

    ShellReferenceGeometry

    Example

    To start creating a airbag shell reference geometry in model m: 

    var a = ShellReferenceGeometry.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a airbag shell reference geometry.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the airbag shell reference geometry

    Returns

    No return value

    Example

    To detach comment c from the airbag shell 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 shell reference geometry a: 

    a.Edit();

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

    Description

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

    a.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first airbag shell reference geometry in the model.

    Arguments

  • Model (Model)

    Model to get first airbag shell reference geometry in

    Returns

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

    Return type

    ShellReferenceGeometry

    Example

    To get the first airbag shell reference geometry in model m: 

    var a = ShellReferenceGeometry.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model to get first free airbag shell 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

    ShellReferenceGeometry label.

    Return type

    Number

    Example

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

    var label = ShellReferenceGeometry.FirstFreeLabel(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all airbag shell reference geometrys will be flagged in

  • flag (Flag)

    Flag to set on the airbag shell reference geometrys

    Returns

    No return value

    Example

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

    ShellReferenceGeometry.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the airbag shell reference geometry is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the airbag shell reference geometry

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

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

    Arguments

  • Model (Model)

    Model that all airbag shell reference geometrys are in

  • func (function)

    Function to call for each airbag shell 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 shell reference geometrys in model m: 

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

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get airbag shell reference geometrys from

  • property (optional) (string)

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

    Returns

    Array of ShellReferenceGeometry objects or properties

    Return type

    Array

    Example

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

    var a = ShellReferenceGeometry.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a airbag shell 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 shell reference geometry a: 

    var comm_array = a.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get airbag shell reference geometrys from

  • flag (Flag)

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

  • property (optional) (string)

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

    Returns

    Array of ShellReferenceGeometry objects or properties

    Return type

    Array

    Example

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

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

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

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

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

    Description

    Returns the ShellReferenceGeometry object for a airbag shell reference geometry ID.

    Arguments

  • Model (Model)

    Model to find the airbag shell reference geometry in

  • number (integer)

    number of the airbag shell reference geometry you want the ShellReferenceGeometry object for

    Returns

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

    Return type

    ShellReferenceGeometry

    Example

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

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

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    airbag shell 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 ShellReferenceGeometry 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 ShellReferenceGeometry property a.example is a parameter by using the GetParameter method: 

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

    GetShell(eid[integer])

    Description

    Returns the shell reference geometry nodes and pid for the shell

    Arguments

  • eid (integer)

    Shell element ID

    Returns

    An array containing the four reference node labels and the part ID (or null if the shell is not on the shell reference geometry)

    Return type

    Array

    Example

    To get the node and part data of shell number eid on shell reference geometry a 

    var data = a.GetShell(eid);
var n1 = data[0];
var n2 = data[1];
var n3 = data[2];
var n4 = data[3];
var pid = data[4];

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for shell_reference_geometry a: 

    var key = a.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for airbag shell reference geometry a: 

    var cards = b.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last airbag shell reference geometry in the model.

    Arguments

  • Model (Model)

    Model to get last airbag shell reference geometry in

    Returns

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

    Return type

    ShellReferenceGeometry

    Example

    To get the last airbag shell reference geometry in model m: 

    var a = ShellReferenceGeometry.Last(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model to get last free airbag shell 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

    ShellReferenceGeometry label.

    Return type

    Number

    Example

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

    var label = ShellReferenceGeometry.LastFreeLabel(m);

    Next()

    Description

    Returns the next airbag shell reference geometry in the model.

    Arguments

    No arguments

    Returns

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

    Return type

    ShellReferenceGeometry

    Example

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

    var a = a.Next();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get next free airbag shell 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

    ShellReferenceGeometry label.

    Return type

    Number

    Example

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

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

    ShellReferenceGeometry object (or null if not picked)

    Return type

    ShellReferenceGeometry

    Example

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

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

    Previous()

    Description

    Returns the previous airbag shell reference geometry in the model.

    Arguments

    No arguments

    Returns

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

    Return type

    ShellReferenceGeometry

    Example

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

    var a = a.Previous();

    RemoveShell(eid[integer])

    Description

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

    Arguments

  • eid (integer)

    Element ID

    Returns

    No return value.

    Example

    To remove shell 11 from shell reference geometry a: 

    a.RemoveShell(11);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all airbag shell reference geometrys will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    ShellReferenceGeometry.RenumberAll(m, 1000000);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

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

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    ShellReferenceGeometry.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 shell reference geometrys using standard PRIMER object menus.

    Arguments

  • flag (Flag)

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

    Return type

    Number

    Example

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

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

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

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

    SetFlag(flag[Flag])

    Description

    Sets a flag on the airbag shell reference geometry.

    Arguments

  • flag (Flag)

    Flag to set on the airbag shell reference geometry

    Returns

    No return value

    Example

    To set flag f for airbag shell reference geometry a: 

    a.SetFlag(f);

    SetShell(eid[integer], n1[integer], n2[integer], n3[integer], n4[integer], pid (optional)[integer])

    Description

    Adds a shell to the shell reference geometry if not already there, otherwise just changes the reference nodes

    Arguments

  • eid (integer)

    Element ID

  • n1 (integer)

    Nodal point 1

  • n2 (integer)

    Nodal point 2

  • n3 (integer)

    Nodal point 3

  • n4 (integer)

    Nodal point 4

  • pid (optional) (integer)

    Part ID (ignored by Ansys LS-DYNA). If omitted pid will be zero.

    Returns

    No return value.

    Example

    To add shell 11 to shell reference geometry a with nodal points 12, 13, 14, 15 (and part ID 0): 

    a.SetShell(11, 12, 13, 14, 15);

    To add shell 11 to shell reference geometry a with nodal points 12, 13, 14, 15 and pid 100: 

    a.SetShell(11, 12, 13, 14, 15, 100);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the airbag shell reference geometry is sketched. If omitted redraw is true. If you want to sketch several airbag shell 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 shell reference geometry a: 

    a.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

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

  • redraw (optional) (boolean)

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

    ShellReferenceGeometry.SketchFlagged(m, flag);

    Spool()

    Description

    Spools a shell reference geometry, entry by entry. See also ShellReferenceGeometry.StartSpool

    Arguments

    No arguments

    Returns

    Returns an array containing the shell ID and the four nodal point labels. Returns 0 if no more items

    Return type

    Array

    Example

    To spool shell reference geometry a: 

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

    StartSpool()

    Description

    Starts a shell reference geometry spooling operation. See also ShellReferenceGeometry.Spool

    Arguments

    No arguments

    Returns

    No return value

    Example

    To start spooling shell reference geometry a: 

    a.StartSpool();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of airbag shell reference geometrys

    Return type

    Number

    Example

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

    var total = ShellReferenceGeometry.Total(m);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the airbag shell reference geometrys

    Returns

    No return value

    Example

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

    ShellReferenceGeometry.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the airbag shell reference geometry.

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the airbag shell reference geometry is unsketched. If omitted redraw is true. If you want to unsketch several airbag shell 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 shell reference geometry a: 

    a.Unsketch();

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

    Description

    Unsketches all airbag shell reference geometrys.

    Arguments

  • Model (Model)

    Model that all airbag shell reference geometrys will be unblanked in

  • redraw (optional) (boolean)

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

    ShellReferenceGeometry.UnsketchAll(m);

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

    Description

    Unsketches all flagged airbag shell reference geometrys in the model.

    Arguments

  • Model (Model)

    Model that all airbag shell reference geometrys will be unsketched in

  • flag (Flag)

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

  • redraw (optional) (boolean)

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

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

    ShellReferenceGeometry object.

    Return type

    ShellReferenceGeometry

    Example

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

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

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

    Description

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

    a.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this airbag shell reference geometry.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for airbag shell reference geometry a: 

    var xrefs = a.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for ShellReferenceGeometry rdt in keyword format 

    var s = rdt.toString();