StressSection class

The StressSection class gives you access to define *INITIAL_STRESS_SECTION 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

StressSection properties

Name Type Description
csid integer Cross section ID.
exists (read only) logical true if stress section exists, false if referred to but not defined.
include integer The Include file number that the stress section is in.
issid integer StressSection number. Also see the label property which is an alternative name for this.
istiff integer Load curve ID defining the artificial stress fraction versus time.
izshear integer Shear stress flag.
label integer StressSection number. Also see the issid property which is an alternative name for this.
lcid integer Load curve ID defining preload stress versus time.
model (read only) integer The Model number that the stress section is in.
psid integer Part set ID.
vid integer Vector ID defining the direction normal to the cross section.

Detailed Description

The StressSection class allows you to create, modify, edit and manipulate initial stress section cards. See the documentation below for more details.

Constructor

new StressSection(Model[Model], issid[integer], csid[integer], lcid[integer], psid[integer], vid[integer], izshear[integer], istiff (optional)[integer])

Description

Create a new StressSection object.

Arguments

  • Model (Model)

    Model that stress section will be created in

  • issid (integer)

    StressSection number.

  • csid (integer)

    Cross section ID.

  • lcid (integer)

    Load curve ID defining preload stress versus time.

  • psid (integer)

    Part set ID.

  • vid (integer)

    Vector ID.

  • izshear (integer)

    Shear stress flag.

  • istiff (optional) (integer)

    Load curve ID defining artificial stress fraction versus time.

    Returns

    StressSection object

    Return type

    StressSection

    Example

    To create a new stress section in model m with label 11, cross section 12, load curve 13, part set 14, vector 15 and shear stress flag 16: 

    var iss = new StressSection(m, 11, 12, 13, 14, 15, 16);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a stress section.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the stress section

    Returns

    No return value

    Example

    To associate comment c to the stress section iss: 

    iss.AssociateComment(c);

    Blank()

    Description

    Blanks the stress section

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank stress section iss: 

    iss.Blank();

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

    Description

    Blanks all of the stress sections in the model.

    Arguments

  • Model (Model)

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

    StressSection.BlankAll(m);

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

    Description

    Blanks all of the flagged stress sections in the model.

    Arguments

  • Model (Model)

    Model that all the flagged stress sections will be blanked in

  • flag (Flag)

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

    StressSection.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the stress section is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if stress section iss is blanked: 

    if (iss.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 stress section iss: 

    iss.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the stress section.

    Arguments

  • flag (Flag)

    Flag to clear on the stress section

    Returns

    No return value

    Example

    To clear flag f for stress section iss: 

    iss.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    StressSection object

    Return type

    StressSection

    Example

    To copy stress section iss into stress section z: 

    var z = iss.Copy();

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

    Description

    Starts an interactive editing panel to create a stress section

    Arguments

  • Model (Model)

    Model that the stress section 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

    StressSection object (or null if not made).

    Return type

    StressSection

    Example

    To start creating a stress section in model m: 

    var iss = StressSection.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a stress section.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the stress section

    Returns

    No return value

    Example

    To detach comment c from the stress section iss: 

    iss.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 stress section iss: 

    iss.Edit();

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

    Description

    Adds an error for stress section. 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 stress section iss: 

    iss.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first stress section in the model.

    Arguments

  • Model (Model)

    Model to get first stress section in

    Returns

    StressSection object (or null if there are no stress sections in the model).

    Return type

    StressSection

    Example

    To get the first stress section in model m: 

    var iss = StressSection.First(m);

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

    Description

    Returns the first free stress section label in the model. Also see StressSection.LastFreeLabel(), StressSection.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

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

    StressSection label.

    Return type

    Number

    Example

    To get the first free stress section label in model m: 

    var label = StressSection.FirstFreeLabel(m);

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

    Description

    Flags all of the stress sections in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all stress sections will be flagged in

  • flag (Flag)

    Flag to set on the stress sections

    Returns

    No return value

    Example

    To flag all of the stress sections with flag f in model m: 

    StressSection.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the stress section is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the stress section

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if stress section iss has flag f set on it: 

    if (iss.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all stress sections are in

  • func (function)

    Function to call for each stress section

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

    StressSection.ForEach(m, test);
function test(iss)
{
// iss is StressSection object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get stress sections from

  • property (optional) (string)

    Name for property to get for all stress sections in the model

    Returns

    Array of StressSection objects or properties

    Return type

    Array

    Example

    To make an array of StressSection objects for all of the stress sections in model m: 

    var a = StressSection.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a stress section.

    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 stress section iss: 

    var comm_array = iss.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get stress sections from

  • flag (Flag)

    Flag set on the stress sections that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged stress sections in the model

    Returns

    Array of StressSection objects or properties

    Return type

    Array

    Example

    To make an array of StressSection objects for all of the stress sections in model m flagged with f: 

    var iss = StressSection.GetFlagged(m, f);

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

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

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

    Description

    Returns the StressSection object for a stress section ID.

    Arguments

  • Model (Model)

    Model to find the stress section in

  • number (integer)

    number of the stress section you want the StressSection object for

    Returns

    StressSection object (or null if stress section does not exist).

    Return type

    StressSection

    Example

    To get the StressSection object for stress section 100 in model m 

    var iss = StressSection.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    stress section property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if StressSection property iss.example is a parameter: 

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

    To check if StressSection property iss.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this stress section. Note that a carriage return is not added. See also StressSection.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for stress section iss: 

    var key = iss.Keyword();

    KeywordCards()

    Description

    Returns the keyword cards for the stress section. Note that a carriage return is not added. See also StressSection.Keyword()

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for stress section iss: 

    var cards = iss.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last stress section in the model.

    Arguments

  • Model (Model)

    Model to get last stress section in

    Returns

    StressSection object (or null if there are no stress sections in the model).

    Return type

    StressSection

    Example

    To get the last stress section in model m: 

    var iss = StressSection.Last(m);

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

    Description

    Returns the last free stress section label in the model. Also see StressSection.FirstFreeLabel(), StressSection.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

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

    StressSection label.

    Return type

    Number

    Example

    To get the last free stress section label in model m: 

    var label = StressSection.LastFreeLabel(m);

    Next()

    Description

    Returns the next stress section in the model.

    Arguments

    No arguments

    Returns

    StressSection object (or null if there are no more stress sections in the model).

    Return type

    StressSection

    Example

    To get the stress section in model m after stress section iss: 

    var iss = iss.Next();

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

    Description

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

    Arguments

  • Model (Model)

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

    StressSection label.

    Return type

    Number

    Example

    To get the next free stress section label in model m: 

    var label = StressSection.NextFreeLabel(m);

    Previous()

    Description

    Returns the previous stress section in the model.

    Arguments

    No arguments

    Returns

    StressSection object (or null if there are no more stress sections in the model).

    Return type

    StressSection

    Example

    To get the stress section in model m before stress section iss: 

    var iss = iss.Previous();

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

    Description

    Renumbers all of the stress sections in the model.

    Arguments

  • Model (Model)

    Model that all stress sections will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    StressSection.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged stress sections in the model.

    Arguments

  • Model (Model)

    Model that all the flagged stress sections will be renumbered in

  • flag (Flag)

    Flag set on the stress sections that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    StressSection.RenumberFlagged(m, f, 1000000);

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

    Description

    Allows the user to select stress sections using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting stress sections

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    StressSection.Select(f, 'Select stress sections', m);

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

    StressSection.Select(f, 'Select stress sections', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the stress section.

    Arguments

  • flag (Flag)

    Flag to set on the stress section

    Returns

    No return value

    Example

    To set flag f for stress section iss: 

    iss.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch stress section iss: 

    iss.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged stress sections will be sketched in

  • flag (Flag)

    Flag set on the stress sections that you want to sketch

  • redraw (optional) (boolean)

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

    StressSection.SketchFlagged(m, flag);

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

    Description

    Returns the total number of stress sections in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of stress sections

    Return type

    Number

    Example

    To get the total number of stress sections in model m: 

    var total = StressSection.Total(m);

    Unblank()

    Description

    Unblanks the stress section

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank stress section iss: 

    iss.Unblank();

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

    Description

    Unblanks all of the stress sections in the model.

    Arguments

  • Model (Model)

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

    StressSection.UnblankAll(m);

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

    Description

    Unblanks all of the flagged stress sections in the model.

    Arguments

  • Model (Model)

    Model that the flagged stress sections will be unblanked in

  • flag (Flag)

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

    StressSection.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the stress sections in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all stress sections will be unset in

  • flag (Flag)

    Flag to unset on the stress sections

    Returns

    No return value

    Example

    To unset the flag f on all the stress sections in model m: 

    StressSection.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the stress section.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch stress section iss: 

    iss.Unsketch();

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

    Description

    Unsketches all stress sections.

    Arguments

  • Model (Model)

    Model that all stress sections will be unblanked in

  • redraw (optional) (boolean)

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

    StressSection.UnsketchAll(m);

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

    Description

    Unsketches all flagged stress sections in the model.

    Arguments

  • Model (Model)

    Model that all stress sections will be unsketched in

  • flag (Flag)

    Flag set on the stress sections that you want to unsketch

  • redraw (optional) (boolean)

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

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

    StressSection object.

    Return type

    StressSection

    Example

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

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

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

    Description

    Adds a warning for stress section. 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 stress section iss: 

    iss.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this stress section.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for stress section iss: 

    var xrefs = iss.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for stress section iss in keyword format 

    var s = iss.toString();