NodeSet class

The NodeSet class gives you access to constrained node set cards in PRIMER, not set node cards. For access to set node cards, refer to the Set class. More...

The PRIMER JavaScript API provides many class constants, properties and methods. For Arup to be able to extend and enhance the API in the future any constant, property or method names beginning with a lowercase or uppercase letter are reserved.
If you need to add your own properties or methods to one of the existing classes then to avoid any potential future conflict you should ensure that the name begins with either an underscore (_) or a dollar sign ($) or the name is prefixed with your own unique identifier.
For example if company 'ABC' need to add a property called 'example' then to avoid any potential future conflict use one of:

Class functions

Member functions

NodeSet properties

Name Type Description
cnsid integer Constrained node set number (identical to label).
colour Colour The colour of the node set
dof integer Degree of freedom.
exists (read only) logical true if node set exists, false if referred to but not defined.
id logical true if _ID option is set, false if not
include integer The Include file number that the node set is in.
label integer Constrained node set number.
model (read only) integer The Model number that the node set is in.
nsid integer Set Node ID.
tf real Failure time.

Detailed Description

The NodeSet class allows you to create, modify, edit and manipulate constrained node set cards. See the documentation below for more details.

Constructor

new NodeSet(Model[Model], nsid[integer], dof[integer], tf[real], label (optional)[integer])

Description

Create a new NodeSet object.

