HexSpotweldAssembly class

The HexSpotweldAssembly class gives you access to *DEFINE_HEX_SPOTWELD_ASSEMBLY 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

HexSpotweldAssembly properties

Name Type Description
eid1 integer EID 1
eid10 integer EID 10
eid11 integer EID 11
eid12 integer EID 12
eid13 integer EID 13
eid14 integer EID 14
eid15 integer EID 15
eid16 integer EID 16
eid2 integer EID 2
eid3 integer EID 3
eid4 integer EID 4
eid5 integer EID 5
eid6 integer EID 6
eid7 integer EID 7
eid8 integer EID 8
eid9 integer EID 9
exists (read only) logical true if DEFINE_HEX_SPOTWELD_ASSEMBLY exists, false if referred to but not defined.
id integer *DEFINE_HEX_SPOTWELD_ASSEMBLY id
include integer The Include file number that the DEFINE_HEX_SPOTWELD_ASSEMBLY is in.
model (read only) integer The Model number that the DEFINE_HEX_SPOTWELD_ASSEMBLY is in.
opt integer *DEFINE_HEX_SPOTWELD_ASSEMBLY opt
title string Title (optional)

Detailed Description

The HexSpotweldAssembly class allows you to create, modify, edit and manipulate *DEFINE_HEX_SPOTWELD_ASSEMBLY cards. See the documentation below for more details.

Constructor

new HexSpotweldAssembly(Model[Model], options [object])

Description

Create a new *DEFINE_HEX_SPOTWELD_ASSEMBLY object.

