Oasys.PRIMER.Pretensioner class¶

Properties¶

property Pretensioner.colour: Colour¶

The colour of the pretensioner

property Pretensioner.exists(read only): boolean¶

true if pretensioner exists, false if referred to but not defined

property Pretensioner.include: integer¶

The Include file number that the pretensioner is in

property Pretensioner.label: integer¶

Pretensioner number. Also see the sbprid property which is an alternative name for this

property Pretensioner.lmtfrc: float¶

Limiting force

property Pretensioner.model(read only): integer¶

The Model number that the pretensioner is in

property Pretensioner.ptlcid: integer¶

Loadcurve of pull-in vs time

property Pretensioner.sbprid: integer¶

Pretensioner number. Also see the label property which is an alternative name for this

property Pretensioner.sbprty: integer¶

Pretensioner type

property Pretensioner.sbrid: integer¶

Retractor number

property Pretensioner.sbsid1: integer¶

Sensor number 1

property Pretensioner.sbsid2: integer¶

Sensor number 2

property Pretensioner.sbsid3: integer¶

Sensor number 3

property Pretensioner.sbsid4: integer¶

Sensor number 4

property Pretensioner.time: float¶

Time between sensor triggering and pretensioner acting

property Pretensioner.transparency: integer¶

The transparency of the pretensioner (0-100) 0% is opaque, 100% is transparent

Constructor¶

classmethod Pretensioner(model, sbprid, sbprty, sbrid, ptlcid, sbsid1, sbsid2=Oasys.gRPC.defaultArg, sbsid3=Oasys.gRPC.defaultArg, sbsid4=Oasys.gRPC.defaultArg, time=Oasys.gRPC.defaultArg, lmtfrc=Oasys.gRPC.defaultArg)¶
Create a new Seatbelt Pretensioner object

Parameters:

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 (integer) – Optional. Sensor number 2

sbsid3 (integer) – Optional. Sensor number 3

sbsid4 (integer) – Optional. Sensor number 4

time (float) – Optional. Time between sensor triggering and pretensioner acting

lmtfrc (float) – Optional. Limiting force

Returns:

Pretensioner object

Return type:

dict

Example

To create a new pyrotechnic seatbelt pretensioner in model m with label 100, Retractor 10, :py:class:` Loading curve <Curve>` 20 and Sensor 30:
p = Oasys.PRIMER.Pretensioner(m, 100, 1, 10, 20, 30)

Static methods¶

classmethod Pretensioner.BlankAll(model, redraw=Oasys.gRPC.defaultArg)¶
Blanks all of the pretensioners in the model

Parameters:

model (Model) – Model that all pretensioners will be blanked in

redraw (boolean) – Optional. 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

Return type:

None

Example

To blank all of the pretensioners in model m:
Oasys.PRIMER.Pretensioner.BlankAll(m)
classmethod Pretensioner.BlankFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)¶
Blanks all of the flagged pretensioners in the model

Parameters:

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 (boolean) – Optional. 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

Return type:

None

Example

To blank all of the pretensioners in model m flagged with f:
Oasys.PRIMER.Pretensioner.BlankFlagged(m, f)
classmethod Pretensioner.Create(model, modal=Oasys.gRPC.defaultArg)¶
Starts an interactive editing panel to create a pretensioner

Parameters:

model (Model) – Model that the pretensioner will be created in

modal (boolean) – Optional. 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 None if not made)

Return type:

dict

Example

To start creating an pretensioner in model m:
p = Oasys.PRIMER.Pretensioner.Create(m)
classmethod Pretensioner.First(model)¶
Returns the first pretensioner in the model

Parameters:

model (Model) – Model to get first pretensioner in

Returns:

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

Return type:

Pretensioner

Example

To get the first pretensioner in model m:
p = Oasys.PRIMER.Pretensioner.First(m)
classmethod Pretensioner.FirstFreeLabel(model, layer=Oasys.gRPC.defaultArg)¶
Returns the first free pretensioner label in the model. Also see Pretensioner.LastFreeLabel(), Pretensioner.NextFreeLabel() and Model.FirstFreeItemLabel()

Parameters:

model (Model) – Model to get first free pretensioner label in

layer (Include number) – Optional. 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:

int

Example

To get the first free pretensioner label in model m:
label = Oasys.PRIMER.Pretensioner.FirstFreeLabel(m)
classmethod Pretensioner.FlagAll(model, flag)¶
Flags all of the pretensioners in the model with a defined flag