Arguments

  • Model (Model)

    Model that constrained node set will be created in

  • nsid (integer)

    Set Node ID.

  • dof (integer)

    Degree of freedom.

  • tf (real)

    Failure time.

  • label (optional) (integer)

    Constrained node set number.

    Returns

    NodeSet object

    Return type

    NodeSet

    Example

    To create a new constrained node set 500 in model m, of type SET, with node set 9, degree of freedom 1 and failure time 1000 

    var n = new NodeSet(m, 9, 1, 1000, 500);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a node set.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the node set

    Returns

    No return value

    Example

    To associate comment c to the node set ns: 

    ns.AssociateComment(c);

    Blank()

    Description

    Blanks the node set

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank node set ns: 

    ns.Blank();

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

    Description

    Blanks all of the node sets in the model.

    Arguments

  • Model (Model)

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

    NodeSet.BlankAll(m);

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

    Description

    Blanks all of the flagged node sets in the model.

    Arguments

  • Model (Model)

    Model that all the flagged node sets will be blanked in

  • flag (Flag)

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

    NodeSet.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the node set is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if node set ns is blanked: 

    if (ns.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 node set ns: 

    ns.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the node set.

    Arguments

  • flag (Flag)

    Flag to clear on the node set

    Returns

    No return value

    Example

    To clear flag f for node set ns: 

    ns.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    NodeSet object

    Return type

    NodeSet

    Example

    To copy node set ns into node set z: 

    var z = ns.Copy();

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

    Description

    Starts an interactive editing panel to create a node set

    Arguments

  • Model (Model)

    Model that the node set 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

    NodeSet object (or null if not made).

    Return type

    NodeSet

    Example

    To start creating a node set in model m: 

    var ns = NodeSet.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a node set.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the node set

    Returns

    No return value

    Example

    To detach comment c from the node set ns: 

    ns.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 node set ns: 

    ns.Edit();

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

    Description

    Adds an error for node set. 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 node set ns: 

    ns.Error("My custom error");

    ExtractColour()

    Description

    Extracts the actual colour used for node set.
    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 node set 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 node set.

    Arguments

    No arguments

    Returns

    colour value (integer)

    Return type

    Number

    Example

    To return the colour used for drawing node set ns: 

    var colour = ns.ExtractColour();

    First(Model[Model]) [static]

    Description

    Returns the first node set in the model.

    Arguments

  • Model (Model)

    Model to get first node set in

    Returns

    NodeSet object (or null if there are no node sets in the model).

    Return type

    NodeSet

    Example

    To get the first node set in model m: 

    var ns = NodeSet.First(m);

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

    Description

    Returns the first free node set label in the model. Also see NodeSet.LastFreeLabel(), NodeSet.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

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

    NodeSet label.

    Return type

    Number

    Example

    To get the first free node set label in model m: 

    var label = NodeSet.FirstFreeLabel(m);

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

    Description

    Flags all of the node sets in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all node sets will be flagged in

  • flag (Flag)

    Flag to set on the node sets

    Returns

    No return value

    Example

    To flag all of the node sets with flag f in model m: 

    NodeSet.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the node set is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the node set

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if node set ns has flag f set on it: 

    if (ns.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all node sets are in

  • func (function)

    Function to call for each node set

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

    NodeSet.ForEach(m, test);
function test(ns)
{
// ns is NodeSet object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get node sets from

  • property (optional) (string)

    Name for property to get for all node sets in the model

    Returns

    Array of NodeSet objects or properties

    Return type

    Array

    Example

    To make an array of NodeSet objects for all of the node sets in model m: 

    var a = NodeSet.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a node set.

    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 node set ns: 

    var comm_array = ns.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get node sets from

  • flag (Flag)

    Flag set on the node sets that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged node sets in the model

    Returns

    Array of NodeSet objects or properties

    Return type

    Array

    Example

    To make an array of NodeSet objects for all of the node sets in model m flagged with f: 

    var ns = NodeSet.GetFlagged(m, f);

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

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

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

    Description

    Returns the NodeSet object for a node set ID.

    Arguments

  • Model (Model)

    Model to find the node set in

  • number (integer)

    number of the node set you want the NodeSet object for

    Returns

    NodeSet object (or null if node set does not exist).

    Return type

    NodeSet

    Example

    To get the NodeSet object for node set 100 in model m 

    var ns = NodeSet.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    node set property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if NodeSet property ns.example is a parameter: 

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

    To check if NodeSet property ns.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for node_set n: 

    var key = n.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for node_set n: 

    var cards = n.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last node set in the model.

    Arguments

  • Model (Model)

    Model to get last node set in

    Returns

    NodeSet object (or null if there are no node sets in the model).

    Return type

    NodeSet

    Example

    To get the last node set in model m: 

    var ns = NodeSet.Last(m);

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

    Description

    Returns the last free node set label in the model. Also see NodeSet.FirstFreeLabel(), NodeSet.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

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

    NodeSet label.

    Return type

    Number

    Example

    To get the last free node set label in model m: 

    var label = NodeSet.LastFreeLabel(m);

    Next()

    Description

    Returns the next node set in the model.

    Arguments

    No arguments

    Returns

    NodeSet object (or null if there are no more node sets in the model).

    Return type

    NodeSet

    Example

    To get the node set in model m after node set ns: 

    var ns = ns.Next();

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

    Description

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

    Arguments

  • Model (Model)

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

    NodeSet label.

    Return type

    Number

    Example

    To get the next free node set label in model m: 

    var label = NodeSet.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 node set.

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

    NodeSet object (or null if not picked)

    Return type

    NodeSet

    Example

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

    var ns = NodeSet.Pick('Pick node set from screen', m);

    Previous()

    Description

    Returns the previous node set in the model.

    Arguments

    No arguments

    Returns

    NodeSet object (or null if there are no more node sets in the model).

    Return type

    NodeSet

    Example

    To get the node set in model m before node set ns: 

    var ns = ns.Previous();

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

    Description

    Renumbers all of the node sets in the model.

    Arguments

  • Model (Model)

    Model that all node sets will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    NodeSet.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged node sets in the model.

    Arguments

  • Model (Model)

    Model that all the flagged node sets will be renumbered in

  • flag (Flag)

    Flag set on the node sets that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    NodeSet.RenumberFlagged(m, f, 1000000);

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

    Description

    Allows the user to select node sets using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting node sets

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    NodeSet.Select(f, 'Select node sets', m);

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

    NodeSet.Select(f, 'Select node sets', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the node set.

    Arguments

  • flag (Flag)

    Flag to set on the node set

    Returns

    No return value

    Example

    To set flag f for node set ns: 

    ns.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch node set ns: 

    ns.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged node sets will be sketched in

  • flag (Flag)

    Flag set on the node sets that you want to sketch

  • redraw (optional) (boolean)

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

    NodeSet.SketchFlagged(m, flag);

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

    Description

    Returns the total number of node sets in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of node sets

    Return type

    Number

    Example

    To get the total number of node sets in model m: 

    var total = NodeSet.Total(m);

    Unblank()

    Description

    Unblanks the node set

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank node set ns: 

    ns.Unblank();

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

    Description

    Unblanks all of the node sets in the model.

    Arguments

  • Model (Model)

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

    NodeSet.UnblankAll(m);

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

    Description

    Unblanks all of the flagged node sets in the model.

    Arguments

  • Model (Model)

    Model that the flagged node sets will be unblanked in

  • flag (Flag)

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

    NodeSet.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the node sets in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all node sets will be unset in

  • flag (Flag)

    Flag to unset on the node sets

    Returns

    No return value

    Example

    To unset the flag f on all the node sets in model m: 

    NodeSet.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the node set.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch node set ns: 

    ns.Unsketch();

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

    Description

    Unsketches all node sets.

    Arguments

  • Model (Model)

    Model that all node sets will be unblanked in

  • redraw (optional) (boolean)

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

    NodeSet.UnsketchAll(m);

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

    Description

    Unsketches all flagged node sets in the model.

    Arguments

  • Model (Model)

    Model that all node sets will be unsketched in

  • flag (Flag)

    Flag set on the node sets that you want to unsketch

  • redraw (optional) (boolean)

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

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

    NodeSet object.

    Return type

    NodeSet

    Example

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

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

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

    Description

    Adds a warning for node set. 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 node set ns: 

    ns.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this node set.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for node set ns: 

    var xrefs = ns.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for node set n in keyword format 

    var s = n.toString();