SensorControl class

The SensorControl class gives you access to *SENSOR_CONTROL keyword 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

SensorControl properties

Name Type Description
cntlid integer SensorControl number. The label property is an alternative name for this.
defcv real/string Default curve value when a curve is not active for TYPE = CURVE only. If DEFCRV = "LASTSTEP", the curve value right before the curve is turned off becomes the default curve value.
estyp string Element Set Type to be controlled. Can be "BEAM", "DISC", "SHELL", "SOLID", "TSHELL".
exists (read only) logical true if *SENSOR_CONTROL exists, false if referred to but not defined.
include integer The Include file number that the *SENSOR_CONTROL is in.
initstt string Initial status. Can be "On" or "Off".
label integer SensorControl number. The cntlid property is an alternative name for this.
model (read only) integer The Model number that the *SENSOR_CONTROL is in.
nrep integer Number of repeat of cycle of switches.
swit1 integer ID of 1st switch.
swit2 integer ID of 2nd switch.
swit3 integer ID of 3rd switch.
swit4 integer ID of 4th switch.
swit5 integer ID of 5th switch.
swit6 integer ID of 6th switch.
swit7 integer ID of 7th switch.
timeoff integer Flag for offset of time in curve.
timeoff/idiscl integer Flag for offset of time in curve./Flag for the reference length of the discrete element
type string Entity to be controlled. Can be "AIRBAG", "BAGVENTPOP", "BELTPRET", "BELTRETRA", "BELTSLIP", "CONTACT", "CONTACT2D", "CNRB", "DEF2RIG", "DISC-ELE", "DISC-ELES", "ELESET", "FUNCTION", "JOINT", "JOINTSTIFF", "LOADTHM", "M PRESSURE", "RWALL", "SPC", "SPOTWELD".
typeid integer ID of entity to be controlled if type is not FUNCTION or input value for FUNCTION.

Detailed Description

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

Constructor

new SensorControl(Model[Model], Sensor control ID[integer], Type[string], Type ID (optional)[integer], estyp (optional)[string])

Description

Create a new SensorControl object.

