InterpolationSpotweld (Spr3) class

The InterpolationSpotweld class gives you access to constrained Interpolation Spotweld (spr3) 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:

_example
$example
ABC_example

Class functions

BlankAll(Model[Model], redraw (optional)[boolean])
BlankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean])
First(Model[Model])
FlagAll(Model[Model], flag[Flag])
ForEach(Model[Model], func[function], extra (optional)[any])
GetAll(Model[Model], property (optional)[string])
GetFlagged(Model[Model], flag[Flag], property (optional)[string])
GetFromID(Model[Model], number[integer])
Last(Model[Model])
Pick(prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean], button text (optional)[string])
Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean])
SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean])
Total(Model[Model], exists (optional)[boolean])
UnblankAll(Model[Model], redraw (optional)[boolean])
UnblankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean])
UnflagAll(Model[Model], flag[Flag])
UnsketchAll(Model[Model], redraw (optional)[boolean])
UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean])

Member functions

AssociateComment(Comment[Comment])
Blank()
Blanked()
ClearFlag(flag[Flag])
Copy(range (optional)[boolean])
DetachComment(Comment[Comment])
Error(message[string], details (optional)[string])
Flagged(flag[Flag])
GetComments()
GetParameter(prop[string])
Keyword()
KeywordCards()
Next()
Previous()
SetFlag(flag[Flag])
Sketch(redraw (optional)[boolean])
Unblank()
Unsketch(redraw (optional)[boolean])
ViewParameters()
Warning(message[string], details (optional)[string])
Xrefs()
toString()

InterpolationSpotweld constants

Constants for Flags for Interpolation

Name	Description
InterpolationSpotweld.INVERSE	Property INTP value EQ.2.0: Inverse distance weighting.
InterpolationSpotweld.LINEAR	Property INTP value EQ.0.0: Linear (default).
InterpolationSpotweld.UNIFORM	Property INTP value EQ.1.0: Uniform.

Constants for Material behaviour and damage model

Name	Description
InterpolationSpotweld.SPR3	SPR3 (default)
InterpolationSpotweld.SPR3_MAT_PARAM	SPR3 with selected material parameters as functions
InterpolationSpotweld.SPR3_MAT_PARAM_MOD	SPR3 with selected material parameters as functions and slight modification
InterpolationSpotweld.SPR4	SPR4
InterpolationSpotweld.SPR4_MAT_PARAM	SPR4 with selected material parameters as functions
InterpolationSpotweld.SPR4_MAT_PARAM_MOD	SPR4 with selected material parameters as functions and slight modification

InterpolationSpotweld properties

