Attached class

The Attached class contains constants and static functions relating to the Attached() member function from the Model class. 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

Attached constants

Name Description
Attached.SINGLE Find attached option - find attached through single elements only
Attached.WHOLE Find attached option - find through whole attached part

Detailed Description

The Attached class static functions are used to set options for the find attached feature in PRIMER. Once set, these settings are used when using the Attached member function from the Model class

Details of functions

Beam3rdNodes(Setting[boolean]) [static]

Description

Sets the find attached option for beam 3rd nodes on or off

Arguments

  • Setting (boolean)

    If true beam 3rd nodes are considered for find attached, if false, they are not.

    Returns

    No return value

    Example

    To set the 3rd node option to on: 

    Attached.Beam3rdNodes(true);

    BeamPid(Setting[boolean]) [static]

    Description

    Sets the find attached option for beam pid on or off

    Arguments

  • Setting (boolean)

    If true beam pid's are considered for find attached, if false, they are not.

    Returns

    No return value

    Example

    To set the beam pid option to on: 

    Attached.BeamPid(true);

    Deformable(Setting[constant]) [static]

    Description

    Sets the deformable option for find attached

    Arguments

  • Setting (constant)

    Option. Can be Attached.WHOLE, Attached.SINGLE

    Returns

    No return value

    Example

    To set the deformable option to find attached through the whole part: 

    Attached.Deformable(Attached.WHOLE);

    FlagPart(Setting[boolean]) [static]

    Description

    Sets an option to flag parts after a find attached if any elements within that part are flagged

    Arguments

  • Setting (boolean)

    If true, parts are flagged after a find attached if any elements within that part are flagged, if false, they are not.

    Returns

    No return value

    Example

    To set the flag part option to on: 

    Attached.FlagPart(true);

    Recursive(Setting[boolean], Number (optional)[integer]) [static]

    Description

    Sets the find attached option for recursive on or off

    Arguments

  • Setting (boolean)

    If true recursive is on, if false, it is off.

  • Number (optional) (integer)

    Option to set the number of find attached iterations used when the recursive option is set.

    Returns

    No return value

    Example

    To set the recursive option to on: 

    Attached.Recursive(true);

    Rigid(Setting[constant]) [static]

    Description

    Sets the rigid option for find attached

    Arguments

  • Setting (constant)

    Option. Can be Attached.WHOLE, Attached.SINGLE

    Returns

    No return value

    Example

    To set the rigid option to find attached through the whole part: 

    Attached.Rigid(Attached.WHOLE);

    SetEntity(Type[string], Setting[boolean]) [static]

    Description

    Sets entity to be on or off to find attached through.

    Arguments

  • Type (string)

    The type of the item to switch on or off (for a list of types see Appendix A of the PRIMER manual). Use "ALL" to switch all entities or "CONSTRAINEDALL" to switch all constrained entities.

  • Setting (boolean)

    If true you turn the entity switch on, if false you turn it off.

    Returns

    No return value

    Example

    To set the SHELL switch to on so that when you run a find attached you fnd attached through shells: 

    Attached.SetEntity("SHELL", true);

    TiedContacts(Setting[boolean]) [static]

    Description

    Sets the find attached option for tied contacts on or off

    Arguments

  • Setting (boolean)

    If true tied contacts are considered for find attached, if false, they are not.

    Returns

    No return value

    Example

    To set the tied contacts option to on: 

    Attached.TiedContacts(true);