Slipring class

The Slipring class gives you access to seatbelt slipring 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

Slipring properties

Name Type Description
colour Colour The colour of the slipring
dc real Optional decay constant to allow a smooth transition between the static and dynamic friction coefficients.
direct integer Direction of belt movement
exists (read only) logical true if slipring exists, false if referred to but not defined.
fc real Coulomb dynamic friction coefficient
fcs real Coulomb static friction coefficient
funcid integer Function ID to determine friction coefficient
include integer The Include file number that the slipring is in.
k real Optional coefficient for determining the Coulomb friction coefficient related to angle alpha
label integer Slipring number. Also see the sbsrid property which is an alternative name for this.
lcnffd integer Loadcurve for Coulomb dynamic friction
lcnffs integer Loadcurve for Coulomb static friction
ltime real Slipring lockup time
model (read only) integer The Model number that the slipring is in.
onid integer Orientation Node number
sbid1 integer Seatbelt number 1 (or Set Shell number if sbrnid is negative).
sbid2 integer Seatbelt number 2 (or Set Shell number if sbrnid is negative).
sbrnid integer Node number (or Set Node number if negative)
sbsrid integer Slipring number. Also see the label property which is an alternative name for this.
shell_seatbelt (read only) logical true if slipring is used for shell (2D) seatbelt elements.
transparency integer The transparency of the slipring (0-100) 0% is opaque, 100% is transparent.

Detailed Description

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

Constructor

new Slipring(Model[Model], sbsrid[integer], sbid1[integer], sbid2[integer], sbrnid[integer])

Description

Create a new Seatbelt Slipring object.