Name	Type	Description
alpha1	real/integer	Scaling factor alpha 1. Function ID if MODEL > 10.
alpha2	real	Plastic initiation displacement scaling factor alpha2.
alpha3	real	Plastic initiation displacement scaling factor alpha3.
bdmodel	real	Material behaviour and damage model. Values can be InterpolationSpotweld.SPR3, InterpolationSpotweld.SPR4, InterpolationSpotweld.SPR3_MAT_PARAM, InterpolationSpotweld.SPR4_MAT_PARAM, InterpolationSpotweld.SPR3_MAT_PARAM_MOD or InterpolationSpotweld.SPR4_MAT_PARAM_MOD
beta	real	Exponent for plastic potential beta 1. Function ID if bdmodel > 10.
beta2	real	Exponent for plastic initiation displacement beta2.
beta3	real	Exponent for plastic initiation displacement beta3.
defc	real	Fading energy for damage. Function ID if bdmodel > 30.
dens	real	Spotweld density (necessary for time step calculation).
exfc	real	Failure function exponent. Function ID if bdmodel > 30.
exists (read only)	logical	true if interpolation spotweld exists, false if referred to but not defined.
ffb	real	Resultant bending force at failure. Function ID if bdmodel > 30.
ffn	real	Resultant normal force at failure. Function ID if bdmodel > 30.
ffs	real	Resultant shear force at failure. Function ID if bdmodel > 30.
gamma	real	Scaling factor. Function ID if bdmodel > 30.
heading	string	Title
include	integer	The Include file number that the interpolation spotweld is in.
intp	real	Flag for interpolation. Values can be InterpolationSpotweld.LINEAR, InterpolationSpotweld.UNIFORM or InterpolationSpotweld.INVERSE.
lcdexp	integer	Load curve ID for damage exponent vs. mode mixity
lcf	integer	Load curve ID describing force versus plastic displacement.
lcupf	integer	Load curve ID describing plastic initiation displacement versus mode mixity. Required only for material behaviour and damage models InterpolationSpotweld.SPR3, InterpolationSpotweld.SPR3_MAT_PARAM or InterpolationSpotweld.SPR3_MAT_PARAM_MOD.
lcupr	integer	Load curve ID describing plastic rupture displacement versus mode mixity. Required only for material behaviour and damage models InterpolationSpotweld.SPR3, InterpolationSpotweld.SPR3_MAT_PARAM or InterpolationSpotweld.SPR3_MAT_PARAM_MOD.
mfsfc	real	Scaling factor for torsion term in resultant shear force. Function ID if bdmodel > 30.
model (read only)	integer	The Model number that the interpolation spotweld is in.
mrn	real	Proportionality factor for dependency RN.
mrs	real	Proportionality factor for dependency RS.
npfc	real	Plastic displacement offset for damage initiation. Function ID if bdmodel > 30.
nsid	integer	Node Set ID of spotweld location nodes.
pid1	integer	Part ID of first sheet.
pid2	integer	Part ID
pidvb	real	Part ID for visualization beams representing SPR3 in post-processing.
r	real	Spotweld Radius.
rn	real/integer	Tensile strength factor or negative Load curve with ID giving as a function of peel ratio . Function ID if MODEL > 10.
rs	real	Shear strength factor. Function ID if bdmodel > 10.
scarn	real	Scale factor for tensile strength factor RN
scars	real	Scale factor for tensile strength factor RS
sropt	real	Shear rotation option.
stiff	real/integer	Elastic stiffness OR material ID if less than 0. Function ID if MODEL > 10.
stiff2	real	Elastic shear stiffness. Function ID if bdmodel > 30.
stiff3	real	Elastic bending stiffness. Function ID if bdmodel > 30.
stiff4	real	Elastic torsional stiffness. Function ID if bdmodel > 30.
stifp	real	Plastic stiffness. Function ID if bdmodel > 30.
thick	real	Total thickness of both sheets.
upfn	real	Plastic initiation displacement in normal direction.
upfs	real	Plastic initiation displacement in shear direction.
uprn	real	Plastic rupture displacement in normal direction.
uprs	real	Plastic rupture displacement in shear direction.

Detailed Description

The InterpolationSpotweld class allows you to create, modify, edit and manipulate constrained interpolation spotweld (spr3) cards. See the documentation below for more details.

For convenience "Spr3" can also be used as the class name instead of "InterpolationSpotweld".

Constructor

new InterpolationSpotweld(Model[Model], pid1[integer], pid2[integer], nsid[integer], heading (optional)[string])

Description

Create a new InterpolationSpotweld object.

Arguments

Model (Model)

Model that constrained interpolation spotweld will be created in

pid1 (integer)

Part ID of first sheet.

pid2 (integer)

Part ID of second sheet.

nsid (integer)

Node Set ID of spotweld location nodes.

heading (optional) (string)

Title for the constrained interpolation spotweld

Returns

InterpolationSpotweld object

Return type

InterpolationSpotweld

Example

To create a new constrained interpolation spotweld in model m with first sheet 100, second sheet 200 and spotweld node set 100

var s = new InterpolationSpotweld(m, 100, 200, 100);

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a interpolation spotweld.

Arguments

Comment (Comment)

Comment that will be attached to the interpolation spotweld

Returns

No return value

Example

To associate comment c to the interpolation spotweld s:

s.AssociateComment(c);

Blank()

Description

Blanks the interpolation spotweld

Arguments

No arguments

Returns

No return value

Example

To blank interpolation spotweld s:

s.Blank();

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

Description

Blanks all of the interpolation spotwelds in the model.

Arguments

Model (Model)

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

InterpolationSpotweld.BlankAll(m);

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

Description

Blanks all of the flagged interpolation spotwelds in the model.

Arguments

Model (Model)

Model that all the flagged interpolation spotwelds will be blanked in

flag (Flag)

Flag set on the interpolation spotwelds that you want to blank

redraw (optional) (boolean)

Returns

No return value

Example

To blank all of the interpolation spotwelds in model m flagged with f:

InterpolationSpotweld.BlankFlagged(m, f);

Blanked()

Description

Checks if the interpolation spotweld is blanked or not.

Arguments

No arguments

Returns

true if blanked, false if not.

Return type

Boolean

Example

To check if interpolation spotweld s is blanked:

if (s.Blanked() ) do_something...

ClearFlag(flag[Flag])

Description

Clears a flag on the interpolation spotweld.

Arguments

flag (Flag)

Flag to clear on the interpolation spotweld

Returns

No return value

Example

To clear flag f for interpolation spotweld s:

s.ClearFlag(f);

Copy(range (optional)[boolean])

Description

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