Parameters:

model (Model) – Model that all pretensioners will be flagged in

flag (Flag) – Flag to set on the pretensioners

Returns:

No return value

Return type:

None

Example

To flag all of the pretensioners with flag f in model m:
Oasys.PRIMER.Pretensioner.FlagAll(m, f)
classmethod Pretensioner.GetAll(model)¶
Returns a list of Pretensioner objects for all of the pretensioners in a model in PRIMER

Parameters:

model (Model) – Model to get pretensioners from

Returns:

List of Pretensioner objects

Return type:

list

Example

To make a list of Pretensioner objects for all of the pretensioners in model m
p = Oasys.PRIMER.Pretensioner.GetAll(m)
classmethod Pretensioner.GetFlagged(model, flag)¶
Returns a list of Pretensioner objects for all of the flagged pretensioners in a model in PRIMER

Parameters:

model (Model) – Model to get pretensioners from

flag (Flag) – Flag set on the pretensioners that you want to retrieve

Returns:

List of Pretensioner objects

Return type:

list

Example

To make a list of Pretensioner objects for all of the pretensioners in model m flagged with f
p = Oasys.PRIMER.Pretensioner.GetFlagged(m, f)
classmethod Pretensioner.GetFromID(model, number)¶
Returns the Pretensioner object for a pretensioner ID

Parameters:

model (Model) – Model to find the pretensioner in

number (integer) – number of the pretensioner you want the Pretensioner object for

Returns:

Pretensioner object (or None if pretensioner does not exist)

Return type:

Pretensioner

Example

To get the Pretensioner object for pretensioner 100 in model m
p = Oasys.PRIMER.Pretensioner.GetFromID(m, 100)
classmethod Pretensioner.Last(model)¶
Returns the last pretensioner in the model

Parameters:

model (Model) – Model to get last pretensioner in

Returns:

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

Return type:

Pretensioner

Example

To get the last pretensioner in model m:
p = Oasys.PRIMER.Pretensioner.Last(m)
classmethod Pretensioner.LastFreeLabel(model, layer=Oasys.gRPC.defaultArg)¶
Returns the last free pretensioner label in the model. Also see Pretensioner.FirstFreeLabel(), Pretensioner.NextFreeLabel() and see Model.LastFreeItemLabel()

Parameters:

model (Model) – Model to get last free pretensioner label in

layer (Include number) – Optional. 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:

int

Example

To get the last free pretensioner label in model m:
label = Oasys.PRIMER.Pretensioner.LastFreeLabel(m)
classmethod Pretensioner.NextFreeLabel(model, layer=Oasys.gRPC.defaultArg)¶
Returns the next free (highest+1) pretensioner label in the model. Also see Pretensioner.FirstFreeLabel(), Pretensioner.LastFreeLabel() and Model.NextFreeItemLabel()

Parameters:

model (Model) – Model to get next free pretensioner label in

layer (Include number) – Optional. 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:

int

Example

To get the next free pretensioner label in model m:
label = Oasys.PRIMER.Pretensioner.NextFreeLabel(m)
classmethod Pretensioner.Pick(prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg, button_text=Oasys.gRPC.defaultArg)¶
Allows the user to pick a pretensioner

Parameters:

prompt (string) – Text to display as a prompt to the user

limit (Model or Flag) – Optional. 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 None, any pretensioners from any model can be selected. from any model

modal (boolean) – Optional. 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 (string) – Optional. By default the window with the prompt will have a button labelled ‘Cancel’ which if pressed will cancel the pick and return None. If you want to change the text on the button use this argument. If omitted ‘Cancel’ will be used

Returns:

Pretensioner object (or None if not picked)

Return type:

dict

Example

To pick a pretensioner from model m giving the prompt ‘Pick pretensioner from screen’:
p = Oasys.PRIMER.Pretensioner.Pick('Pick pretensioner from screen', m)
classmethod Pretensioner.RenumberAll(model, start)¶
Renumbers all of the pretensioners in the model

Parameters:

model (Model) – Model that all pretensioners will be renumbered in

start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

To renumber all of the pretensioners in model m, from 1000000:
Oasys.PRIMER.Pretensioner.RenumberAll(m, 1000000)
classmethod Pretensioner.RenumberFlagged(model, flag, start)¶
Renumbers all of the flagged pretensioners in the model

