Pretensioner class

The Pretensioner class gives you access to seatbelt pretensioner 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

Pretensioner properties

Name Type Description
colour Colour The colour of the pretensioner
exists (read only) logical true if pretensioner exists, false if referred to but not defined.
include integer The Include file number that the pretensioner is in.
label integer Pretensioner number. Also see the sbprid property which is an alternative name for this.
lmtfrc real Limiting force
lmtpin real Limiting pull-in
model (read only) integer The Model number that the pretensioner is in.
ptlcid integer Loadcurve of pull-in vs time
sbprid integer Pretensioner number. Also see the label property which is an alternative name for this.
sbprty integer Pretensioner type.
sbrid integer Retractor number.
sbsid1 integer Sensor number 1
sbsid2 integer Sensor number 2
sbsid3 integer Sensor number 3
sbsid4 integer Sensor number 4
time real Time between sensor triggering and pretensioner acting.
transparency integer The transparency of the pretensioner (0-100) 0% is opaque, 100% is transparent.

Detailed Description

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

Constructor

new Pretensioner(Model[Model], sbprid[integer], sbprty[integer], sbrid[integer], ptlcid[integer], sbsid1[integer], sbsid2 (optional)[integer], sbsid3 (optional)[integer], sbsid4 (optional)[integer], time (optional)[real], lmtfrc (optional)[real], lmtpin (optional)[real])

Description

Create a new Seatbelt Pretensioner object.