Arguments

  • Model (Model)

    Model that *SENSOR_CONTROL will be created in

  • Sensor control ID (integer)

    SensorControl id.

  • Type (string)

    Entity type to be controlled. Can be "AIRBAG", "BAGVENTPOP", "BELTPRET", "BELTRETRA", "BELTSLIP", "CONTACT", "CONTACT2D", "DEF2RIG", "CURVE", "DISC-ELE", "DISC-ELES", "ELESET", "FUNCTION", "JOINT", "JOINTSTIFF", "M PRESSURE", "RWALL", "SPC", "SPOTWELD".

  • Type ID (optional) (integer)

    ID of entity to be controlled if type is not FUNCTION or input value for FUNCTION.

  • estyp (optional) (string)

    Element Set Type to be controlled. Can be "BEAM", "DISC", "SHELL", "SOLID", "TSHELL". Required only if Type argument is "ELESET".

    Returns

    SensorControl object

    Return type

    SensorControl

    Example

    To create a new *SENSOR_CONTROL in model m with label 100 and type JOINT: 

    var sc = new SensorControl(m, 100, "JOINT");

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a *SENSOR_CONTROL.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the *SENSOR_CONTROL

    Returns

    No return value

    Example

    To associate comment c to the *SENSOR_CONTROL sc: 

    sc.AssociateComment(c);

    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_CONTROL sc: 

    sc.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the *SENSOR_CONTROL.

    Arguments

  • flag (Flag)

    Flag to clear on the *SENSOR_CONTROL

    Returns

    No return value

    Example

    To clear flag f for *SENSOR_CONTROL sc: 

    sc.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    SensorControl object

    Return type

    SensorControl

    Example

    To copy *SENSOR_CONTROL sc into *SENSOR_CONTROL z: 

    var z = sc.Copy();

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

    Description

    Starts an interactive editing panel to create a *SENSOR_CONTROL

    Arguments

  • Model (Model)

    Model that the *SENSOR_CONTROL 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

    SensorControl object (or null if not made).

    Return type

    SensorControl

    Example

    To start creating a *SENSOR_CONTROL in model m: 

    var sc = SensorControl.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a *SENSOR_CONTROL.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the *SENSOR_CONTROL

    Returns

    No return value

    Example

    To detach comment c from the *SENSOR_CONTROL sc: 

    sc.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_CONTROL sc: 

    sc.Edit();

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

    Description

    Adds an error for *SENSOR_CONTROL. 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_CONTROL sc: 

    sc.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first *SENSOR_CONTROL in the model.

    Arguments

  • Model (Model)

    Model to get first *SENSOR_CONTROL in

    Returns

    SensorControl object (or null if there are no *SENSOR_CONTROLs in the model).

    Return type

    SensorControl

    Example

    To get the first *SENSOR_CONTROL in model m: 

    var sc = SensorControl.First(m);

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

    Description

    Returns the first free *SENSOR_CONTROL label in the model. Also see SensorControl.LastFreeLabel(), SensorControl.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

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

    SensorControl label.

    Return type

    Number

    Example

    To get the first free *SENSOR_CONTROL label in model m: 

    var label = SensorControl.FirstFreeLabel(m);

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

    Description

    Flags all of the *SENSOR_CONTROLs in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all *SENSOR_CONTROLs will be flagged in

  • flag (Flag)

    Flag to set on the *SENSOR_CONTROLs

    Returns

    No return value

    Example

    To flag all of the *SENSOR_CONTROLs with flag f in model m: 

    SensorControl.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the *SENSOR_CONTROL is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the *SENSOR_CONTROL

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if *SENSOR_CONTROL sc has flag f set on it: 

    if (sc.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all *SENSOR_CONTROLs are in

  • func (function)

    Function to call for each *SENSOR_CONTROL

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

    SensorControl.ForEach(m, test);
function test(sc)
{
// sc is SensorControl object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get *SENSOR_CONTROLs from

  • property (optional) (string)

    Name for property to get for all *SENSOR_CONTROLs in the model

    Returns

    Array of SensorControl objects or properties

    Return type

    Array

    Example

    To make an array of SensorControl objects for all of the *SENSOR_CONTROLs in model m: 

    var a = SensorControl.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a *SENSOR_CONTROL.

    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_CONTROL sc: 

    var comm_array = sc.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get *SENSOR_CONTROLs from

  • flag (Flag)

    Flag set on the *SENSOR_CONTROLs that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged *SENSOR_CONTROLs in the model

    Returns

    Array of SensorControl objects or properties

    Return type

    Array

    Example

    To make an array of SensorControl objects for all of the *SENSOR_CONTROLs in model m flagged with f: 

    var sc = SensorControl.GetFlagged(m, f);

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

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

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

    Description

    Returns the SensorControl object for a *SENSOR_CONTROL ID.

    Arguments

  • Model (Model)

    Model to find the *SENSOR_CONTROL in

  • number (integer)

    number of the *SENSOR_CONTROL you want the SensorControl object for

    Returns

    SensorControl object (or null if *SENSOR_CONTROL does not exist).

    Return type

    SensorControl

    Example

    To get the SensorControl object for *SENSOR_CONTROL 100 in model m 

    var sc = SensorControl.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    *SENSOR_CONTROL property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if SensorControl property sc.example is a parameter: 

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

    To check if SensorControl property sc.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for SensorControl sc: 

    var key = sc.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for sensor control sc: 

    var cards = sc.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last *SENSOR_CONTROL in the model.

    Arguments

  • Model (Model)

    Model to get last *SENSOR_CONTROL in

    Returns

    SensorControl object (or null if there are no *SENSOR_CONTROLs in the model).

    Return type

    SensorControl

    Example

    To get the last *SENSOR_CONTROL in model m: 

    var sc = SensorControl.Last(m);

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

    Description

    Returns the last free *SENSOR_CONTROL label in the model. Also see SensorControl.FirstFreeLabel(), SensorControl.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

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

    SensorControl label.

    Return type

    Number

    Example

    To get the last free *SENSOR_CONTROL label in model m: 

    var label = SensorControl.LastFreeLabel(m);

    Next()

    Description

    Returns the next *SENSOR_CONTROL in the model.

    Arguments

    No arguments

    Returns

    SensorControl object (or null if there are no more *SENSOR_CONTROLs in the model).

    Return type

    SensorControl

    Example

    To get the *SENSOR_CONTROL in model m after *SENSOR_CONTROL sc: 

    var sc = sc.Next();

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

    Description

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

    Arguments

  • Model (Model)

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

    SensorControl label.

    Return type

    Number

    Example

    To get the next free *SENSOR_CONTROL label in model m: 

    var label = SensorControl.NextFreeLabel(m);

    Previous()

    Description

    Returns the previous *SENSOR_CONTROL in the model.

    Arguments

    No arguments

    Returns

    SensorControl object (or null if there are no more *SENSOR_CONTROLs in the model).

    Return type

    SensorControl

    Example

    To get the *SENSOR_CONTROL in model m before *SENSOR_CONTROL sc: 

    var sc = sc.Previous();

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

    Description

    Renumbers all of the *SENSOR_CONTROLs in the model.

    Arguments

  • Model (Model)

    Model that all *SENSOR_CONTROLs will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    SensorControl.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged *SENSOR_CONTROLs in the model.

    Arguments

  • Model (Model)

    Model that all the flagged *SENSOR_CONTROLs will be renumbered in

  • flag (Flag)

    Flag set on the *SENSOR_CONTROLs that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    SensorControl.RenumberFlagged(m, f, 1000000);

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

    Description

    Allows the user to select *SENSOR_CONTROLs using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting *SENSOR_CONTROLs

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    SensorControl.Select(f, 'Select *SENSOR_CONTROLs', m);

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

    SensorControl.Select(f, 'Select *SENSOR_CONTROLs', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the *SENSOR_CONTROL.

    Arguments

  • flag (Flag)

    Flag to set on the *SENSOR_CONTROL

    Returns

    No return value

    Example

    To set flag f for *SENSOR_CONTROL sc: 

    sc.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch *SENSOR_CONTROL sc: 

    sc.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged *SENSOR_CONTROLs will be sketched in

  • flag (Flag)

    Flag set on the *SENSOR_CONTROLs that you want to sketch

  • redraw (optional) (boolean)

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

    SensorControl.SketchFlagged(m, flag);

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

    Description

    Returns the total number of *SENSOR_CONTROLs in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of *SENSOR_CONTROLs

    Return type

    Number

    Example

    To get the total number of *SENSOR_CONTROLs in model m: 

    var total = SensorControl.Total(m);

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

    Description

    Unsets a defined flag on all of the *SENSOR_CONTROLs in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all *SENSOR_CONTROLs will be unset in

  • flag (Flag)

    Flag to unset on the *SENSOR_CONTROLs

    Returns

    No return value

    Example

    To unset the flag f on all the *SENSOR_CONTROLs in model m: 

    SensorControl.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the *SENSOR_CONTROL.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch *SENSOR_CONTROL sc: 

    sc.Unsketch();

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

    Description

    Unsketches all *SENSOR_CONTROLs.

    Arguments

  • Model (Model)

    Model that all *SENSOR_CONTROLs will be unblanked in

  • redraw (optional) (boolean)

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

    SensorControl.UnsketchAll(m);

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

    Description

    Unsketches all flagged *SENSOR_CONTROLs in the model.

    Arguments

  • Model (Model)

    Model that all *SENSOR_CONTROLs will be unsketched in

  • flag (Flag)

    Flag set on the *SENSOR_CONTROLs that you want to unsketch

  • redraw (optional) (boolean)

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

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

    SensorControl object.

    Return type

    SensorControl

    Example

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

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

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

    Description

    Adds a warning for *SENSOR_CONTROL. 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_CONTROL sc: 

    sc.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this *SENSOR_CONTROL.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for *SENSOR_CONTROL sc: 

    var xrefs = sc.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for sensor control sc in keyword format 

    var str = sc.toString();