Linear class

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

Linear constants

Name Description
Linear.GLOBAL CNST is *CONSTRAINED_LINEAR_GLOBAL.
Linear.LOCAL CNST is *CONSTRAINED_LINEAR_LOCAL.

Linear properties

Name Type Description
exists (read only) logical true if constrained linear exists, false if referred to but not defined.
format constant The Constrained Linear option. Can be Linear.GLOBAL or Linear.LOCAL.
include integer The Include file number that the constrained linear is in.
lcid integer Linear label
model (read only) integer The Model number that the constrained linear is in.
total (read only) integer Number of degree-of-freedom cards.

Detailed Description

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

Constructor

new Linear(Model[Model], format[constant], lcid[integer], nid[integer], dof[integer], coeff[real], cid (optional)[integer])

Description

Create a new Linear object.

Arguments

  • Model (Model)

    Model that Linear will be created in

  • format (constant)

    Specify the type of constrained linear. Can be Linear.GLOBAL or Linear.LOCAL)

  • lcid (integer)

    Linear label

  • nid (integer)

    Node id.

  • dof (integer)

    Degrees-of-Freedom.

  • coeff (real)

    Non-zero coefficient.

  • cid (optional) (integer)

    Coordinate System ID if format is Linear.LOCAL. The default value is 0.

    Returns

    Linear object

    Return type

    Linear

    Example

    To create a new constrained linear in model m of type LOCAL with lcid 1, nid 1, dof 3, coeff 0.5 and cid 2 

    var c_l = new Linear(m,Linear.LOCAL,1,1,3,0.5,2);

    Details of functions

    AddRowData(nid[integer], dof[integer], coeff[real], cid (optional)[integer])

    Description

    Used to add additional independent card 2 to the keyword. Adds this data to the end of the selected *CONSTRAINED_LINEAR

    Arguments

  • nid (integer)

    Node id.

  • dof (integer)

    Degrees-of-Freedom.

  • coeff (real)

    Non-zero coefficient.

  • cid (optional) (integer)

    Coordinate System ID if format is Linear.LOCAL. The default value is 0.

    Returns

    No return value

    Example

    To add NID 10 to the keyword c_l with dof 4, coeff 1.3, cid 2: 

    c_l.AddRowData(10,4,1.3,2);

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a constrained linear.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the constrained linear

    Returns

    No return value

    Example

    To associate comment c to the constrained linear c_l: 

    c_l.AssociateComment(c);

    Blank()

    Description

    Blanks the constrained linear

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank constrained linear c_l: 

    c_l.Blank();

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

    Description

    Blanks all of the constrained linears in the model.

    Arguments

  • Model (Model)

    Model that all constrained linears 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 constrained linears in model m: 

    Linear.BlankAll(m);

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

    Description

    Blanks all of the flagged constrained linears in the model.

    Arguments

  • Model (Model)

    Model that all the flagged constrained linears will be blanked in

  • flag (Flag)

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

    Linear.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the constrained linear is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if constrained linear c_l is blanked: 

    if (c_l.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 constrained linear c_l: 

    c_l.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the constrained linear.

    Arguments

  • flag (Flag)

    Flag to clear on the constrained linear

    Returns

    No return value

    Example

    To clear flag f for constrained linear c_l: 

    c_l.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    Linear object

    Return type

    Linear

    Example

    To copy constrained linear c_l into constrained linear z: 

    var z = c_l.Copy();

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

    Description

    Starts an interactive editing panel to create a constrained linear

    Arguments

  • Model (Model)

    Model that the constrained linear 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

    Linear object (or null if not made).

    Return type

    Linear

    Example

    To start creating a constrained linear in model m: 

    var c_l = Linear.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a constrained linear.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the constrained linear

    Returns

    No return value

    Example

    To detach comment c from the constrained linear c_l: 

    c_l.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 constrained linear c_l: 

    c_l.Edit();

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

    Description

    Adds an error for constrained linear. 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 constrained linear c_l: 

    c_l.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first constrained linear in the model.

    Arguments

  • Model (Model)

    Model to get first constrained linear in

    Returns

    Linear object (or null if there are no constrained linears in the model).

    Return type

    Linear

    Example

    To get the first constrained linear in model m: 

    var c_l = Linear.First(m);

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

    Description

    Returns the first free constrained linear label in the model. Also see Linear.LastFreeLabel(), Linear.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

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

    Linear label.

    Return type

    Number

    Example

    To get the first free constrained linear label in model m: 

    var label = Linear.FirstFreeLabel(m);

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

    Description

    Flags all of the constrained linears in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all constrained linears will be flagged in

  • flag (Flag)

    Flag to set on the constrained linears

    Returns

    No return value

    Example

    To flag all of the constrained linears with flag f in model m: 

    Linear.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the constrained linear is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the constrained linear

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if constrained linear c_l has flag f set on it: 

    if (c_l.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all constrained linears are in

  • func (function)

    Function to call for each constrained linear

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

    Linear.ForEach(m, test);
function test(c_l)
{
// c_l is Linear object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get constrained linears from

  • property (optional) (string)

    Name for property to get for all constrained linears in the model

    Returns

    Array of Linear objects or properties

    Return type

    Array

    Example

    To make an array of Linear objects for all of the constrained linears in model m: 

    var a = Linear.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a constrained linear.

    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 constrained linear c_l: 

    var comm_array = c_l.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get constrained linears from

  • flag (Flag)

    Flag set on the constrained linears that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged constrained linears in the model

    Returns

    Array of Linear objects or properties

    Return type

    Array

    Example

    To make an array of Linear objects for all of the constrained linears in model m flagged with f: 

    var c_l = Linear.GetFlagged(m, f);

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

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

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

    Description

    Returns the Linear object for a constrained linear ID.

    Arguments

  • Model (Model)

    Model to find the constrained linear in

  • number (integer)

    number of the constrained linear you want the Linear object for

    Returns

    Linear object (or null if constrained linear does not exist).

    Return type

    Linear

    Example

    To get the Linear object for constrained linear 100 in model m 

    var c_l = Linear.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    constrained linear property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if Linear property c_l.example is a parameter: 

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

    To check if Linear property c_l.example is a parameter by using the GetParameter method: 

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

    GetRowData(row_index[Integer])

    Description

    Returns independent card 2 for the selected row of the *CONSTRAINED_LINEAR.

    Arguments

  • row_index (Integer)

    The row index of the data to return. Note that indices start at 0, not 1.
    0 <= row_index < Linear.total

    Returns

    Array containing data.

    Return type

    Array

    Example

    To loop over all the lines of the keyword for c_l: 

    for (i=0; i<c_l.total; i++)
        var data = c_l.GetRowData(i);

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for Linear c_l: 

    var key = c_l.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for Linear c_l: 

    var cards = c_l.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last constrained linear in the model.

    Arguments

  • Model (Model)

    Model to get last constrained linear in

    Returns

    Linear object (or null if there are no constrained linears in the model).

    Return type

    Linear

    Example

    To get the last constrained linear in model m: 

    var c_l = Linear.Last(m);

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

    Description

    Returns the last free constrained linear label in the model. Also see Linear.FirstFreeLabel(), Linear.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

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

    Linear label.

    Return type

    Number

    Example

    To get the last free constrained linear label in model m: 

    var label = Linear.LastFreeLabel(m);

    Next()

    Description

    Returns the next constrained linear in the model.

    Arguments

    No arguments

    Returns

    Linear object (or null if there are no more constrained linears in the model).

    Return type

    Linear

    Example

    To get the constrained linear in model m after constrained linear c_l: 

    var c_l = c_l.Next();

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

    Description

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

    Arguments

  • Model (Model)

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

    Linear label.

    Return type

    Number

    Example

    To get the next free constrained linear label in model m: 

    var label = Linear.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 constrained linear.

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

    Linear object (or null if not picked)

    Return type

    Linear

    Example

    To pick a constrained linear from model m giving the prompt 'Pick constrained linear from screen': 

    var c_l = Linear.Pick('Pick constrained linear from screen', m);

    Previous()

    Description

    Returns the previous constrained linear in the model.

    Arguments

    No arguments

    Returns

    Linear object (or null if there are no more constrained linears in the model).

    Return type

    Linear

    Example

    To get the constrained linear in model m before constrained linear c_l: 

    var c_l = c_l.Previous();

    RemoveRowData(row_index[Integer])

    Description

    Removes an independent card 2 for the selected row on the *CONSTRAINED_LINEAR.

    Arguments

  • row_index (Integer)

    The row index of the data to return. Note that indices start at 0, not 1.
    0 <= row_index < Linear.total

    Returns

    No return value.

    Example

    To remove row 2 for c_l: 

     c_l.RemoveRowData(1);

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

    Description

    Renumbers all of the constrained linears in the model.

    Arguments

  • Model (Model)

    Model that all constrained linears will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Linear.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged constrained linears in the model.

    Arguments

  • Model (Model)

    Model that all the flagged constrained linears will be renumbered in

  • flag (Flag)

    Flag set on the constrained linears that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Linear.RenumberFlagged(m, f, 1000000);

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

    Description

    Allows the user to select constrained linears using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting constrained linears

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    Linear.Select(f, 'Select constrained linears', m);

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

    Linear.Select(f, 'Select constrained linears', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the constrained linear.

    Arguments

  • flag (Flag)

    Flag to set on the constrained linear

    Returns

    No return value

    Example

    To set flag f for constrained linear c_l: 

    c_l.SetFlag(f);

    SetRowData(row_index[Integer], nid[integer], dof[integer], coeff[real], cid (optional)[integer])

    Description

    Used to reset values in already existing card 2 in the selected row of *CONSTRAINED_LINEAR

    Arguments

  • row_index (Integer)

    The row index of the data to return. Note that indices start at 0, not 1.
    0 <= row_index < Linear.total

  • nid (integer)

    Node id.

  • dof (integer)

    Degrees-of-Freedom.

  • coeff (real)

    Non-zero coefficient.

  • cid (optional) (integer)

    Coordinate System ID if format is Linear.LOCAL. The default value is 0.

    Returns

    No return value

    Example

    To reset the values of row 3 of the keyword with NID 11, dof 2, coeff 3.2, cid 4: 

    c_l.SetRowData(2,11,2,3.2,4);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the constrained linear. The constrained linear will be sketched until you either call Linear.Unsketch(), Linear.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch constrained linear c_l: 

    c_l.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged constrained linears will be sketched in

  • flag (Flag)

    Flag set on the constrained linears that you want to sketch

  • redraw (optional) (boolean)

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

    Linear.SketchFlagged(m, flag);

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

    Description

    Returns the total number of constrained linears in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of constrained linears

    Return type

    Number

    Example

    To get the total number of constrained linears in model m: 

    var total = Linear.Total(m);

    Unblank()

    Description

    Unblanks the constrained linear

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank constrained linear c_l: 

    c_l.Unblank();

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

    Description

    Unblanks all of the constrained linears in the model.

    Arguments

  • Model (Model)

    Model that all constrained linears 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 constrained linears in model m: 

    Linear.UnblankAll(m);

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

    Description

    Unblanks all of the flagged constrained linears in the model.

    Arguments

  • Model (Model)

    Model that the flagged constrained linears will be unblanked in

  • flag (Flag)

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

    Linear.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the constrained linears in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all constrained linears will be unset in

  • flag (Flag)

    Flag to unset on the constrained linears

    Returns

    No return value

    Example

    To unset the flag f on all the constrained linears in model m: 

    Linear.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the constrained linear.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch constrained linear c_l: 

    c_l.Unsketch();

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

    Description

    Unsketches all constrained linears.

    Arguments

  • Model (Model)

    Model that all constrained linears will be unblanked in

  • redraw (optional) (boolean)

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

    Linear.UnsketchAll(m);

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

    Description

    Unsketches all flagged constrained linears in the model.

    Arguments

  • Model (Model)

    Model that all constrained linears will be unsketched in

  • flag (Flag)

    Flag set on the constrained linears that you want to unsketch

  • redraw (optional) (boolean)

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

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

    Linear object.

    Return type

    Linear

    Example

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

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

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

    Description

    Adds a warning for constrained linear. 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 constrained linear c_l: 

    c_l.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this constrained linear.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for constrained linear c_l: 

    var xrefs = c_l.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for Linear c_l in keyword format 

    var s = c_l.toString();