Discrete class

The Discrete class gives you access to element discrete 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

Discrete properties

Name Type Description
colour Colour The colour of the discrete
eid integer Discrete number. Also see the label property which is an alternative name for this.
exists (read only) logical true if discrete exists, false if referred to but not defined.
include integer The Include file number that the discrete is in.
label integer Discrete number. Also see the eid property which is an alternative name for this.
lcid integer Loadcurve for offset vs time
lciddr integer Loadcurve for offset vs time during dynamic relaxation
lco boolean If LCO option is set. Can be true or false
model (read only) integer The Model number that the discrete is in.
n1 integer Node number 1
n2 integer Node number 2
offset real Initial offset
pf integer Print flag. Set to write forces to the DEFORC file
pid integer Part number
s real Scale factor on forces
transparency integer The transparency of the discrete (0-100) 0% is opaque, 100% is transparent.
vid integer Orientation vector

Detailed Description

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

Constructor

new Discrete(Model[Model], eid[integer], pid[integer], n1[integer], n2[integer], vid (optional)[integer], s (optional)[real], pf (optional)[integer], offset (optional)[real])

Description

Create a new Discrete object.

Arguments

  • Model (Model)

    Model that discrete will be created in

  • eid (integer)

    Discrete number

  • pid (integer)

    Part number

  • n1 (integer)

    Node number 1

  • n2 (integer)

    Node number 2

  • vid (optional) (integer)

    Orientation vector

  • s (optional) (real)

    Scale factor on forces

  • pf (optional) (integer)

    Print flag. Set to write forces to the DEFORC file

  • offset (optional) (real)

    Initial offset

    Returns

    Discrete object

    Return type

    Discrete

    Example

    To create a new discrete in model m with label 200, in part 10, on nodes 1 and 2 

    var m = new Discrete(m, 200, 10, 1, 2);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a discrete.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the discrete

    Returns

    No return value

    Example

    To associate comment c to the discrete d: 

    d.AssociateComment(c);

    Blank()

    Description

    Blanks the discrete

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank discrete d: 

    d.Blank();

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

    Description

    Blanks all of the discretes in the model.

    Arguments

  • Model (Model)

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

    Discrete.BlankAll(m);

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

    Description

    Blanks all of the flagged discretes in the model.

    Arguments

  • Model (Model)

    Model that all the flagged discretes will be blanked in

  • flag (Flag)

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

    Discrete.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the discrete is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if discrete d is blanked: 

    if (d.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 discrete d: 

    d.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the discrete.

    Arguments

  • flag (Flag)

    Flag to clear on the discrete

    Returns

    No return value

    Example

    To clear flag f for discrete d: 

    d.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    Discrete object

    Return type

    Discrete

    Example

    To copy discrete d into discrete z: 

    var z = d.Copy();

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

    Description

    Starts an interactive editing panel to create a discrete

    Arguments

  • Model (Model)

    Model that the discrete 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

    Discrete object (or null if not made).

    Return type

    Discrete

    Example

    To start creating a discrete in model m: 

    var d = Discrete.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a discrete.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the discrete

    Returns

    No return value

    Example

    To detach comment c from the discrete d: 

    d.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 discrete d: 

    d.Edit();

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

    Description

    Adds an error for discrete. 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 discrete d: 

    d.Error("My custom error");

    ExtractColour()

    Description

    Extracts the actual colour used for discrete.
    By default in PRIMER many entities such as elements get their colour automatically from the part that they are in. PRIMER cycles through 13 default colours based on the label of the entity. In this case the discrete colour property will return the value Colour.PART instead of the actual colour. This method will return the actual colour which is used for drawing the discrete.

    Arguments

    No arguments

    Returns

    colour value (integer)

    Return type

    Number

    Example

    To return the colour used for drawing discrete d: 

    var colour = d.ExtractColour();

    First(Model[Model]) [static]

    Description

    Returns the first discrete in the model.

    Arguments

  • Model (Model)

    Model to get first discrete in

    Returns

    Discrete object (or null if there are no discretes in the model).

    Return type

    Discrete

    Example

    To get the first discrete in model m: 

    var d = Discrete.First(m);

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

    Description

    Returns the first free discrete label in the model. Also see Discrete.LastFreeLabel(), Discrete.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

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

    Discrete label.

    Return type

    Number

    Example

    To get the first free discrete label in model m: 

    var label = Discrete.FirstFreeLabel(m);

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

    Description

    Flags all of the discretes in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all discretes will be flagged in

  • flag (Flag)

    Flag to set on the discretes

    Returns

    No return value

    Example

    To flag all of the discretes with flag f in model m: 

    Discrete.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the discrete is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the discrete

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if discrete d has flag f set on it: 

    if (d.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all discretes are in

  • func (function)

    Function to call for each discrete

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

    Discrete.ForEach(m, test);
function test(d)
{
// d is Discrete object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get discretes from

  • property (optional) (string)

    Name for property to get for all discretes in the model

    Returns

    Array of Discrete objects or properties

    Return type

    Array

    Example

    To make an array of Discrete objects for all of the discretes in model m: 

    var a = Discrete.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a discrete.

    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 discrete d: 

    var comm_array = d.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get discretes from

  • flag (Flag)

    Flag set on the discretes that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged discretes in the model

    Returns

    Array of Discrete objects or properties

    Return type

    Array

    Example

    To make an array of Discrete objects for all of the discretes in model m flagged with f: 

    var d = Discrete.GetFlagged(m, f);

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

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

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

    Description

    Returns the Discrete object for a discrete ID.

    Arguments

  • Model (Model)

    Model to find the discrete in

  • number (integer)

    number of the discrete you want the Discrete object for

    Returns

    Discrete object (or null if discrete does not exist).

    Return type

    Discrete

    Example

    To get the Discrete object for discrete 100 in model m 

    var d = Discrete.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    discrete property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if Discrete property d.example is a parameter: 

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

    To check if Discrete property d.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for discrete m: 

    var key = m.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for discrete d: 

    var cards = d.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last discrete in the model.

    Arguments

  • Model (Model)

    Model to get last discrete in

    Returns

    Discrete object (or null if there are no discretes in the model).

    Return type

    Discrete

    Example

    To get the last discrete in model m: 

    var d = Discrete.Last(m);

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

    Description

    Returns the last free discrete label in the model. Also see Discrete.FirstFreeLabel(), Discrete.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

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

    Discrete label.

    Return type

    Number

    Example

    To get the last free discrete label in model m: 

    var label = Discrete.LastFreeLabel(m);

    Next()

    Description

    Returns the next discrete in the model.

    Arguments

    No arguments

    Returns

    Discrete object (or null if there are no more discretes in the model).

    Return type

    Discrete

    Example

    To get the discrete in model m after discrete d: 

    var d = d.Next();

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

    Description

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

    Arguments

  • Model (Model)

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

    Discrete label.

    Return type

    Number

    Example

    To get the next free discrete label in model m: 

    var label = Discrete.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 discrete.

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

    Discrete object (or null if not picked)

    Return type

    Discrete

    Example

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

    var d = Discrete.Pick('Pick discrete from screen', m);

    Previous()

    Description

    Returns the previous discrete in the model.

    Arguments

    No arguments

    Returns

    Discrete object (or null if there are no more discretes in the model).

    Return type

    Discrete

    Example

    To get the discrete in model m before discrete d: 

    var d = d.Previous();

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

    Description

    Renumbers all of the discretes in the model.

    Arguments

  • Model (Model)

    Model that all discretes will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Discrete.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged discretes in the model.

    Arguments

  • Model (Model)

    Model that all the flagged discretes will be renumbered in

  • flag (Flag)

    Flag set on the discretes that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Discrete.RenumberFlagged(m, f, 1000000);

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

    Description

    Allows the user to select discretes using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting discretes

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    Discrete.Select(f, 'Select discretes', m);

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

    Discrete.Select(f, 'Select discretes', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the discrete.

    Arguments

  • flag (Flag)

    Flag to set on the discrete

    Returns

    No return value

    Example

    To set flag f for discrete d: 

    d.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch discrete d: 

    d.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged discretes will be sketched in

  • flag (Flag)

    Flag set on the discretes that you want to sketch

  • redraw (optional) (boolean)

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

    Discrete.SketchFlagged(m, flag);

    Timestep()

    Description

    Calculates the timestep for the discrete

    Arguments

    No arguments

    Returns

    real

    Return type

    Number

    Example

    To calculate the timestep for discrete d: 

    var timestep = d.Timestep();

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

    Description

    Returns the total number of discretes in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of discretes

    Return type

    Number

    Example

    To get the total number of discretes in model m: 

    var total = Discrete.Total(m);

    Unblank()

    Description

    Unblanks the discrete

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank discrete d: 

    d.Unblank();

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

    Description

    Unblanks all of the discretes in the model.

    Arguments

  • Model (Model)

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

    Discrete.UnblankAll(m);

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

    Description

    Unblanks all of the flagged discretes in the model.

    Arguments

  • Model (Model)

    Model that the flagged discretes will be unblanked in

  • flag (Flag)

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

    Discrete.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the discretes in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all discretes will be unset in

  • flag (Flag)

    Flag to unset on the discretes

    Returns

    No return value

    Example

    To unset the flag f on all the discretes in model m: 

    Discrete.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the discrete.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch discrete d: 

    d.Unsketch();

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

    Description

    Unsketches all discretes.

    Arguments

  • Model (Model)

    Model that all discretes will be unblanked in

  • redraw (optional) (boolean)

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

    Discrete.UnsketchAll(m);

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

    Description

    Unsketches all flagged discretes in the model.

    Arguments

  • Model (Model)

    Model that all discretes will be unsketched in

  • flag (Flag)

    Flag set on the discretes that you want to unsketch

  • redraw (optional) (boolean)

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

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

    Discrete object.

    Return type

    Discrete

    Example

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

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

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

    Description

    Adds a warning for discrete. 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 discrete d: 

    d.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this discrete.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for discrete d: 

    var xrefs = d.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for discrete d in keyword format 

    var s = d.toString();