InterpolationSpotweld object

Return type

InterpolationSpotweld

Example

To copy interpolation spotweld s into interpolation spotweld z:

var z = s.Copy();

DetachComment(Comment[Comment])

Description

Detaches a comment from a interpolation spotweld.

Arguments

Comment (Comment)

Comment that will be detached from the interpolation spotweld

Returns

No return value

Example

To detach comment c from the interpolation spotweld s:

s.DetachComment(c);

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

Description

Adds an error for interpolation spotweld. 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 interpolation spotweld s:

s.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first interpolation spotweld in the model.

Arguments

Model (Model)

Model to get first interpolation spotweld in

Returns

InterpolationSpotweld object (or null if there are no interpolation spotwelds in the model).

Return type

InterpolationSpotweld

Example

To get the first interpolation spotweld in model m:

var s = InterpolationSpotweld.First(m);

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

Description

Flags all of the interpolation spotwelds in the model with a defined flag.

Arguments

Model (Model)

Model that all interpolation spotwelds will be flagged in

flag (Flag)

Flag to set on the interpolation spotwelds

Returns

No return value

Example

To flag all of the interpolation spotwelds with flag f in model m:

InterpolationSpotweld.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the interpolation spotweld is flagged or not.

Arguments

flag (Flag)

Flag to test on the interpolation spotweld

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if interpolation spotweld s has flag f set on it:

if (s.Flagged(f) ) do_something...

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

Description

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

Arguments

Model (Model)

Model that all interpolation spotwelds are in

func (function)

Function to call for each interpolation spotweld

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 interpolation spotwelds in model m:

InterpolationSpotweld.ForEach(m, test);
function test(s)
{
// s is InterpolationSpotweld object
}

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

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

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

Description

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

Arguments

Model (Model)

Model to get interpolation spotwelds from

property (optional) (string)

Name for property to get for all interpolation spotwelds in the model

Returns

Array of InterpolationSpotweld objects or properties

Return type

Array

Example

To make an array of InterpolationSpotweld objects for all of the interpolation spotwelds in model m:

var a = InterpolationSpotweld.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a interpolation spotweld.

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 interpolation spotweld s:

var comm_array = s.GetComments();

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

Description

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

Arguments

Model (Model)

Model to get interpolation spotwelds from

flag (Flag)

Flag set on the interpolation spotwelds that you want to retrieve

property (optional) (string)

Name for property to get for all flagged interpolation spotwelds in the model

Returns

Array of InterpolationSpotweld objects or properties

Return type

Array

Example

To make an array of InterpolationSpotweld objects for all of the interpolation spotwelds in model m flagged with f:

var s = InterpolationSpotweld.GetFlagged(m, f);

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

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

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

Description

Returns the InterpolationSpotweld object for a interpolation spotweld ID.

Arguments

Model (Model)

Model to find the interpolation spotweld in

number (integer)

number of the interpolation spotweld you want the InterpolationSpotweld object for

Returns

InterpolationSpotweld object (or null if interpolation spotweld does not exist).

Return type

InterpolationSpotweld

Example

To get the InterpolationSpotweld object for interpolation spotweld 100 in model m

var s = InterpolationSpotweld.GetFromID(m, 100);

GetParameter(prop[string])

Description

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

Arguments

prop (string)

interpolation spotweld property to get parameter for

Returns

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

Return type

Parameter

Example

To check if InterpolationSpotweld property s.example is a parameter:

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

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

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

Keyword()

Description

Returns the keyword for this interpolation spotweld (*CONSTRAINED_INTERPOLATION_SPOTWELD). Note that a carriage return is not added. See also InterpolationSpotweld.KeywordCards()

Arguments

No arguments

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for interpolation spotweld s:

var key = s.Keyword();

KeywordCards()

Description

Returns the keyword cards for the interpolation spotweld. Note that a carriage return is not added. See also InterpolationSpotweld.Keyword()

Arguments

No arguments

Returns

string containing the cards.

Return type

String

Example

To get the cards for interpolation spotweld s:

var cards = s.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last interpolation spotweld in the model.

Arguments

Model (Model)

Model to get last interpolation spotweld in

Returns

InterpolationSpotweld object (or null if there are no interpolation spotwelds in the model).

Return type

InterpolationSpotweld

Example

To get the last interpolation spotweld in model m:

var s = InterpolationSpotweld.Last(m);

Next()

Description

Returns the next interpolation spotweld in the model.

Arguments

No arguments

Returns

InterpolationSpotweld object (or null if there are no more interpolation spotwelds in the model).

Return type

InterpolationSpotweld

Example

To get the interpolation spotweld in model m after interpolation spotweld s:

