GeneralizedWeld (Gwld) class

The GeneralizedWeld class gives you access to constrained generalized weld 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

GeneralizedWeld constants

Name Description
GeneralizedWeld.BUTT GeneralizedWeld is *CONSTRAINED_GENERALIZED_WELD_BUTT.
GeneralizedWeld.COMBINED GeneralizedWeld is *CONSTRAINED_GENERALIZED_WELD_COMBINED.
GeneralizedWeld.CROSS_FILLET GeneralizedWeld is *CONSTRAINED_GENERALIZED_WELD_CROSS_FILLET.
GeneralizedWeld.FILLET GeneralizedWeld is *CONSTRAINED_GENERALIZED_WELD_FILLET.
GeneralizedWeld.SPOT GeneralizedWeld is *CONSTRAINED_GENERALIZED_WELD_SPOT.

GeneralizedWeld properties

Name Type Description
a real Width of fillet (GeneralizedWeld.FILLET, GeneralizedWeld.CROSS_FILLET)
alpha real Weld angle (GeneralizedWeld.FILLET, GeneralizedWeld.CROSS_FILLET)
beta real Failure parameter (GeneralizedWeld.FILLET, GeneralizedWeld.BUTT, GeneralizedWeld.CROSS_FILLET)
cid integer Coordinate System ID.
d real Thickness of weld (GeneralizedWeld.BUTT)
epsf real Effective plastic strain at failure (GeneralizedWeld.SPOT, GeneralizedWeld.FILLET, GeneralizedWeld.BUTT, GeneralizedWeld.CROSS_FILLET)
exists (read only) logical true if generalized weld exists, false if referred to but not defined.
filter integer Number of force vectors saved for filtering.
id logical true if _ID option is set, false if not
include integer The Include file number that the generalized weld is in.
l real Length of weld (GeneralizedWeld.FILLET, GeneralizedWeld.BUTT, GeneralizedWeld.CROSS_FILLET)
label integer Constrained Generalized weld number.
lt real Transverse length (GeneralizedWeld.BUTT)
m real Exponent for shear force (GeneralizedWeld.SPOT)
model (read only) integer The Model number that the generalized weld is in.
n real Exponent for normal force (GeneralizedWeld.SPOT)
npr integer Number of individual nodal pairs in cross fillet and combined weld.
nprt integer Printout option.
nsid integer Set Node Set ID.
option constant GeneralizedWeld type. Can be GeneralizedWeld.SPOT, GeneralizedWeld.FILLET, GeneralizedWeld.BUTT, GeneralizedWeld.CROSS_FILLET, GeneralizedWeld.COMBINED
sigf real Stress at failure (GeneralizedWeld.FILLET)
sigy real Stress at failure (GeneralizedWeld.BUTT, GeneralizedWeld.CROSS_FILLET)
sn real Normal force at failure (GeneralizedWeld.SPOT)
ss real Shear force at faliure (GeneralizedWeld.SPOT)
tfail real Failure time for constraint set (GeneralizedWeld.SPOT, GeneralizedWeld.FILLET, GeneralizedWeld.BUTT, GeneralizedWeld.CROSS_FILLET)
w real Width of flange (GeneralizedWeld.FILLET, GeneralizedWeld.CROSS_FILLET)
wid integer Constrained Generalized weld number (identical to label).
window real Filter time window.

Detailed Description

The GeneralizedWeld class allows you to create, modify, edit and manipulate generalized weld cards. See the documentation below for more details.

For convenience "Gwld" can also be used as the class name instead of "GeneralizedWeld".

Constructor

new GeneralizedWeld(Model[Model], option[constant], nsid[integer], cid (optional)[integer], filter (optional)[integer], window (optional)[real], npr (optional)[integer], nprt (optional)[integer], wid (optional)[integer])

Description

Create a new GeneralizedWeld object.

