Sensor class

The Sensor class gives you access to seatbelt sensor 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

Sensor properties

Name Type Description
acc real Activating acceleration.
atime real Time over which acceleration must be exceeded.
colour Colour The colour of the sensor
dmn real Minimum distance
dmx real Maximum distance
dof integer Degree of freedom.
exists (read only) logical true if sensor exists, false if referred to but not defined.
include integer The Include file number that the sensor is in.
label integer Sensor number. Also see the sbacid property which is an alternative name for this.
model (read only) integer The Model number that the sensor is in.
nid integer Node number.
nid1 integer Node number 1
nid2 integer Node number 2
pulmn real Maximum pull-out
pulmx real Maximum pull-out
pulrat real Rate of pull-out (length/time units)
pultim real Time over which rate of pull#out must be exceeded
sbrid integer Retractor number (for sbstyp = 2 OR 5).
sbsfl integer Sensor flag.
sbsid integer Sensor number. Also see the label property which is an alternative name for this.
sbstyp integer Sensor type.
time real Time at which sensor triggers
transparency integer The transparency of the sensor (0-100) 0% is opaque, 100% is transparent.

Detailed Description

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

Constructor

new Sensor(Model[Model], sbsid[integer], sbstyp[integer], sbsfl (optional)[integer], nid (optional)[integer], nid2 (optional)[integer])

Description

Create a new Seatbelt Sensor object.