var s = s.Next();

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

Description

Allows the user to pick a interpolation spotweld.

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

InterpolationSpotweld object (or null if not picked)

Return type

InterpolationSpotweld

Example

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

var s = InterpolationSpotweld.Pick('Pick interpolation spotweld from screen', m);

Previous()

Description

Returns the previous interpolation spotweld in the model.

Arguments

No arguments

Returns

InterpolationSpotweld object (or null if there are no more interpolation spotwelds in the model).

Return type

InterpolationSpotweld

Example

To get the interpolation spotweld in model m before interpolation spotweld s:

var s = s.Previous();

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

Description

Allows the user to select interpolation spotwelds using standard PRIMER object menus.

Arguments

flag (Flag)

Flag to use when selecting interpolation spotwelds

prompt (string)

Text to display as a prompt to the user

limit (optional) (Model or Flag)

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

Return type

Number

Example

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

InterpolationSpotweld.Select(f, 'Select interpolation spotwelds', m);

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

InterpolationSpotweld.Select(f, 'Select interpolation spotwelds', l);

SetFlag(flag[Flag])

Description

Sets a flag on the interpolation spotweld.

Arguments

flag (Flag)

Flag to set on the interpolation spotweld

Returns

No return value

Example

To set flag f for interpolation spotweld s:

s.SetFlag(f);

Sketch(redraw (optional)[boolean])

Description

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

Arguments

redraw (optional) (boolean)

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

Returns

No return value

Example

To sketch interpolation spotweld s:

s.Sketch();

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

Description

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

Arguments

Model (Model)

Model that all the flagged interpolation spotwelds will be sketched in

flag (Flag)

Flag set on the interpolation spotwelds that you want to sketch

redraw (optional) (boolean)

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

InterpolationSpotweld.SketchFlagged(m, flag);

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

Description

Returns the total number of interpolation spotwelds in the model.

Arguments

Model (Model)

Model to get total for

exists (optional) (boolean)

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

Returns

number of interpolation spotwelds

Return type

Number

Example

To get the total number of interpolation spotwelds in model m:

var total = InterpolationSpotweld.Total(m);

Unblank()

Description

Unblanks the interpolation spotweld

Arguments

No arguments

Returns

No return value

Example

To unblank interpolation spotweld s:

s.Unblank();

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

Description

Unblanks all of the interpolation spotwelds in the model.

Arguments

Model (Model)

Model that all interpolation spotwelds will be unblanked in

redraw (optional) (boolean)

Returns

No return value

Example

To unblank all of the interpolation spotwelds in model m:

InterpolationSpotweld.UnblankAll(m);

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

Description

Unblanks all of the flagged interpolation spotwelds in the model.

Arguments

Model (Model)

Model that the flagged interpolation spotwelds will be unblanked in

flag (Flag)

Flag set on the interpolation spotwelds that you want to unblank

redraw (optional) (boolean)

Returns

No return value

Example

To unblank all of the interpolation spotwelds in model m flagged with f:

InterpolationSpotweld.UnblankFlagged(m, f);

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

Description

Unsets a defined flag on all of the interpolation spotwelds in the model.

Arguments

Model (Model)

Model that the defined flag for all interpolation spotwelds will be unset in

flag (Flag)

Flag to unset on the interpolation spotwelds

Returns

No return value

Example

To unset the flag f on all the interpolation spotwelds in model m:

InterpolationSpotweld.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the interpolation spotweld.

Arguments

redraw (optional) (boolean)

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

Returns

No return value

Example

To unsketch interpolation spotweld s:

s.Unsketch();

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

Description

Unsketches all interpolation spotwelds.

Arguments

Model (Model)

Model that all interpolation spotwelds will be unblanked in

redraw (optional) (boolean)

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

InterpolationSpotweld.UnsketchAll(m);

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

Description

Unsketches all flagged interpolation spotwelds in the model.

Arguments

Model (Model)

Model that all interpolation spotwelds will be unsketched in

flag (Flag)

Flag set on the interpolation spotwelds that you want to unsketch

redraw (optional) (boolean)

Returns

No return value

Example

To unsketch all interpolation spotwelds flagged with flag in model m:

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

InterpolationSpotweld object.

Return type

InterpolationSpotweld

Example

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

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

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

Description

Adds a warning for interpolation spotweld. 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 interpolation spotweld s:

s.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this interpolation spotweld.

Arguments

No arguments

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for interpolation spotweld s:

var xrefs = s.Xrefs();

toString()

Description

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

Arguments

No arguments

Returns

string

Return type

String

Example

To get data for interpolation spotweld s in keyword format

var str = s.toString();