Arguments

  • Model (Model)

    Model that slipring will be created in

  • sbsrid (integer)

    Slipring number.

  • sbid1 (integer)

    Seatbelt number 1

  • sbid2 (integer)

    Seatbelt number 2

  • sbrnid (integer)

    Slipring Node number

    Returns

    Slipring object

    Return type

    Slipring

    Example

    To create a new seatbelt slipring in model m with label 100, seatbelts 10, 11 and node 20: 

    var a = new Slipring(m, 100, 10, 11, 20);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a slipring.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the slipring

    Returns

    No return value

    Example

    To associate comment c to the slipring s: 

    s.AssociateComment(c);

    Blank()

    Description

    Blanks the slipring

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank slipring s: 

    s.Blank();

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

    Description

    Blanks all of the sliprings in the model.

    Arguments

  • Model (Model)

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

    Slipring.BlankAll(m);

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

    Description

    Blanks all of the flagged sliprings in the model.

    Arguments

  • Model (Model)

    Model that all the flagged sliprings will be blanked in

  • flag (Flag)

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

    Slipring.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the slipring is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if slipring s is blanked: 

    if (s.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 slipring s: 

    s.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the slipring.

    Arguments

  • flag (Flag)

    Flag to clear on the slipring

    Returns

    No return value

    Example

    To clear flag f for slipring s: 

    s.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    Slipring object

    Return type

    Slipring

    Example

    To copy slipring s into slipring z: 

    var z = s.Copy();

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

    Description

    Starts an interactive editing panel to create a slipring

    Arguments

  • Model (Model)

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

    Slipring object (or null if not made).

    Return type

    Slipring

    Example

    To start creating a slipring in model m: 

    var s = Slipring.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a slipring.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the slipring

    Returns

    No return value

    Example

    To detach comment c from the slipring s: 

    s.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 slipring s: 

    s.Edit();

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

    Description

    Adds an error for slipring. 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 slipring s: 

    s.Error("My custom error");

    ExtractColour()

    Description

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

    Arguments

    No arguments

    Returns

    colour value (integer)

    Return type

    Number

    Example

    To return the colour used for drawing slipring s: 

    var colour = s.ExtractColour();

    First(Model[Model]) [static]

    Description

    Returns the first slipring in the model.

    Arguments

  • Model (Model)

    Model to get first slipring in

    Returns

    Slipring object (or null if there are no sliprings in the model).

    Return type

    Slipring

    Example

    To get the first slipring in model m: 

    var s = Slipring.First(m);

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

    Description

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

    Arguments

  • Model (Model)

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

    Slipring label.

    Return type

    Number

    Example

    To get the first free slipring label in model m: 

    var label = Slipring.FirstFreeLabel(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all sliprings will be flagged in

  • flag (Flag)

    Flag to set on the sliprings

    Returns

    No return value

    Example

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

    Slipring.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the slipring is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the slipring

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if slipring s has flag f set on it: 

    if (s.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all sliprings are in

  • func (function)

    Function to call for each slipring

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

    Slipring.ForEach(m, test);
function test(s)
{
// s is Slipring object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get sliprings from

  • property (optional) (string)

    Name for property to get for all sliprings in the model

    Returns

    Array of Slipring objects or properties

    Return type

    Array

    Example

    To make an array of Slipring objects for all of the sliprings in model m: 

    var a = Slipring.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a slipring.

    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 slipring s: 

    var comm_array = s.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get sliprings from

  • flag (Flag)

    Flag set on the sliprings that you want to retrieve

  • property (optional) (string)

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

    Returns

    Array of Slipring objects or properties

    Return type

    Array

    Example

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

    var s = Slipring.GetFlagged(m, f);

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

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

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

    Description

    Returns the Slipring object for a slipring ID.

    Arguments

  • Model (Model)

    Model to find the slipring in

  • number (integer)

    number of the slipring you want the Slipring object for

    Returns

    Slipring object (or null if slipring does not exist).

    Return type

    Slipring

    Example

    To get the Slipring object for slipring 100 in model m 

    var s = Slipring.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    slipring property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if Slipring property s.example is a parameter: 

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

    To check if Slipring property s.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for slipring s: 

    var key = s.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for slipring s: 

    var cards = s.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last slipring in the model.

    Arguments

  • Model (Model)

    Model to get last slipring in

    Returns

    Slipring object (or null if there are no sliprings in the model).

    Return type

    Slipring

    Example

    To get the last slipring in model m: 

    var s = Slipring.Last(m);

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

    Description

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

    Arguments

  • Model (Model)

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

    Slipring label.

    Return type

    Number

    Example

    To get the last free slipring label in model m: 

    var label = Slipring.LastFreeLabel(m);

    Next()

    Description

    Returns the next slipring in the model.

    Arguments

    No arguments

    Returns

    Slipring object (or null if there are no more sliprings in the model).

    Return type

    Slipring

    Example

    To get the slipring in model m after slipring s: 

    var s = s.Next();

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

    Description

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

    Arguments

  • Model (Model)

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

    Slipring label.

    Return type

    Number

    Example

    To get the next free slipring label in model m: 

    var label = Slipring.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 slipring.

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

    Slipring object (or null if not picked)

    Return type

    Slipring

    Example

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

    var s = Slipring.Pick('Pick slipring from screen', m);

    Previous()

    Description

    Returns the previous slipring in the model.

    Arguments

    No arguments

    Returns

    Slipring object (or null if there are no more sliprings in the model).

    Return type

    Slipring

    Example

    To get the slipring in model m before slipring s: 

    var s = s.Previous();

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

    Description

    Renumbers all of the sliprings in the model.

    Arguments

  • Model (Model)

    Model that all sliprings will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Slipring.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged sliprings in the model.

    Arguments

  • Model (Model)

    Model that all the flagged sliprings will be renumbered in

  • flag (Flag)

    Flag set on the sliprings that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Slipring.RenumberFlagged(m, f, 1000000);

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting sliprings

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    Slipring.Select(f, 'Select sliprings', m);

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

    Slipring.Select(f, 'Select sliprings', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the slipring.

    Arguments

  • flag (Flag)

    Flag to set on the slipring

    Returns

    No return value

    Example

    To set flag f for slipring s: 

    s.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch slipring s: 

    s.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged sliprings will be sketched in

  • flag (Flag)

    Flag set on the sliprings that you want to sketch

  • redraw (optional) (boolean)

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

    Slipring.SketchFlagged(m, flag);

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

    Description

    Returns the total number of sliprings in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of sliprings

    Return type

    Number

    Example

    To get the total number of sliprings in model m: 

    var total = Slipring.Total(m);

    Unblank()

    Description

    Unblanks the slipring

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank slipring s: 

    s.Unblank();

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

    Description

    Unblanks all of the sliprings in the model.

    Arguments

  • Model (Model)

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

    Slipring.UnblankAll(m);

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

    Description

    Unblanks all of the flagged sliprings in the model.

    Arguments

  • Model (Model)

    Model that the flagged sliprings will be unblanked in

  • flag (Flag)

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

    Slipring.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the sliprings

    Returns

    No return value

    Example

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

    Slipring.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the slipring.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch slipring s: 

    s.Unsketch();

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

    Description

    Unsketches all sliprings.

    Arguments

  • Model (Model)

    Model that all sliprings will be unblanked in

  • redraw (optional) (boolean)

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

    Slipring.UnsketchAll(m);

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

    Description

    Unsketches all flagged sliprings in the model.

    Arguments

  • Model (Model)

    Model that all sliprings will be unsketched in

  • flag (Flag)

    Flag set on the sliprings that you want to unsketch

  • redraw (optional) (boolean)

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

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

    Slipring object.

    Return type

    Slipring

    Example

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

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

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

    Description

    Adds a warning for slipring. 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 slipring s: 

    s.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this slipring.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for slipring s: 

    var xrefs = s.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for slipring s in keyword format 

    var str = s.toString();