Arguments

  • Model (Model)

    Model that gwld will be created in

  • option (constant)

    Constrained generalized weld type (any).

  • nsid (integer)

    Set Node Set ID.

  • cid (optional) (integer)

    Coordinate System ID.

  • filter (optional) (integer)

    Number of force vectors saved for filtering.

  • window (optional) (real)

    Filter time window.

  • npr (optional) (integer)

    Number of individual nodal pairs in cross fillet and combined weld.

  • nprt (optional) (integer)

    Printout option.

  • wid (optional) (integer)

    Constrained Generalized weld number.

    Returns

    GeneralizedWeld object

    Return type

    GeneralizedWeld

    Example

    To create a new gwld 1000 of type SPOT in model m with specifiction: nsid, cid, filter, window, nprt are 91, 92, 81, 0.5, 82 respectively 

    var w = new GeneralizedWeld(m, GeneralizedWeld.SPOT, 91, 92, 81, 0.5, 82, 1000);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a generalized weld.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the generalized weld

    Returns

    No return value

    Example

    To associate comment c to the generalized weld gw: 

    gw.AssociateComment(c);

    Blank()

    Description

    Blanks the generalized weld

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank generalized weld gw: 

    gw.Blank();

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

    Description

    Blanks all of the generalized welds in the model.

    Arguments

  • Model (Model)

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

    GeneralizedWeld.BlankAll(m);

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

    Description

    Blanks all of the flagged generalized welds in the model.

    Arguments

  • Model (Model)

    Model that all the flagged generalized welds will be blanked in

  • flag (Flag)

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

    GeneralizedWeld.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the generalized weld is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if generalized weld gw is blanked: 

    if (gw.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 generalized weld gw: 

    gw.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the generalized weld.

    Arguments

  • flag (Flag)

    Flag to clear on the generalized weld

    Returns

    No return value

    Example

    To clear flag f for generalized weld gw: 

    gw.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    GeneralizedWeld object

    Return type

    GeneralizedWeld

    Example

    To copy generalized weld gw into generalized weld z: 

    var z = gw.Copy();

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

    Description

    Starts an interactive editing panel to create a generalized weld

    Arguments

  • Model (Model)

    Model that the generalized weld 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

    GeneralizedWeld object (or null if not made).

    Return type

    GeneralizedWeld

    Example

    To start creating a generalized weld in model m: 

    var gw = GeneralizedWeld.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a generalized weld.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the generalized weld

    Returns

    No return value

    Example

    To detach comment c from the generalized weld gw: 

    gw.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 generalized weld gw: 

    gw.Edit();

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

    Description

    Adds an error for generalized weld. 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 generalized weld gw: 

    gw.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first generalized weld in the model.

    Arguments

  • Model (Model)

    Model to get first generalized weld in

    Returns

    GeneralizedWeld object (or null if there are no generalized welds in the model).

    Return type

    GeneralizedWeld

    Example

    To get the first generalized weld in model m: 

    var gw = GeneralizedWeld.First(m);

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

    Description

    Returns the first free generalized weld label in the model. Also see GeneralizedWeld.LastFreeLabel(), GeneralizedWeld.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

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

    GeneralizedWeld label.

    Return type

    Number

    Example

    To get the first free generalized weld label in model m: 

    var label = GeneralizedWeld.FirstFreeLabel(m);

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

    Description

    Flags all of the generalized welds in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all generalized welds will be flagged in

  • flag (Flag)

    Flag to set on the generalized welds

    Returns

    No return value

    Example

    To flag all of the generalized welds with flag f in model m: 

    GeneralizedWeld.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the generalized weld is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the generalized weld

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if generalized weld gw has flag f set on it: 

    if (gw.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all generalized welds are in

  • func (function)

    Function to call for each generalized weld

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

    GeneralizedWeld.ForEach(m, test);
function test(gw)
{
// gw is GeneralizedWeld object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get generalized welds from

  • property (optional) (string)

    Name for property to get for all generalized welds in the model

    Returns

    Array of GeneralizedWeld objects or properties

    Return type

    Array

    Example

    To make an array of GeneralizedWeld objects for all of the generalized welds in model m: 

    var a = GeneralizedWeld.GetAll(m);

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

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

    GetCombinedData(index[integer])

    Description

    Returns the combined data for a specific nodal pair as an array.

    Arguments

  • index (integer)

    Index you want the data for. Note that indices start at 0.

    Returns

    An array containing the data (tfail, epsf, sigy, beta, l, w, a, alpha, nodea, nodeb, ncid, wtyp).

    Return type

    Array

    Example

    To get the data for the 3rd node pair for generalized weld gw: 

    var data = gw.GetCombinedData(2);

    GetComments()

    Description

    Extracts the comments associated to a generalized weld.

    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 generalized weld gw: 

    var comm_array = gw.GetComments();

    GetCrossFilletData(index[integer])

    Description

    Returns the cross fillet data for a specific nodal pair as an array.

    Arguments

  • index (integer)

    Index you want the data for. Note that indices start at 0.

    Returns

    An array containing the data (nodea, nodeb, ncid).

    Return type

    Array

    Example

    To get the data for the 3rd node pair for generalized weld gw: 

    var data = gw.GetCrossFilletData(2);

    GetFailureData()   [deprecated]

    This function is deprecated in version 11.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

    Access the properties directly or use GeneralizedWeld.GetCombinedData() for GeneralizedWeld.COMBINED instead.

    Arguments

    No arguments

    Returns

    No return value

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

    Description

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

    Arguments

  • Model (Model)

    Model to get generalized welds from

  • flag (Flag)

    Flag set on the generalized welds that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged generalized welds in the model

    Returns

    Array of GeneralizedWeld objects or properties

    Return type

    Array

    Example

    To make an array of GeneralizedWeld objects for all of the generalized welds in model m flagged with f: 

    var gw = GeneralizedWeld.GetFlagged(m, f);

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

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

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

    Description

    Returns the GeneralizedWeld object for a generalized weld ID.

    Arguments

  • Model (Model)

    Model to find the generalized weld in

  • number (integer)

    number of the generalized weld you want the GeneralizedWeld object for

    Returns

    GeneralizedWeld object (or null if generalized weld does not exist).

    Return type

    GeneralizedWeld

    Example

    To get the GeneralizedWeld object for generalized weld 100 in model m 

    var gw = GeneralizedWeld.GetFromID(m, 100);

    GetNodalPair()   [deprecated]

    This function is deprecated in version 11.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

    Use GeneralizedWeld.GetCombinedData() for GeneralizedWeld.COMBINED or GeneralizedWeld.GetCrossFilletData() for GeneralizedWeld.CROSS_FILLET instead.

    Arguments

    No arguments

    Returns

    No return value

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    generalized weld property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if GeneralizedWeld property gw.example is a parameter: 

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

    To check if GeneralizedWeld property gw.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for generalized weld gw: 

    var key = gw.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for generalized weld gw: 

    var cards = gw.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last generalized weld in the model.

    Arguments

  • Model (Model)

    Model to get last generalized weld in

    Returns

    GeneralizedWeld object (or null if there are no generalized welds in the model).

    Return type

    GeneralizedWeld

    Example

    To get the last generalized weld in model m: 

    var gw = GeneralizedWeld.Last(m);

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

    Description

    Returns the last free generalized weld label in the model. Also see GeneralizedWeld.FirstFreeLabel(), GeneralizedWeld.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

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

    GeneralizedWeld label.

    Return type

    Number

    Example

    To get the last free generalized weld label in model m: 

    var label = GeneralizedWeld.LastFreeLabel(m);

    Next()

    Description

    Returns the next generalized weld in the model.

    Arguments

    No arguments

    Returns

    GeneralizedWeld object (or null if there are no more generalized welds in the model).

    Return type

    GeneralizedWeld

    Example

    To get the generalized weld in model m after generalized weld gw: 

    var gw = gw.Next();

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

    Description

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

    Arguments

  • Model (Model)

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

    GeneralizedWeld label.

    Return type

    Number

    Example

    To get the next free generalized weld label in model m: 

    var label = GeneralizedWeld.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 generalized weld.

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

    GeneralizedWeld object (or null if not picked)

    Return type

    GeneralizedWeld

    Example

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

    var gw = GeneralizedWeld.Pick('Pick generalized weld from screen', m);

    Previous()

    Description

    Returns the previous generalized weld in the model.

    Arguments

    No arguments

    Returns

    GeneralizedWeld object (or null if there are no more generalized welds in the model).

    Return type

    GeneralizedWeld

    Example

    To get the generalized weld in model m before generalized weld gw: 

    var gw = gw.Previous();

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

    Description

    Renumbers all of the generalized welds in the model.

    Arguments

  • Model (Model)

    Model that all generalized welds will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    GeneralizedWeld.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged generalized welds in the model.

    Arguments

  • Model (Model)

    Model that all the flagged generalized welds will be renumbered in

  • flag (Flag)

    Flag set on the generalized welds that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    GeneralizedWeld.RenumberFlagged(m, f, 1000000);

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

    Description

    Allows the user to select generalized welds using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting generalized welds

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    GeneralizedWeld.Select(f, 'Select generalized welds', m);

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

    GeneralizedWeld.Select(f, 'Select generalized welds', l);

    SetCombinedData(index[integer], data[Array of numbers])

    Description

    Sets the combined data for a specific nodal pair.

    Arguments

  • index (integer)

    Index you want to set the data for. Note that indices start at 0.

  • data (Array of numbers)

    Array containing the data. The array length should be 12 (tfail, epsf, sigy, beta, l, w, a, alpha, nodea, nodeb, ncid, wtyp)

    Returns

    No return value.

    Example

    To set the data for the 3rd nodal pair for generalized weld gw to the values in array adata: 

    gw.SetCombinedData(2, adata);

    SetCrossFilletData(index[integer], data[Array of numbers])

    Description

    Sets the cross fillet data for a specific nodal pair.

    Arguments

  • index (integer)

    Index you want to set the data for. Note that indices start at 0.

  • data (Array of numbers)

    Array containing the data. The array length should be 3 (nodea, nodeb, ncid)

    Returns

    No return value.

    Example

    To set the data for the 3rd nodal pair for generalized weld gw to the values in array adata: 

    gw.SetCrossFilletData(2, adata);

    SetFailureData()   [deprecated]

    This function is deprecated in version 11.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

    Access the properties directly or use GeneralizedWeld.SetCombinedData() for GeneralizedWeld.COMBINED instead.

    Arguments

    No arguments

    Returns

    No return value

    SetFlag(flag[Flag])

    Description

    Sets a flag on the generalized weld.

    Arguments

  • flag (Flag)

    Flag to set on the generalized weld

    Returns

    No return value

    Example

    To set flag f for generalized weld gw: 

    gw.SetFlag(f);

    SetNodalPair()   [deprecated]

    This function is deprecated in version 11.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

    Use GeneralizedWeld.SetCombinedData() for GeneralizedWeld.COMBINED or GeneralizedWeld.SetCrossFilletData() for GeneralizedWeld.CROSS_FILLET instead.

    Arguments

    No arguments

    Returns

    No return value

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch generalized weld gw: 

    gw.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged generalized welds will be sketched in

  • flag (Flag)

    Flag set on the generalized welds that you want to sketch

  • redraw (optional) (boolean)

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

    GeneralizedWeld.SketchFlagged(m, flag);

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

    Description

    Returns the total number of generalized welds in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of generalized welds

    Return type

    Number

    Example

    To get the total number of generalized welds in model m: 

    var total = GeneralizedWeld.Total(m);

    Unblank()

    Description

    Unblanks the generalized weld

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank generalized weld gw: 

    gw.Unblank();

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

    Description

    Unblanks all of the generalized welds in the model.

    Arguments

  • Model (Model)

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

    GeneralizedWeld.UnblankAll(m);

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

    Description

    Unblanks all of the flagged generalized welds in the model.

    Arguments

  • Model (Model)

    Model that the flagged generalized welds will be unblanked in

  • flag (Flag)

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

    GeneralizedWeld.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the generalized welds in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all generalized welds will be unset in

  • flag (Flag)

    Flag to unset on the generalized welds

    Returns

    No return value

    Example

    To unset the flag f on all the generalized welds in model m: 

    GeneralizedWeld.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the generalized weld.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch generalized weld gw: 

    gw.Unsketch();

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

    Description

    Unsketches all generalized welds.

    Arguments

  • Model (Model)

    Model that all generalized welds will be unblanked in

  • redraw (optional) (boolean)

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

    GeneralizedWeld.UnsketchAll(m);

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

    Description

    Unsketches all flagged generalized welds in the model.

    Arguments

  • Model (Model)

    Model that all generalized welds will be unsketched in

  • flag (Flag)

    Flag set on the generalized welds that you want to unsketch

  • redraw (optional) (boolean)

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

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

    GeneralizedWeld object.

    Return type

    GeneralizedWeld

    Example

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

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

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

    Description

    Adds a warning for generalized weld. 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 generalized weld gw: 

    gw.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this generalized weld.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for generalized weld gw: 

    var xrefs = gw.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for generalized weld gw in keyword format 

    var s = gw.toString();