Parameters:

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

Return type:

None

Example

To renumber all of the pretensioners in model m flagged with f, from 1000000:
Oasys.PRIMER.Pretensioner.RenumberFlagged(m, f, 1000000)
classmethod Pretensioner.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)¶
Allows the user to select pretensioners using standard PRIMER object menus

Parameters:

flag (Flag) – Flag to use when selecting pretensioners

prompt (string) – Text to display as a prompt to the user

limit (Model or Flag) – Optional. 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 None, any pretensioners can be selected. from any model

modal (boolean) – Optional. 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 None if menu cancelled

Return type:

int

Example

To select pretensioners from model m, flagging those selected with flag f, giving the prompt ‘Select pretensioners’:
Oasys.PRIMER.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’:
Oasys.PRIMER.Pretensioner.Select(f, 'Select pretensioners', l)
classmethod Pretensioner.SketchFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)¶
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

Parameters:

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 (boolean) – Optional. 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

Return type:

None

Example

To sketch all pretensioners flagged with flag in model m:
Oasys.PRIMER.Pretensioner.SketchFlagged(m, flag)
classmethod Pretensioner.Total(model, exists=Oasys.gRPC.defaultArg)¶
Returns the total number of pretensioners in the model

Parameters:

model (Model) – Model to get total for

exists (boolean) – Optional. 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:

int

Example

To get the total number of pretensioners in model m:
total = Oasys.PRIMER.Pretensioner.Total(m)
classmethod Pretensioner.UnblankAll(model, redraw=Oasys.gRPC.defaultArg)¶
Unblanks all of the pretensioners in the model

Parameters:

model (Model) – Model that all pretensioners will be unblanked in

redraw (boolean) – Optional. 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

Return type:

None

Example

To unblank all of the pretensioners in model m:
Oasys.PRIMER.Pretensioner.UnblankAll(m)
classmethod Pretensioner.UnblankFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)¶
Unblanks all of the flagged pretensioners in the model

Parameters:

model (Model) – Model that the flagged pretensioners will be unblanked in

flag (Flag) – Flag set on the pretensioners that you want to unblank

redraw (boolean) – Optional. 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

Return type:

None

Example

To unblank all of the pretensioners in model m flagged with f:
Oasys.PRIMER.Pretensioner.UnblankFlagged(m, f)
classmethod Pretensioner.UnflagAll(model, flag)¶
Unsets a defined flag on all of the pretensioners in the model

Parameters:

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

Return type:

None

Example

To unset the flag f on all the pretensioners in model m:
Oasys.PRIMER.Pretensioner.UnflagAll(m, f)
classmethod Pretensioner.UnsketchAll(model, redraw=Oasys.gRPC.defaultArg)¶
Unsketches all pretensioners

Parameters:

model (Model) – Model that all pretensioners will be unblanked in

redraw (boolean) – Optional. 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

Return type:

None

Example

To unsketch all pretensioners in model m:
Oasys.PRIMER.Pretensioner.UnsketchAll(m)
classmethod Pretensioner.UnsketchFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)¶
Unsketches all flagged pretensioners in the model

Parameters:

model (Model) – Model that all pretensioners will be unsketched in

flag (Flag) – Flag set on the pretensioners that you want to unsketch

redraw (boolean) – Optional. 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

Return type:

None

Example

To unsketch all pretensioners flagged with flag in model m:
Oasys.PRIMER.Pretensioner.UnsketchAll(m, flag)

Instance methods¶

Pretensioner.AssociateComment(comment)¶
Associates a comment with a pretensioner

Parameters:

comment (Comment) – Comment that will be attached to the pretensioner

Returns:

No return value

Return type:

None

Example

To associate comment c to the pretensioner p:
p.AssociateComment(c)
Pretensioner.Blank()¶
Blanks the pretensioner

Returns:

No return value

Return type:

None

Example

To blank pretensioner p:
p.Blank()
Pretensioner.Blanked()¶
Checks if the pretensioner is blanked or not

Returns:

True if blanked, False if not

Return type:

bool

Example

To check if pretensioner p is blanked:
if p.Blanked():
    do_something..
Pretensioner.Browse(modal=Oasys.gRPC.defaultArg)¶
Starts an edit panel in Browse mode

Parameters:

modal (boolean) – Optional. 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

Return type:

None

Example

To Browse pretensioner p:
p.Browse()
Pretensioner.ClearFlag(flag)¶
Clears a flag on the pretensioner