Arguments

  • Model (Model)

    Model that sensor will be created in

  • sbsid (integer)

    Sensor number.

  • sbstyp (integer)

    Sensor type

  • sbsfl (optional) (integer)

    Sensor flag. Default 0.

  • nid (optional) (integer)

    Optional node ID: Compulsory for types 1 and 4.

  • nid2 (optional) (integer)

    Optional node ID 2: Compulsory for type 4.

    Returns

    Sensor object

    Return type

    Sensor

    Example

    To create a new seatbelt sensor in model m with label 100, type 1 and node 1: 

    var s = new Sensor(m, 100, 1, 0, 1);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a sensor.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the sensor

    Returns

    No return value

    Example

    To associate comment c to the sensor s: 

    s.AssociateComment(c);

    Blank()

    Description

    Blanks the sensor

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank sensor s: 

    s.Blank();

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

    Description

    Blanks all of the sensors in the model.

    Arguments

  • Model (Model)

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

    Sensor.BlankAll(m);

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

    Description

    Blanks all of the flagged sensors in the model.

    Arguments

  • Model (Model)

    Model that all the flagged sensors will be blanked in

  • flag (Flag)

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

    Sensor.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the sensor is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if sensor 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 sensor s: 

    s.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the sensor.

    Arguments

  • flag (Flag)

    Flag to clear on the sensor

    Returns

    No return value

    Example

    To clear flag f for sensor s: 

    s.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    Sensor object

    Return type

    Sensor

    Example

    To copy sensor s into sensor z: 

    var z = s.Copy();

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

    Description

    Starts an interactive editing panel to create a sensor

    Arguments

  • Model (Model)

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

    Sensor object (or null if not made).

    Return type

    Sensor

    Example

    To start creating a sensor in model m: 

    var s = Sensor.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a sensor.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the sensor

    Returns

    No return value

    Example

    To detach comment c from the sensor 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 sensor s: 

    s.Edit();

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

    Description

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

    s.Error("My custom error");

    ExtractColour()

    Description

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

    Arguments

    No arguments

    Returns

    colour value (integer)

    Return type

    Number

    Example

    To return the colour used for drawing sensor s: 

    var colour = s.ExtractColour();

    First(Model[Model]) [static]

    Description

    Returns the first sensor in the model.

    Arguments

  • Model (Model)

    Model to get first sensor in

    Returns

    Sensor object (or null if there are no sensors in the model).

    Return type

    Sensor

    Example

    To get the first sensor in model m: 

    var s = Sensor.First(m);

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

    Description

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

    Arguments

  • Model (Model)

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

    Sensor label.

    Return type

    Number

    Example

    To get the first free sensor label in model m: 

    var label = Sensor.FirstFreeLabel(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all sensors will be flagged in

  • flag (Flag)

    Flag to set on the sensors

    Returns

    No return value

    Example

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

    Sensor.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the sensor is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the sensor

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if sensor 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 sensor in the model.
    Note that ForEach has been designed to make looping over sensors as fast as possible and so has some limitations.
    Firstly, a single temporary Sensor object is created and on each function call it is updated with the current sensor data. This means that you should not try to store the Sensor object for later use (e.g. in an array) as it is temporary.
    Secondly, you cannot create new sensors inside a ForEach loop.

    Arguments

  • Model (Model)

    Model that all sensors are in

  • func (function)

    Function to call for each sensor

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

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

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get sensors from

  • property (optional) (string)

    Name for property to get for all sensors in the model

    Returns

    Array of Sensor objects or properties

    Return type

    Array

    Example

    To make an array of Sensor objects for all of the sensors in model m: 

    var a = Sensor.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a sensor.

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

    var comm_array = s.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get sensors from

  • flag (Flag)

    Flag set on the sensors that you want to retrieve

  • property (optional) (string)

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

    Returns

    Array of Sensor objects or properties

    Return type

    Array

    Example

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

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

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

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

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

    Description

    Returns the Sensor object for a sensor ID.

    Arguments

  • Model (Model)

    Model to find the sensor in

  • number (integer)

    number of the sensor you want the Sensor object for

    Returns

    Sensor object (or null if sensor does not exist).

    Return type

    Sensor

    Example

    To get the Sensor object for sensor 100 in model m 

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

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    sensor property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if Sensor 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 Sensor 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 sensor (*ELEMENT_SEATBELT_SENSEROMETER) Note that a carriage return is not added. See also Sensor.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for sensor s: 

    var key = s.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for sensor s: 

    var cards = s.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last sensor in the model.

    Arguments

  • Model (Model)

    Model to get last sensor in

    Returns

    Sensor object (or null if there are no sensors in the model).

    Return type

    Sensor

    Example

    To get the last sensor in model m: 

    var s = Sensor.Last(m);

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

    Description

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

    Arguments

  • Model (Model)

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

    Sensor label.

    Return type

    Number

    Example

    To get the last free sensor label in model m: 

    var label = Sensor.LastFreeLabel(m);

    Next()

    Description

    Returns the next sensor in the model.

    Arguments

    No arguments

    Returns

    Sensor object (or null if there are no more sensors in the model).

    Return type

    Sensor

    Example

    To get the sensor in model m after sensor s: 

    var s = s.Next();

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

    Description

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

    Arguments

  • Model (Model)

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

    Sensor label.

    Return type

    Number

    Example

    To get the next free sensor label in model m: 

    var label = Sensor.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 sensor.

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

    Sensor object (or null if not picked)

    Return type

    Sensor

    Example

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

    var s = Sensor.Pick('Pick sensor from screen', m);

    Previous()

    Description

    Returns the previous sensor in the model.

    Arguments

    No arguments

    Returns

    Sensor object (or null if there are no more sensors in the model).

    Return type

    Sensor

    Example

    To get the sensor in model m before sensor s: 

    var s = s.Previous();

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

    Description

    Renumbers all of the sensors in the model.

    Arguments

  • Model (Model)

    Model that all sensors will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Sensor.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged sensors in the model.

    Arguments

  • Model (Model)

    Model that all the flagged sensors will be renumbered in

  • flag (Flag)

    Flag set on the sensors that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Sensor.RenumberFlagged(m, f, 1000000);

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting sensors

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    Sensor.Select(f, 'Select sensors', m);

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

    Sensor.Select(f, 'Select sensors', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the sensor.

    Arguments

  • flag (Flag)

    Flag to set on the sensor

    Returns

    No return value

    Example

    To set flag f for sensor s: 

    s.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch sensor s: 

    s.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged sensors will be sketched in

  • flag (Flag)

    Flag set on the sensors that you want to sketch

  • redraw (optional) (boolean)

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

    Sensor.SketchFlagged(m, flag);

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

    Description

    Returns the total number of sensors in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of sensors

    Return type

    Number

    Example

    To get the total number of sensors in model m: 

    var total = Sensor.Total(m);

    Unblank()

    Description

    Unblanks the sensor

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank sensor s: 

    s.Unblank();

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

    Description

    Unblanks all of the sensors in the model.

    Arguments

  • Model (Model)

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

    Sensor.UnblankAll(m);

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

    Description

    Unblanks all of the flagged sensors in the model.

    Arguments

  • Model (Model)

    Model that the flagged sensors will be unblanked in

  • flag (Flag)

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

    Sensor.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the sensors

    Returns

    No return value

    Example

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

    Sensor.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the sensor.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch sensor s: 

    s.Unsketch();

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

    Description

    Unsketches all sensors.

    Arguments

  • Model (Model)

    Model that all sensors will be unblanked in

  • redraw (optional) (boolean)

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

    Sensor.UnsketchAll(m);

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

    Description

    Unsketches all flagged sensors in the model.

    Arguments

  • Model (Model)

    Model that all sensors will be unsketched in

  • flag (Flag)

    Flag set on the sensors that you want to unsketch

  • redraw (optional) (boolean)

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

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

    Sensor object.

    Return type

    Sensor

    Example

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

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

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

    Description

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

    s.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this sensor.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for sensor s: 

    var xrefs = s.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for sensor s in keyword format 

    var str = s.toString();