Arguments

  • Model (Model)

    Model that pretensioner will be created in

  • sbprid (integer)

    Pretensioner number.

  • sbprty (integer)

    Pretensioner type.

  • sbrid (integer)

    Retractor number.

  • ptlcid (integer)

    Loadcurve of pull-in vs time

  • sbsid1 (integer)

    Sensor number 1

  • sbsid2 (optional) (integer)

    Sensor number 2

  • sbsid3 (optional) (integer)

    Sensor number 3

  • sbsid4 (optional) (integer)

    Sensor number 4

  • time (optional) (real)

    Time between sensor triggering and pretensioner acting.

  • lmtfrc (optional) (real)

    Limiting force

  • lmtpin (optional) (real)

    Limiting pull-in

    Returns

    Pretensioner object

    Return type

    Pretensioner

    Example

    To create a new pyrotechnic seatbelt pretensioner in model m with label 100, Retractor 10, Loading curve 20 and Sensor 30: 

    var p = new Pretensioner(m, 100, 1, 10, 20, 30);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a pretensioner.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the pretensioner

    Returns

    No return value

    Example

    To associate comment c to the pretensioner p: 

    p.AssociateComment(c);

    Blank()

    Description

    Blanks the pretensioner

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank pretensioner p: 

    p.Blank();

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

    Description

    Blanks all of the pretensioners in the model.

    Arguments

  • Model (Model)

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

    Pretensioner.BlankAll(m);

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

    Description

    Blanks all of the flagged pretensioners in the model.

    Arguments

  • Model (Model)

    Model that all the flagged pretensioners will be blanked in

  • flag (Flag)

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

    Pretensioner.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the pretensioner is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if pretensioner p is blanked: 

    if (p.Blanked() ) do_something...

    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 pretensioner p: 

    p.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the pretensioner.

    Arguments

  • flag (Flag)

    Flag to clear on the pretensioner

    Returns

    No return value

    Example

    To clear flag f for pretensioner p: 

    p.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    Pretensioner object

    Return type

    Pretensioner

    Example

    To copy pretensioner p into pretensioner z: 

    var z = p.Copy();

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

    Description

    Starts an interactive editing panel to create a pretensioner

    Arguments

  • Model (Model)

    Model that the pretensioner 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

    Pretensioner object (or null if not made).

    Return type

    Pretensioner

    Example

    To start creating a pretensioner in model m: 

    var p = Pretensioner.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a pretensioner.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the pretensioner

    Returns

    No return value

    Example

    To detach comment c from the pretensioner p: 

    p.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 pretensioner p: 

    p.Edit();

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

    Description

    Adds an error for pretensioner. 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 pretensioner p: 

    p.Error("My custom error");

    ExtractColour()

    Description

    Extracts the actual colour used for pretensioner.
    By default in PRIMER many entities such as elements get their colour automatically from the part that they are in. PRIMER cycles through 13 default colours based on the label of the entity. In this case the pretensioner colour property will return the value Colour.PART instead of the actual colour. This method will return the actual colour which is used for drawing the pretensioner.

    Arguments

    No arguments

    Returns

    colour value (integer)

    Return type

    Number

    Example

    To return the colour used for drawing pretensioner p: 

    var colour = p.ExtractColour();

    First(Model[Model]) [static]

    Description

    Returns the first pretensioner in the model.

    Arguments

  • Model (Model)

    Model to get first pretensioner in

    Returns

    Pretensioner object (or null if there are no pretensioners in the model).

    Return type

    Pretensioner

    Example

    To get the first pretensioner in model m: 

    var p = Pretensioner.First(m);

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

    Description

    Returns the first free pretensioner label in the model. Also see Pretensioner.LastFreeLabel(), Pretensioner.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

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

    Pretensioner label.

    Return type

    Number

    Example

    To get the first free pretensioner label in model m: 

    var label = Pretensioner.FirstFreeLabel(m);

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

    Description

    Flags all of the pretensioners in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all pretensioners will be flagged in

  • flag (Flag)

    Flag to set on the pretensioners

    Returns

    No return value

    Example

    To flag all of the pretensioners with flag f in model m: 

    Pretensioner.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the pretensioner is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the pretensioner

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if pretensioner p has flag f set on it: 

    if (p.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all pretensioners are in

  • func (function)

    Function to call for each pretensioner

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

    Pretensioner.ForEach(m, test);
function test(p)
{
// p is Pretensioner object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get pretensioners from

  • property (optional) (string)

    Name for property to get for all pretensioners in the model

    Returns

    Array of Pretensioner objects or properties

    Return type

    Array

    Example

    To make an array of Pretensioner objects for all of the pretensioners in model m: 

    var a = Pretensioner.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a pretensioner.

    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 pretensioner p: 

    var comm_array = p.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get pretensioners from

  • flag (Flag)

    Flag set on the pretensioners that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged pretensioners in the model

    Returns

    Array of Pretensioner objects or properties

    Return type

    Array

    Example

    To make an array of Pretensioner objects for all of the pretensioners in model m flagged with f: 

    var p = Pretensioner.GetFlagged(m, f);

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

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

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

    Description

    Returns the Pretensioner object for a pretensioner ID.

    Arguments

  • Model (Model)

    Model to find the pretensioner in

  • number (integer)

    number of the pretensioner you want the Pretensioner object for

    Returns

    Pretensioner object (or null if pretensioner does not exist).

    Return type

    Pretensioner

    Example

    To get the Pretensioner object for pretensioner 100 in model m 

    var p = Pretensioner.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    pretensioner property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if Pretensioner property p.example is a parameter: 

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

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

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

    Keyword()

    Description

    Returns the keyword for this pretensioner (*ELEMENT_SEATBELT_PRETEROMETER) Note that a carriage return is not added. See also Pretensioner.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for pretensioner p: 

    var key = p.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for pretensioner a: 

    var cards = a.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last pretensioner in the model.

    Arguments

  • Model (Model)

    Model to get last pretensioner in

    Returns

    Pretensioner object (or null if there are no pretensioners in the model).

    Return type

    Pretensioner

    Example

    To get the last pretensioner in model m: 

    var p = Pretensioner.Last(m);

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

    Description

    Returns the last free pretensioner label in the model. Also see Pretensioner.FirstFreeLabel(), Pretensioner.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

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

    Pretensioner label.

    Return type

    Number

    Example

    To get the last free pretensioner label in model m: 

    var label = Pretensioner.LastFreeLabel(m);

    Next()

    Description

    Returns the next pretensioner in the model.

    Arguments

    No arguments

    Returns

    Pretensioner object (or null if there are no more pretensioners in the model).

    Return type

    Pretensioner

    Example

    To get the pretensioner in model m after pretensioner p: 

    var p = p.Next();

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

    Description

    Returns the next free (highest+1) pretensioner label in the model. Also see Pretensioner.FirstFreeLabel(), Pretensioner.LastFreeLabel() and Model.NextFreeItemLabel()

    Arguments

  • Model (Model)

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

    Pretensioner label.

    Return type

    Number

    Example

    To get the next free pretensioner label in model m: 

    var label = Pretensioner.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 pretensioner.

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

    Pretensioner object (or null if not picked)

    Return type

    Pretensioner

    Example

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

    var p = Pretensioner.Pick('Pick pretensioner from screen', m);

    Previous()

    Description

    Returns the previous pretensioner in the model.

    Arguments

    No arguments

    Returns

    Pretensioner object (or null if there are no more pretensioners in the model).

    Return type

    Pretensioner

    Example

    To get the pretensioner in model m before pretensioner p: 

    var p = p.Previous();

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

    Description

    Renumbers all of the pretensioners in the model.

    Arguments

  • Model (Model)

    Model that all pretensioners will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the pretensioners in model m, from 1000000: 

    Pretensioner.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged pretensioners in the model.

    Arguments

  • Model (Model)

    Model that all the flagged pretensioners will be renumbered in

  • flag (Flag)

    Flag set on the pretensioners that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the pretensioners in model m flagged with f, from 1000000: 

    Pretensioner.RenumberFlagged(m, f, 1000000);

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

    Description

    Allows the user to select pretensioners using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting pretensioners

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    Pretensioner.Select(f, 'Select pretensioners', m);

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

    Pretensioner.Select(f, 'Select pretensioners', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the pretensioner.

    Arguments

  • flag (Flag)

    Flag to set on the pretensioner

    Returns

    No return value

    Example

    To set flag f for pretensioner p: 

    p.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch pretensioner p: 

    p.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged pretensioners will be sketched in

  • flag (Flag)

    Flag set on the pretensioners that you want to sketch

  • redraw (optional) (boolean)

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

    Pretensioner.SketchFlagged(m, flag);

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

    Description

    Returns the total number of pretensioners in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of pretensioners

    Return type

    Number

    Example

    To get the total number of pretensioners in model m: 

    var total = Pretensioner.Total(m);

    Unblank()

    Description

    Unblanks the pretensioner

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank pretensioner p: 

    p.Unblank();

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

    Description

    Unblanks all of the pretensioners in the model.

    Arguments

  • Model (Model)

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

    Pretensioner.UnblankAll(m);

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

    Description

    Unblanks all of the flagged pretensioners in the model.

    Arguments

  • Model (Model)

    Model that the flagged pretensioners will be unblanked in

  • flag (Flag)

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

    Pretensioner.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the pretensioners in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all pretensioners will be unset in

  • flag (Flag)

    Flag to unset on the pretensioners

    Returns

    No return value

    Example

    To unset the flag f on all the pretensioners in model m: 

    Pretensioner.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the pretensioner.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch pretensioner p: 

    p.Unsketch();

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

    Description

    Unsketches all pretensioners.

    Arguments

  • Model (Model)

    Model that all pretensioners will be unblanked in

  • redraw (optional) (boolean)

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

    Pretensioner.UnsketchAll(m);

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

    Description

    Unsketches all flagged pretensioners in the model.

    Arguments

  • Model (Model)

    Model that all pretensioners will be unsketched in

  • flag (Flag)

    Flag set on the pretensioners that you want to unsketch

  • redraw (optional) (boolean)

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

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

    Pretensioner object.

    Return type

    Pretensioner

    Example

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

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

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

    Description

    Adds a warning for pretensioner. 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 pretensioner p: 

    p.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this pretensioner.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for pretensioner p: 

    var xrefs = p.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for pretensioner p in keyword format 

    var str = p.toString();