Parameters:

flag (Flag) – Flag to clear on the pretensioner

Returns:

No return value

Return type:

None

Example

To clear flag f for pretensioner p:
p.ClearFlag(f)
Pretensioner.Copy(range=Oasys.gRPC.defaultArg)¶
Copies the pretensioner. The target include of the copied pretensioner can be set using Options.copy_target_include

Parameters:

range (boolean) – Optional. 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:
z = p.Copy()
Pretensioner.DetachComment(comment)¶
Detaches a comment from a pretensioner

Parameters:

comment (Comment) – Comment that will be detached from the pretensioner

Returns:

No return value

Return type:

None

Example

To detach comment c from the pretensioner p:
p.DetachComment(c)
Pretensioner.Edit(modal=Oasys.gRPC.defaultArg)¶
Starts an interactive editing panel

Parameters:

modal (boolean) – Optional. 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

Return type:

None

Example

To Edit pretensioner p:
p.Edit()
Pretensioner.ExtractColour()¶
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

Returns:

colour value (integer)

Return type:

int

Example

To return the colour used for drawing pretensioner p:
colour = p.ExtractColour()
Pretensioner.Flagged(flag)¶
Checks if the pretensioner is flagged or not

Parameters:

flag (Flag) – Flag to test on the pretensioner

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if pretensioner p has flag f set on it:
if p.Flagged(f):
    do_something..
Pretensioner.GetComments()¶
Extracts the comments associated to a pretensioner

Returns:

List of Comment objects (or None if there are no comments associated to the node)

Return type:

list

Example

To get the list of comments associated to the pretensioner p:
comm_list = p.GetComments()
Pretensioner.GetParameter(prop)¶
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)

Parameters:

prop (string) – pretensioner property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

dict

Example

To check if Pretensioner property p.example is a parameter:
Oasys.PRIMER.Options.property_parameter_names = True
if p.GetParameter(p.example):
    do_something...
Oasys.PRIMER.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..
Pretensioner.Keyword()¶
Returns the keyword for this pretensioner (*ELEMENT_SEATBELT_PRETEROMETER) Note that a carriage return is not added. See also Pretensioner.KeywordCards()

Returns:

string containing the keyword

Return type:

str

Example

To get the keyword for pretensioner p:
key = p.Keyword()
Pretensioner.KeywordCards()¶
Returns the keyword cards for the pretensioner. Note that a carriage return is not added. See also Pretensioner.Keyword()

Returns:

string containing the cards

Return type:

str

Example

To get the cards for pretensioner a:
cards = a.KeywordCards()
Pretensioner.Next()¶
Returns the next pretensioner in the model

Returns:

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

Return type:

Pretensioner

Example

To get the pretensioner in model m after pretensioner p:
p = p.Next()
Pretensioner.Previous()¶
Returns the previous pretensioner in the model

Returns:

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

Return type:

Pretensioner

Example

To get the pretensioner in model m before pretensioner p:
p = p.Previous()
Pretensioner.SetFlag(flag)¶
Sets a flag on the pretensioner

Parameters:

flag (Flag) – Flag to set on the pretensioner

Returns:

No return value

Return type:

None

Example

To set flag f for pretensioner p:
p.SetFlag(f)
Pretensioner.Sketch(redraw=Oasys.gRPC.defaultArg)¶
Sketches the pretensioner. The pretensioner will be sketched until you either call Pretensioner.Unsketch(), Pretensioner.UnsketchAll(), Model.UnsketchAll(), or delete the model

Parameters:

redraw (boolean) – Optional. 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

Return type:

None

Example

To sketch pretensioner p:
p.Sketch()
Pretensioner.Unblank()¶
Unblanks the pretensioner

Returns:

No return value

Return type:

None

Example

To unblank pretensioner p:
p.Unblank()
Pretensioner.Unsketch(redraw=Oasys.gRPC.defaultArg)¶
Unsketches the pretensioner

Parameters:

redraw (boolean) – Optional. 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

Return type:

None

Example

To unsketch pretensioner p:
p.Unsketch()
Pretensioner.ViewParameters()¶
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

Returns:

Pretensioner object

Return type:

dict

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..
Pretensioner.Xrefs()¶
Returns the cross references for this pretensioner

Returns:

Xrefs object

Return type:

dict

Example

To get the cross references for pretensioner p:
xrefs = p.Xrefs()