Spotweld class

The Spotweld class gives you access to constrained spotweld 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

Spotweld properties

Name Type Description
colour Colour The colour of the spotweld
ep real Effective plastic strain at failure
exists (read only) logical true if spotweld exists, false if referred to but not defined.
filtered_force logical true if _FILTERED_FORCE option is set, false if not
id logical true if _ID option is set, false if not
include integer The Include file number that the spotweld is in.
label integer Constrained spotweld number
m real Exponent for shear spotweld force
model (read only) integer The Model number that the spotweld is in.
n real Exponent for normal spotweld force
n1 integer Node ID
n2 integer Node ID
nf integer Number of force vectors stored for filtering
sn real Normal force at spotweld failure
ss real Shear force at spotweld failure
tf real Failure time for nodal constraint set
tw real Time window for filtering
wid integer Constrained spotweld number (identical to label)

Detailed Description

The Spotweld class allows you to create, modify, edit and manipulate constrained spotweld cards. See the documentation below for more details.

Constructor

new Spotweld(Model[Model], n1[integer], n2[integer], label (optional)[integer])

Description

Create a new Spotweld object.

Arguments

  • Model (Model)

    Model that constrained spotweld will be created in

  • n1 (integer)

    Node ID 1

  • n2 (integer)

    Node ID 2

  • label (optional) (integer)

    Constrained spotweld number

    Returns

    Spotweld object

    Return type

    Spotweld

    Example

    To create a new constrained spotweld 500 in model m between nodes 10 and 11 

    var s = new Spotweld(m, 10, 11, 500);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a spotweld.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the spotweld

    Returns

    No return value

    Example

    To associate comment c to the spotweld s: 

    s.AssociateComment(c);

    Blank()

    Description

    Blanks the spotweld

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank spotweld s: 

    s.Blank();

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

    Description

    Blanks all of the spotwelds in the model.

    Arguments

  • Model (Model)

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

    Spotweld.BlankAll(m);

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

    Description

    Blanks all of the flagged spotwelds in the model.

    Arguments

  • Model (Model)

    Model that all the flagged spotwelds will be blanked in

  • flag (Flag)

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

    Spotweld.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the spotweld is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if spotweld s is blanked: 

    if (s.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 spotweld s: 

    s.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the spotweld.

    Arguments

  • flag (Flag)

    Flag to clear on the spotweld

    Returns

    No return value

    Example

    To clear flag f for spotweld s: 

    s.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    Spotweld object

    Return type

    Spotweld

    Example

    To copy spotweld s into spotweld z: 

    var z = s.Copy();

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

    Description

    Starts an interactive editing panel to create a spotweld

    Arguments

  • Model (Model)

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

    Spotweld object (or null if not made).

    Return type

    Spotweld

    Example

    To start creating a spotweld in model m: 

    var s = Spotweld.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a spotweld.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the spotweld

    Returns

    No return value

    Example

    To detach comment c from the spotweld s: 

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

    s.Edit();

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

    Description

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

    s.Error("My custom error");

    ExtractColour()

    Description

    Extracts the actual colour used for spotweld.
    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 spotweld 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 spotweld.

    Arguments

    No arguments

    Returns

    colour value (integer)

    Return type

    Number

    Example

    To return the colour used for drawing spotweld s: 

    var colour = s.ExtractColour();

    First(Model[Model]) [static]

    Description

    Returns the first spotweld in the model.

    Arguments

  • Model (Model)

    Model to get first spotweld in

    Returns

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

    Return type

    Spotweld

    Example

    To get the first spotweld in model m: 

    var s = Spotweld.First(m);

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

    Description

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

    Arguments

  • Model (Model)

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

    Spotweld label.

    Return type

    Number

    Example

    To get the first free spotweld label in model m: 

    var label = Spotweld.FirstFreeLabel(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all spotwelds will be flagged in

  • flag (Flag)

    Flag to set on the spotwelds

    Returns

    No return value

    Example

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

    Spotweld.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the spotweld is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the spotweld

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

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

    Arguments

  • Model (Model)

    Model that all spotwelds are in

  • func (function)

    Function to call for each 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 spotwelds in model m: 

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

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get spotwelds from

  • property (optional) (string)

    Name for property to get for all spotwelds in the model

    Returns

    Array of Spotweld objects or properties

    Return type

    Array

    Example

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

    var a = Spotweld.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a 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 spotweld s: 

    var comm_array = s.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get spotwelds from

  • flag (Flag)

    Flag set on the spotwelds that you want to retrieve

  • property (optional) (string)

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

    Returns

    Array of Spotweld objects or properties

    Return type

    Array

    Example

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

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

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

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

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

    Description

    Returns the Spotweld object for a spotweld ID.

    Arguments

  • Model (Model)

    Model to find the spotweld in

  • number (integer)

    number of the spotweld you want the Spotweld object for

    Returns

    Spotweld object (or null if spotweld does not exist).

    Return type

    Spotweld

    Example

    To get the Spotweld object for spotweld 100 in model m 

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

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    spotweld property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if Spotweld 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 Spotweld 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 spotweld (*CONSTRAINED_SPOTWELD). Note that a carriage return is not added. See also Spotweld.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for spotweld s: 

    var key = s.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for spotweld s: 

    var cards = s.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last spotweld in the model.

    Arguments

  • Model (Model)

    Model to get last spotweld in

    Returns

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

    Return type

    Spotweld

    Example

    To get the last spotweld in model m: 

    var s = Spotweld.Last(m);

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

    Description

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

    Arguments

  • Model (Model)

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

    Spotweld label.

    Return type

    Number

    Example

    To get the last free spotweld label in model m: 

    var label = Spotweld.LastFreeLabel(m);

    Next()

    Description

    Returns the next spotweld in the model.

    Arguments

    No arguments

    Returns

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

    Return type

    Spotweld

    Example

    To get the spotweld in model m after spotweld s: 

    var s = s.Next();

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

    Description

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

    Arguments

  • Model (Model)

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

    Spotweld label.

    Return type

    Number

    Example

    To get the next free spotweld label in model m: 

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

    Spotweld object (or null if not picked)

    Return type

    Spotweld

    Example

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

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

    Previous()

    Description

    Returns the previous spotweld in the model.

    Arguments

    No arguments

    Returns

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

    Return type

    Spotweld

    Example

    To get the spotweld in model m before spotweld s: 

    var s = s.Previous();

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

    Description

    Renumbers all of the spotwelds in the model.

    Arguments

  • Model (Model)

    Model that all spotwelds will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Spotweld.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged spotwelds in the model.

    Arguments

  • Model (Model)

    Model that all the flagged spotwelds will be renumbered in

  • flag (Flag)

    Flag set on the spotwelds that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Spotweld.RenumberFlagged(m, f, 1000000);

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

    Description

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

    Arguments

  • flag (Flag)

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

    Return type

    Number

    Example

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

    Spotweld.Select(f, 'Select spotwelds', m);

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

    Spotweld.Select(f, 'Select spotwelds', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the spotweld.

    Arguments

  • flag (Flag)

    Flag to set on the spotweld

    Returns

    No return value

    Example

    To set flag f for spotweld s: 

    s.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch spotweld s: 

    s.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged spotwelds will be sketched in

  • flag (Flag)

    Flag set on the spotwelds that you want to sketch

  • redraw (optional) (boolean)

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

    Spotweld.SketchFlagged(m, flag);

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

    Description

    Returns the total number of spotwelds in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of spotwelds

    Return type

    Number

    Example

    To get the total number of spotwelds in model m: 

    var total = Spotweld.Total(m);

    Unblank()

    Description

    Unblanks the spotweld

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank spotweld s: 

    s.Unblank();

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

    Description

    Unblanks all of the spotwelds in the model.

    Arguments

  • Model (Model)

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

    Spotweld.UnblankAll(m);

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

    Description

    Unblanks all of the flagged spotwelds in the model.

    Arguments

  • Model (Model)

    Model that the flagged spotwelds will be unblanked in

  • flag (Flag)

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

    Spotweld.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the spotwelds

    Returns

    No return value

    Example

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

    Spotweld.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the spotweld.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch spotweld s: 

    s.Unsketch();

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

    Description

    Unsketches all spotwelds.

    Arguments

  • Model (Model)

    Model that all spotwelds will be unblanked in

  • redraw (optional) (boolean)

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

    Spotweld.UnsketchAll(m);

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

    Description

    Unsketches all flagged spotwelds in the model.

    Arguments

  • Model (Model)

    Model that all spotwelds will be unsketched in

  • flag (Flag)

    Flag set on the spotwelds that you want to unsketch

  • redraw (optional) (boolean)

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

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

    Spotweld object.

    Return type

    Spotweld

    Example

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

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

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

    Description

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

    s.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this spotweld.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for spotweld s: 

    var xrefs = s.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for spotweld s in keyword format 

    var str = s.toString();