Arguments

  • Model (Model)

    Model that Hex Spotweld Assembly will be created in

  • options (object)

    Options for creating the HexSpotweldAssembly

    Object has the following properties:

    Name Type Description
    id integer HexSpotweldAssembly ID.
    opt integer HexSpotweldAssembly option indicating the length of the solids array. opt can be 4, 8 or 16.
    solids array Array of Solid IDs, at least 4 EIDs must be given.
    title (optional) string Optional HexSpotweldAssembly title.

    Returns

    HexSpotweldAssembly object

    Return type

    HexSpotweldAssembly

    Example

    To create a new *DEFINE_HEX_SPOTWELD_ASSEMBLY with ID 100 in model m with 4 elements 50, 150, 250 and 350 

    var h = new HexSpotweldAssembly(m, {id: 100, opt: 4, solids: [50, 150, 250, 350]});

    To create a new *DEFINE_HEX_SPOTWELD_ASSEMBLY with ID 200 in model m with 8 elements 50, 150, 250, 350, 450, 550, 650 and 750 

    var h = new HexSpotweldAssembly(m, {id: 200, opt: 8, solids: [50, 150, 250, 350, 450, 550, 650, 750]});

    To create a new *DEFINE_HEX_SPOTWELD_ASSEMBLY with ID 300 in model m with 16 elements 50, 150, 250, 350, 450, 550, 650, 750, 850, 950, 1050, 1150, 1250, 1350, 1450 and 1550 

    var h = new HexSpotweldAssembly(m, {id: 300, opt: 16, solids: [50, 150, 250, 350, 450, 550, 650, 750, 850, 950, 1050, 1150, 1250, 1350, 1450, 1550]});

    new HexSpotweldAssembly(Model[Model], id[integer], opt[integer], eid1[integer], eid2[integer], eid3[integer], eid4[integer], title (optional)[string])   [deprecated]

    This function is deprecated in version 21.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

    Description

    Create a new *DEFINE_HEX_SPOTWELD_ASSEMBLY object.

    Arguments

  • Model (Model)

    Model that Hex Spotweld Assembly will be created in

  • id (integer)

    *DEFINE_HEX_SPOTWELD_ASSEMBLY id_sw.

  • opt (integer)

    *DEFINE_HEX_SPOTWELD_ASSEMBLY opt can be 4, 8 or 16

  • eid1 (integer)

    EID 1.

  • eid2 (integer)

    EID 2.

  • eid3 (integer)

    EID 3.

  • eid4 (integer)

    EID 4.

  • title (optional) (string)

    Define hex spotweld assembly title.

    Returns

    HexSpotweldAssembly object

    Return type

    HexSpotweldAssembly

    Example

    To create a new *DEFINE_HEX_SPOTWELD_ASSEMBLY with ID 100 in model m with 4 elements 50, 150, 250 and 350 

    var h = new HexSpotweldAssembly(m, 100, 4, 50, 150, 250, 350);

    new HexSpotweldAssembly(Model[Model], id[integer], opt[integer], eid1[integer], eid2[integer], eid3[integer], eid4[integer], eid5[integer], eid6[integer], eid7[integer], eid8[integer], title (optional)[string])   [deprecated]

    This function is deprecated in version 21.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

    Description

    Create a new *DEFINE_HEX_SPOTWELD_ASSEMBLY object.

    Arguments

  • Model (Model)

    Model that Hex Spotweld Assembly will be created in

  • id (integer)

    *DEFINE_HEX_SPOTWELD_ASSEMBLY id.

  • opt (integer)

    *DEFINE_HEX_SPOTWELD_ASSEMBLY opt can be 4, 8 or 16

  • eid1 (integer)

    EID 1.

  • eid2 (integer)

    EID 2.

  • eid3 (integer)

    EID 3.

  • eid4 (integer)

    EID 4.

  • eid5 (integer)

    EID 5.

  • eid6 (integer)

    EID 6.

  • eid7 (integer)

    EID 7.

  • eid8 (integer)

    EID 8.

  • title (optional) (string)

    Define hex spotweld assembly title.

    Returns

    HexSpotweldAssembly object

    Return type

    HexSpotweldAssembly

    Example

    To create a new *DEFINE_HEX_SPOTWELD_ASSEMBLY with ID 100 in model m with 8 elements 50, 150, 250, 350, 450, 550, 650 and 750 

    var h = new HexSpotweldAssembly(m, 100, 8, 50, 150, 250, 350, 450, 550, 650, 750);

    new HexSpotweldAssembly(Model[Model], id[integer], opt[integer], eid1[integer], eid2[integer], eid3[integer], eid4[integer], eid5[integer], eid6[integer], eid7[integer], eid8[integer], eid9[integer], eid10[integer], eid11[integer], eid12[integer], eid13[integer], eid14[integer], eid15[integer], eid16[integer], title (optional)[string])   [deprecated]

    This function is deprecated in version 21.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

    Description

    Create a new *DEFINE_HEX_SPOTWELD_ASSEMBLY object.

    Arguments

  • Model (Model)

    Model that Hex Spotweld Assembly will be created in

  • id (integer)

    *DEFINE_HEX_SPOTWELD_ASSEMBLY id.

  • opt (integer)

    *DEFINE_HEX_SPOTWELD_ASSEMBLY opt can be 4, 8 or 16

  • eid1 (integer)

    EID 1.

  • eid2 (integer)

    EID 2.

  • eid3 (integer)

    EID 3.

  • eid4 (integer)

    EID 4.

  • eid5 (integer)

    EID 5.

  • eid6 (integer)

    EID 6.

  • eid7 (integer)

    EID 7.

  • eid8 (integer)

    EID 8.

  • eid9 (integer)

    EID 9.

  • eid10 (integer)

    EID 10.

  • eid11 (integer)

    EID 11.

  • eid12 (integer)

    EID 12.

  • eid13 (integer)

    EID 13.

  • eid14 (integer)

    EID 14.

  • eid15 (integer)

    EID 15.

  • eid16 (integer)

    EID 16.

  • title (optional) (string)

    Define hex spotweld assembly title.

    Returns

    HexSpotweldAssembly object

    Return type

    HexSpotweldAssembly

    Example

    To create a new *DEFINE_HEX_SPOTWELD_ASSEMBLY with ID 100 in model m with 16 elements 50, 150, 250, 350, 450, 550, 650, 750, 850, 950, 1050, 1150, 1250, 1350, 1450 and 1550 

    var h = new HexSpotweldAssembly(m, 100, 16, 50, 150, 250, 350, 450, 550, 650, 750, 850, 950, 1050, 1150, 1250, 1350, 1450, 1550);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a DEFINE_HEX_SPOTWELD_ASSEMBLY.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the DEFINE_HEX_SPOTWELD_ASSEMBLY

    Returns

    No return value

    Example

    To associate comment c to the DEFINE_HEX_SPOTWELD_ASSEMBLY h: 

    h.AssociateComment(c);

    Browse(modal (optional)[boolean])

    Description

    Starts an edit panel in Browse mode.

    Arguments

  • modal (optional) (boolean)

    If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

    Returns

    no return value

    Example

    To Browse DEFINE_HEX_SPOTWELD_ASSEMBLY h: 

    h.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the DEFINE_HEX_SPOTWELD_ASSEMBLY.

    Arguments

  • flag (Flag)

    Flag to clear on the DEFINE_HEX_SPOTWELD_ASSEMBLY

    Returns

    No return value

    Example

    To clear flag f for DEFINE_HEX_SPOTWELD_ASSEMBLY h: 

    h.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    HexSpotweldAssembly object

    Return type

    HexSpotweldAssembly

    Example

    To copy DEFINE_HEX_SPOTWELD_ASSEMBLY h into DEFINE_HEX_SPOTWELD_ASSEMBLY z: 

    var z = h.Copy();

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

    Description

    Starts an interactive editing panel to create a DEFINE_HEX_SPOTWELD_ASSEMBLY

    Arguments

  • Model (Model)

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

    HexSpotweldAssembly object (or null if not made).

    Return type

    HexSpotweldAssembly

    Example

    To start creating a DEFINE_HEX_SPOTWELD_ASSEMBLY in model m: 

    var h = HexSpotweldAssembly.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a DEFINE_HEX_SPOTWELD_ASSEMBLY.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the DEFINE_HEX_SPOTWELD_ASSEMBLY

    Returns

    No return value

    Example

    To detach comment c from the DEFINE_HEX_SPOTWELD_ASSEMBLY h: 

    h.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 DEFINE_HEX_SPOTWELD_ASSEMBLY h: 

    h.Edit();

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

    Description

    Adds an error for DEFINE_HEX_SPOTWELD_ASSEMBLY. 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 DEFINE_HEX_SPOTWELD_ASSEMBLY h: 

    h.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first DEFINE_HEX_SPOTWELD_ASSEMBLY in the model.

    Arguments

  • Model (Model)

    Model to get first DEFINE_HEX_SPOTWELD_ASSEMBLY in

    Returns

    HexSpotweldAssembly object (or null if there are no DEFINE_HEX_SPOTWELD_ASSEMBLYs in the model).

    Return type

    HexSpotweldAssembly

    Example

    To get the first DEFINE_HEX_SPOTWELD_ASSEMBLY in model m: 

    var h = HexSpotweldAssembly.First(m);

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

    Description

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

    Arguments

  • Model (Model)

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

    HexSpotweldAssembly label.

    Return type

    Number

    Example

    To get the first free DEFINE_HEX_SPOTWELD_ASSEMBLY label in model m: 

    var label = HexSpotweldAssembly.FirstFreeLabel(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all DEFINE_HEX_SPOTWELD_ASSEMBLYs will be flagged in

  • flag (Flag)

    Flag to set on the DEFINE_HEX_SPOTWELD_ASSEMBLYs

    Returns

    No return value

    Example

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

    HexSpotweldAssembly.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the DEFINE_HEX_SPOTWELD_ASSEMBLY is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the DEFINE_HEX_SPOTWELD_ASSEMBLY

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if DEFINE_HEX_SPOTWELD_ASSEMBLY h has flag f set on it: 

    if (h.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all DEFINE_HEX_SPOTWELD_ASSEMBLYs are in

  • func (function)

    Function to call for each DEFINE_HEX_SPOTWELD_ASSEMBLY

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

    HexSpotweldAssembly.ForEach(m, test);
function test(h)
{
// h is HexSpotweldAssembly object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get DEFINE_HEX_SPOTWELD_ASSEMBLYs from

  • property (optional) (string)

    Name for property to get for all DEFINE_HEX_SPOTWELD_ASSEMBLYs in the model

    Returns

    Array of HexSpotweldAssembly objects or properties

    Return type

    Array

    Example

    To make an array of HexSpotweldAssembly objects for all of the DEFINE_HEX_SPOTWELD_ASSEMBLYs in model m: 

    var a = HexSpotweldAssembly.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a DEFINE_HEX_SPOTWELD_ASSEMBLY.

    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 DEFINE_HEX_SPOTWELD_ASSEMBLY h: 

    var comm_array = h.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get DEFINE_HEX_SPOTWELD_ASSEMBLYs from

  • flag (Flag)

    Flag set on the DEFINE_HEX_SPOTWELD_ASSEMBLYs that you want to retrieve

  • property (optional) (string)

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

    Returns

    Array of HexSpotweldAssembly objects or properties

    Return type

    Array

    Example

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

    var h = HexSpotweldAssembly.GetFlagged(m, f);

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

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

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

    Description

    Returns the HexSpotweldAssembly object for a DEFINE_HEX_SPOTWELD_ASSEMBLY ID.

    Arguments

  • Model (Model)

    Model to find the DEFINE_HEX_SPOTWELD_ASSEMBLY in

  • number (integer)

    number of the DEFINE_HEX_SPOTWELD_ASSEMBLY you want the HexSpotweldAssembly object for

    Returns

    HexSpotweldAssembly object (or null if DEFINE_HEX_SPOTWELD_ASSEMBLY does not exist).

    Return type

    HexSpotweldAssembly

    Example

    To get the HexSpotweldAssembly object for DEFINE_HEX_SPOTWELD_ASSEMBLY 100 in model m 

    var h = HexSpotweldAssembly.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    DEFINE_HEX_SPOTWELD_ASSEMBLY property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if HexSpotweldAssembly property h.example is a parameter: 

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

    To check if HexSpotweldAssembly property h.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for HexSpotweldAssem s: 

    var key = s.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for HexSpotweldAssem s: 

    var cards = s.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last DEFINE_HEX_SPOTWELD_ASSEMBLY in the model.

    Arguments

  • Model (Model)

    Model to get last DEFINE_HEX_SPOTWELD_ASSEMBLY in

    Returns

    HexSpotweldAssembly object (or null if there are no DEFINE_HEX_SPOTWELD_ASSEMBLYs in the model).

    Return type

    HexSpotweldAssembly

    Example

    To get the last DEFINE_HEX_SPOTWELD_ASSEMBLY in model m: 

    var h = HexSpotweldAssembly.Last(m);

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

    Description

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

    Arguments

  • Model (Model)

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

    HexSpotweldAssembly label.

    Return type

    Number

    Example

    To get the last free DEFINE_HEX_SPOTWELD_ASSEMBLY label in model m: 

    var label = HexSpotweldAssembly.LastFreeLabel(m);

    Next()

    Description

    Returns the next DEFINE_HEX_SPOTWELD_ASSEMBLY in the model.

    Arguments

    No arguments

    Returns

    HexSpotweldAssembly object (or null if there are no more DEFINE_HEX_SPOTWELD_ASSEMBLYs in the model).

    Return type

    HexSpotweldAssembly

    Example

    To get the DEFINE_HEX_SPOTWELD_ASSEMBLY in model m after DEFINE_HEX_SPOTWELD_ASSEMBLY h: 

    var h = h.Next();

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

    Description

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

    Arguments

  • Model (Model)

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

    HexSpotweldAssembly label.

    Return type

    Number

    Example

    To get the next free DEFINE_HEX_SPOTWELD_ASSEMBLY label in model m: 

    var label = HexSpotweldAssembly.NextFreeLabel(m);

    Previous()

    Description

    Returns the previous DEFINE_HEX_SPOTWELD_ASSEMBLY in the model.

    Arguments

    No arguments

    Returns

    HexSpotweldAssembly object (or null if there are no more DEFINE_HEX_SPOTWELD_ASSEMBLYs in the model).

    Return type

    HexSpotweldAssembly

    Example

    To get the DEFINE_HEX_SPOTWELD_ASSEMBLY in model m before DEFINE_HEX_SPOTWELD_ASSEMBLY h: 

    var h = h.Previous();

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

    Description

    Renumbers all of the DEFINE_HEX_SPOTWELD_ASSEMBLYs in the model.

    Arguments

  • Model (Model)

    Model that all DEFINE_HEX_SPOTWELD_ASSEMBLYs will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    HexSpotweldAssembly.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged DEFINE_HEX_SPOTWELD_ASSEMBLYs in the model.

    Arguments

  • Model (Model)

    Model that all the flagged DEFINE_HEX_SPOTWELD_ASSEMBLYs will be renumbered in

  • flag (Flag)

    Flag set on the DEFINE_HEX_SPOTWELD_ASSEMBLYs that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    HexSpotweldAssembly.RenumberFlagged(m, f, 1000000);

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting DEFINE_HEX_SPOTWELD_ASSEMBLYs

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    HexSpotweldAssembly.Select(f, 'Select DEFINE_HEX_SPOTWELD_ASSEMBLYs', m);

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

    HexSpotweldAssembly.Select(f, 'Select DEFINE_HEX_SPOTWELD_ASSEMBLYs', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the DEFINE_HEX_SPOTWELD_ASSEMBLY.

    Arguments

  • flag (Flag)

    Flag to set on the DEFINE_HEX_SPOTWELD_ASSEMBLY

    Returns

    No return value

    Example

    To set flag f for DEFINE_HEX_SPOTWELD_ASSEMBLY h: 

    h.SetFlag(f);

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

    Description

    Returns the total number of DEFINE_HEX_SPOTWELD_ASSEMBLYs in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of DEFINE_HEX_SPOTWELD_ASSEMBLYs

    Return type

    Number

    Example

    To get the total number of DEFINE_HEX_SPOTWELD_ASSEMBLYs in model m: 

    var total = HexSpotweldAssembly.Total(m);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the DEFINE_HEX_SPOTWELD_ASSEMBLYs

    Returns

    No return value

    Example

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

    HexSpotweldAssembly.UnflagAll(m, f);

    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

    HexSpotweldAssembly object.

    Return type

    HexSpotweldAssembly

    Example

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

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

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

    Description

    Adds a warning for DEFINE_HEX_SPOTWELD_ASSEMBLY. 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 DEFINE_HEX_SPOTWELD_ASSEMBLY h: 

    h.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this DEFINE_HEX_SPOTWELD_ASSEMBLY.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for DEFINE_HEX_SPOTWELD_ASSEMBLY h: 

    var xrefs = h.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for HexSpotweldAssem s in keyword format 

    var str = s.toString();