TieBreak class

The TieBreak class gives you access to constrained Tie-Break 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

TieBreak properties

Name Type Description
eppf real Plastic strain at failure.
exists (read only) logical true if tie-break exists, false if referred to but not defined.
include integer The Include file number that the tie-break is in.
model (read only) integer The Model number that the tie-break is in.
nsid1 integer First Node Set ID.
nsid2 integer Second Node Set ID.

Detailed Description

The TieBreak class allows you to create, modify, edit and manipulate constrained tie-break cards. See the documentation below for more details.

Constructor

new TieBreak(Model[Model], nsid1[integer], nsid2[integer], eppf (optional)[real])

Description

Create a new TieBreak object.

Arguments

  • Model (Model)

    Model that constrained tie-break will be created in

  • nsid1 (integer)

    First Node Set ID.

  • nsid2 (integer)

    Second Node Set ID.

  • eppf (optional) (real)

    Plastic strain at failure.

    Returns

    TieBreak object

    Return type

    TieBreak

    Example

    To create a new constrained tie-break in model m with first node set 100, second node set 200 

    var tb = new TieBreak(m, 100, 200);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a tie-break.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the tie-break

    Returns

    No return value

    Example

    To associate comment c to the tie-break tb: 

    tb.AssociateComment(c);

    Blank()

    Description

    Blanks the tie-break

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank tie-break tb: 

    tb.Blank();

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

    Description

    Blanks all of the tie-breaks in the model.

    Arguments

  • Model (Model)

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

    TieBreak.BlankAll(m);

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

    Description

    Blanks all of the flagged tie-breaks in the model.

    Arguments

  • Model (Model)

    Model that all the flagged tie-breaks will be blanked in

  • flag (Flag)

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

    TieBreak.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the tie-break is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if tie-break tb is blanked: 

    if (tb.Blanked() ) do_something...

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the tie-break.

    Arguments

  • flag (Flag)

    Flag to clear on the tie-break

    Returns

    No return value

    Example

    To clear flag f for tie-break tb: 

    tb.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    TieBreak object

    Return type

    TieBreak

    Example

    To copy tie-break tb into tie-break z: 

    var z = tb.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a tie-break.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the tie-break

    Returns

    No return value

    Example

    To detach comment c from the tie-break tb: 

    tb.DetachComment(c);

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

    Description

    Adds an error for tie-break. 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 tie-break tb: 

    tb.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first tie-break in the model.

    Arguments

  • Model (Model)

    Model to get first tie-break in

    Returns

    TieBreak object (or null if there are no tie-breaks in the model).

    Return type

    TieBreak

    Example

    To get the first tie-break in model m: 

    var tb = TieBreak.First(m);

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

    Description

    Flags all of the tie-breaks in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all tie-breaks will be flagged in

  • flag (Flag)

    Flag to set on the tie-breaks

    Returns

    No return value

    Example

    To flag all of the tie-breaks with flag f in model m: 

    TieBreak.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the tie-break is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the tie-break

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if tie-break tb has flag f set on it: 

    if (tb.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all tie-breaks are in

  • func (function)

    Function to call for each tie-break

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

    TieBreak.ForEach(m, test);
function test(tb)
{
// tb is TieBreak object
}

    To call function test for all of the tie-breaks in model m with optional object: 

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

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

    Description

    Returns an array of TieBreak objects or properties for all of the tie-breaks in a model in PRIMER. If the optional property argument is not given then an array of TieBreak objects is returned. If the property argument is given, that property value for each tie-break is returned in the array instead of a TieBreak object

    Arguments

  • Model (Model)

    Model to get tie-breaks from

  • property (optional) (string)

    Name for property to get for all tie-breaks in the model

    Returns

    Array of TieBreak objects or properties

    Return type

    Array

    Example

    To make an array of TieBreak objects for all of the tie-breaks in model m: 

    var a = TieBreak.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a tie-break.

    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 tie-break tb: 

    var comm_array = tb.GetComments();

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

    Description

    Returns an array of TieBreak objects for all of the flagged tie-breaks in a model in PRIMER If the optional property argument is not given then an array of TieBreak objects is returned. If the property argument is given, then that property value for each tie-break is returned in the array instead of a TieBreak object

    Arguments

  • Model (Model)

    Model to get tie-breaks from

  • flag (Flag)

    Flag set on the tie-breaks that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged tie-breaks in the model

    Returns

    Array of TieBreak objects or properties

    Return type

    Array

    Example

    To make an array of TieBreak objects for all of the tie-breaks in model m flagged with f: 

    var tb = TieBreak.GetFlagged(m, f);

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

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

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

    Description

    Returns the TieBreak object for a tie-break ID.

    Arguments

  • Model (Model)

    Model to find the tie-break in

  • number (integer)

    number of the tie-break you want the TieBreak object for

    Returns

    TieBreak object (or null if tie-break does not exist).

    Return type

    TieBreak

    Example

    To get the TieBreak object for tie-break 100 in model m 

    var tb = TieBreak.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    tie-break property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if TieBreak property tb.example is a parameter: 

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

    To check if TieBreak property tb.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this tie-break (**CONSTRAINED_TIE_BREAK). Note that a carriage return is not added. See also TieBreak.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for tie-break tb: 

    var key = tb.Keyword();

    KeywordCards()

    Description

    Returns the keyword cards for the tie-break. Note that a carriage return is not added. See also TieBreak.Keyword()

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for tie-break tb: 

    var cards = tb.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last tie-break in the model.

    Arguments

  • Model (Model)

    Model to get last tie-break in

    Returns

    TieBreak object (or null if there are no tie-breaks in the model).

    Return type

    TieBreak

    Example

    To get the last tie-break in model m: 

    var tb = TieBreak.Last(m);

    Next()

    Description

    Returns the next tie-break in the model.

    Arguments

    No arguments

    Returns

    TieBreak object (or null if there are no more tie-breaks in the model).

    Return type

    TieBreak

    Example

    To get the tie-break in model m after tie-break tb: 

    var tb = tb.Next();

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

    Description

    Allows the user to pick a tie-break.

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

    TieBreak object (or null if not picked)

    Return type

    TieBreak

    Example

    To pick a tie-break from model m giving the prompt 'Pick tie-break from screen': 

    var tb = TieBreak.Pick('Pick tie-break from screen', m);

    Previous()

    Description

    Returns the previous tie-break in the model.

    Arguments

    No arguments

    Returns

    TieBreak object (or null if there are no more tie-breaks in the model).

    Return type

    TieBreak

    Example

    To get the tie-break in model m before tie-break tb: 

    var tb = tb.Previous();

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

    Description

    Allows the user to select tie-breaks using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting tie-breaks

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    TieBreak.Select(f, 'Select tie-breaks', m);

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

    TieBreak.Select(f, 'Select tie-breaks', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the tie-break.

    Arguments

  • flag (Flag)

    Flag to set on the tie-break

    Returns

    No return value

    Example

    To set flag f for tie-break tb: 

    tb.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the tie-break. The tie-break will be sketched until you either call TieBreak.Unsketch(), TieBreak.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch tie-break tb: 

    tb.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged tie-breaks will be sketched in

  • flag (Flag)

    Flag set on the tie-breaks that you want to sketch

  • redraw (optional) (boolean)

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

    TieBreak.SketchFlagged(m, flag);

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

    Description

    Returns the total number of tie-breaks in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of tie-breaks

    Return type

    Number

    Example

    To get the total number of tie-breaks in model m: 

    var total = TieBreak.Total(m);

    Unblank()

    Description

    Unblanks the tie-break

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank tie-break tb: 

    tb.Unblank();

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

    Description

    Unblanks all of the tie-breaks in the model.

    Arguments

  • Model (Model)

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

    TieBreak.UnblankAll(m);

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

    Description

    Unblanks all of the flagged tie-breaks in the model.

    Arguments

  • Model (Model)

    Model that the flagged tie-breaks will be unblanked in

  • flag (Flag)

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

    TieBreak.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the tie-breaks in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all tie-breaks will be unset in

  • flag (Flag)

    Flag to unset on the tie-breaks

    Returns

    No return value

    Example

    To unset the flag f on all the tie-breaks in model m: 

    TieBreak.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the tie-break.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch tie-break tb: 

    tb.Unsketch();

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

    Description

    Unsketches all tie-breaks.

    Arguments

  • Model (Model)

    Model that all tie-breaks will be unblanked in

  • redraw (optional) (boolean)

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

    TieBreak.UnsketchAll(m);

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

    Description

    Unsketches all flagged tie-breaks in the model.

    Arguments

  • Model (Model)

    Model that all tie-breaks will be unsketched in

  • flag (Flag)

    Flag set on the tie-breaks that you want to unsketch

  • redraw (optional) (boolean)

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

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

    TieBreak object.

    Return type

    TieBreak

    Example

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

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

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

    Description

    Adds a warning for tie-break. 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 tie-break tb: 

    tb.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this tie-break.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for tie-break tb: 

    var xrefs = tb.Xrefs();

    toString()

    Description

    Creates a string containing the tie-break data in keyword format. Note that this contains the keyword header and the keyword cards. See also TieBreak.Keyword() and TieBreak.KeywordCards().

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for tie-break tb in keyword format 

    var str = tb.toString();