SensorDefine class

Returns

SensorDefine object

Return type

SensorDefine

Example

To create a new *SENSOR_DEFINE_CALC-MATH in model m with label 100 with CALC option as MAX and SENS1 as -2:

var sd1 = new SensorDefine(SensorDefine.DEFINE_CALC_MATH, m, 100, "MAX", -2);

To create a new *SENSOR_DEFINE_MISC in model m with label 10 with MTYPE option as ANGLE:

var sd2 = new SensorDefine(SensorDefine.DEFINE_MISC, m, 10, "ANGLE");

To create a new *SENSOR_DEFINE_NODE in model m with label 11 with NODE1 and NODE2 as 5 and 6:

var sd3 = new SensorDefine(SensorDefine.DEFINE_NODE, m, 11, 5, 6);

To create a new *SENSOR_DEFINE_FUNCTION in model m with label 12 and FUNCTION ID as 6:

var sd4 = new SensorDefine(SensorDefine.DEFINE_FUNCTION, m, 12, 6);

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a *SENSOR_DEFINE.

Returns

No return value

Example

To associate comment c to the *SENSOR_DEFINE sd:

sd.AssociateComment(c);

Browse(modal (optional)[boolean])

Description

Starts an edit panel in Browse mode.

Returns

no return value

Example

To Browse *SENSOR_DEFINE sd:

sd.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the *SENSOR_DEFINE.

Returns

No return value

Example

To clear flag f for *SENSOR_DEFINE sd:

sd.ClearFlag(f);

Copy(range (optional)[boolean])

Description

Copies the *SENSOR_DEFINE. The target include of the copied *SENSOR_DEFINE can be set using Options.copy_target_include.

Returns

SensorDefine object

Return type

SensorDefine

Example

To copy *SENSOR_DEFINE sd into *SENSOR_DEFINE z:

var z = sd.Copy();

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

Description

Starts an interactive editing panel to create a *SENSOR_DEFINE

Returns

SensorDefine object (or null if not made).

Return type

SensorDefine

Example

To start creating a *SENSOR_DEFINE in model m:

var sd = SensorDefine.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a *SENSOR_DEFINE.

Returns

No return value

Example

To detach comment c from the *SENSOR_DEFINE sd:

sd.DetachComment(c);

Edit(modal (optional)[boolean])

Description

Starts an interactive editing panel.

Returns

no return value

Example

To Edit *SENSOR_DEFINE sd:

sd.Edit();

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

Description

Adds an error for *SENSOR_DEFINE. For more details on checking see the Check class.

Returns

No return value

Example

To add an error message "My custom error" for *SENSOR_DEFINE sd:

sd.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first *SENSOR_DEFINE in the model.

Returns

SensorDefine object (or null if there are no *SENSOR_DEFINEs in the model).

Return type

SensorDefine

Example

To get the first *SENSOR_DEFINE in model m:

var sd = SensorDefine.First(m);

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

Description

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

Returns

SensorDefine label.

Return type

Number

Example

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

var label = SensorDefine.FirstFreeLabel(m);

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

Description

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

Returns

No return value

Example

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

SensorDefine.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the *SENSOR_DEFINE is flagged or not.

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if *SENSOR_DEFINE sd has flag f set on it:

if (sd.Flagged(f) ) do_something...

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

Description

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

Returns

No return value

Example

To call function test for all of the *SENSOR_DEFINEs in model m:

SensorDefine.ForEach(m, test);
function test(sd)
{
// sd is SensorDefine object
}

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

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

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

Description

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

Returns

Array of SensorDefine objects or properties

Return type

Array

Example

To make an array of SensorDefine objects for all of the *SENSOR_DEFINEs in model m:

var a = SensorDefine.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a *SENSOR_DEFINE.

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_DEFINE sd:

var comm_array = sd.GetComments();

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

Description

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

Returns

Array of SensorDefine objects or properties

Return type

Array

Example

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

var sd = SensorDefine.GetFlagged(m, f);

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

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

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

Description

Returns the SensorDefine object for a *SENSOR_DEFINE ID.

Returns

SensorDefine object (or null if *SENSOR_DEFINE does not exist).

Return type

SensorDefine

Example

To get the SensorDefine object for *SENSOR_DEFINE 100 in model m

var sd = SensorDefine.GetFromID(m, 100);

GetParameter(prop[string])

Description

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

Returns

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

Return type

Parameter

Example

To check if SensorDefine property sd.example is a parameter:

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

To check if SensorDefine property sd.example is a parameter by using the GetParameter method:

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

Keyword()

Description

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

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for SensorDefine sd:

var key = sd.Keyword();

KeywordCards()

Description

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

Returns

string containing the cards.

Return type

String

Example

To get the cards for sensor define sd:

var cards = sd.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last *SENSOR_DEFINE in the model.

Returns

SensorDefine object (or null if there are no *SENSOR_DEFINEs in the model).

Return type

SensorDefine

Example

To get the last *SENSOR_DEFINE in model m:

var sd = SensorDefine.Last(m);

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

Description

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

Returns

SensorDefine label.

Return type

Number

Example

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

var label = SensorDefine.LastFreeLabel(m);

Next()

Description

Returns the next *SENSOR_DEFINE in the model.

Returns

SensorDefine object (or null if there are no more *SENSOR_DEFINEs in the model).

Return type

SensorDefine

Example

To get the *SENSOR_DEFINE in model m after *SENSOR_DEFINE sd:

var sd = sd.Next();

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

Description

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

Returns

SensorDefine label.

Return type

Number

Example

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

var label = SensorDefine.NextFreeLabel(m);

Previous()

Description

Returns the previous *SENSOR_DEFINE in the model.

Returns

SensorDefine object (or null if there are no more *SENSOR_DEFINEs in the model).

Return type

SensorDefine

Example

To get the *SENSOR_DEFINE in model m before *SENSOR_DEFINE sd:

var sd = sd.Previous();

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

Description

Renumbers all of the *SENSOR_DEFINEs in the model.

Returns

No return value

Example

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

SensorDefine.RenumberAll(m, 1000000);

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

Description

Renumbers all of the flagged *SENSOR_DEFINEs in the model.

Returns

No return value

Example

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

SensorDefine.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_DEFINEs using standard PRIMER object menus.

Returns

Number of *SENSOR_DEFINEs selected or null if menu cancelled

Return type

Number

Example

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

SensorDefine.Select(f, 'Select *SENSOR_DEFINEs', m);

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

SensorDefine.Select(f, 'Select *SENSOR_DEFINEs', l);

SetFlag(flag[Flag])

Description

Sets a flag on the *SENSOR_DEFINE.

Returns

No return value

Example

To set flag f for *SENSOR_DEFINE sd:

sd.SetFlag(f);

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

Description

Returns the total number of *SENSOR_DEFINEs in the model.

Returns

number of *SENSOR_DEFINEs

Return type

Number

Example

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

var total = SensorDefine.Total(m);

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

Description

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

Returns

No return value

Example

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

SensorDefine.UnflagAll(m, f);

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.

Returns

SensorDefine object.

Return type

SensorDefine

Example

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

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

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

Description

Adds a warning for *SENSOR_DEFINE. For more details on checking see the Check class.

Returns

No return value

Example

To add a warning message "My custom warning" for *SENSOR_DEFINE sd:

sd.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this *SENSOR_DEFINE.

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for *SENSOR_DEFINE sd:

var xrefs = sd.Xrefs();

toString()

Description

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

Returns

string

Return type

String

Example

To get data for sensor define sd in keyword format

var str = sd.toString();