Accelerometer class

The Accelerometer class gives you access to seatbelt accelerometer 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

Accelerometer properties

Name Type Description
colour Colour The colour of the accelerometer
exists (read only) logical true if accelerometer exists, false if referred to but not defined.
igrav integer Gravitational acceleration due to body force loads is included in acceleration output if igrav is 0, removed if igrav is 1.
include integer The Include file number that the accelerometer is in.
intopt integer Integration option; velocities are integrated from global accelerations and transformed into local system if intopt is 0, they are integrated directly from local accelerations if intopt is 1.
label integer Accelerometer number. Also see the sbacid property which is an alternative name for this.
mass real Optional added mass for accelerometer
model (read only) integer The Model number that the accelerometer is in.
nid1 integer Node number 1
nid2 integer Node number 2
nid3 integer Node number 3
sbacid integer Accelerometer number. Also see the label property which is an alternative name for this.
transparency integer The transparency of the accelerometer (0-100) 0% is opaque, 100% is transparent.

Detailed Description

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

Constructor

new Accelerometer(Model[Model], sbacid[integer], nid1[integer], nid2[integer], nid3[integer], igrav (optional)[integer], intopt (optional)[integer], mass (optional)[real])

Description

Create a new Seatbelt Accelerometer object.

Arguments

  • Model (Model)

    Model that accelerometer will be created in

  • sbacid (integer)

    Accelerometer number. Also see the label property which is an alternative name for this.

  • nid1 (integer)

    Node number 1

  • nid2 (integer)

    Node number 2

  • nid3 (integer)

    Node number 3

  • igrav (optional) (integer)

    Gravitational acceleration due to body force loads is included in acceleration output if igrav is 0, removed if igrav is 1.

  • intopt (optional) (integer)

    Integration option; velocities are integrated from global accelerations and transformed into local system if intopt is 0, they are integrated directly from local accelerations if intopt is 1.

  • mass (optional) (real)

    Optional added mass for accelerometer

    Returns

    Accelerometer object

    Return type

    Accelerometer

    Example

    To create a new seatbelt accelerometer in model m with label 100, nodes 1, 2 and 3: 

    var a = new Accelerometer(m, 100, 1, 2, 3);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a accelerometer.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the accelerometer

    Returns

    No return value

    Example

    To associate comment c to the accelerometer a: 

    a.AssociateComment(c);

    Blank()

    Description

    Blanks the accelerometer

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank accelerometer a: 

    a.Blank();

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

    Description

    Blanks all of the accelerometers in the model.

    Arguments

  • Model (Model)

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

    Accelerometer.BlankAll(m);

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

    Description

    Blanks all of the flagged accelerometers in the model.

    Arguments

  • Model (Model)

    Model that all the flagged accelerometers will be blanked in

  • flag (Flag)

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

    Accelerometer.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the accelerometer is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if accelerometer a is blanked: 

    if (a.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 accelerometer a: 

    a.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the accelerometer.

    Arguments

  • flag (Flag)

    Flag to clear on the accelerometer

    Returns

    No return value

    Example

    To clear flag f for accelerometer a: 

    a.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    Accelerometer object

    Return type

    Accelerometer

    Example

    To copy accelerometer a into accelerometer z: 

    var z = a.Copy();

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

    Description

    Starts an interactive editing panel to create a accelerometer

    Arguments

  • Model (Model)

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

    Accelerometer object (or null if not made).

    Return type

    Accelerometer

    Example

    To start creating a accelerometer in model m: 

    var a = Accelerometer.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a accelerometer.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the accelerometer

    Returns

    No return value

    Example

    To detach comment c from the accelerometer a: 

    a.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 accelerometer a: 

    a.Edit();

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

    Description

    Adds an error for accelerometer. 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 accelerometer a: 

    a.Error("My custom error");

    ExtractColour()

    Description

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

    Arguments

    No arguments

    Returns

    colour value (integer)

    Return type

    Number

    Example

    To return the colour used for drawing accelerometer a: 

    var colour = a.ExtractColour();

    First(Model[Model]) [static]

    Description

    Returns the first accelerometer in the model.

    Arguments

  • Model (Model)

    Model to get first accelerometer in

    Returns

    Accelerometer object (or null if there are no accelerometers in the model).

    Return type

    Accelerometer

    Example

    To get the first accelerometer in model m: 

    var a = Accelerometer.First(m);

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

    Description

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

    Arguments

  • Model (Model)

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

    Accelerometer label.

    Return type

    Number

    Example

    To get the first free accelerometer label in model m: 

    var label = Accelerometer.FirstFreeLabel(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all accelerometers will be flagged in

  • flag (Flag)

    Flag to set on the accelerometers

    Returns

    No return value

    Example

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

    Accelerometer.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the accelerometer is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the accelerometer

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if accelerometer a has flag f set on it: 

    if (a.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all accelerometers are in

  • func (function)

    Function to call for each accelerometer

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

    Accelerometer.ForEach(m, test);
function test(a)
{
// a is Accelerometer object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get accelerometers from

  • property (optional) (string)

    Name for property to get for all accelerometers in the model

    Returns

    Array of Accelerometer objects or properties

    Return type

    Array

    Example

    To make an array of Accelerometer objects for all of the accelerometers in model m: 

    var a = Accelerometer.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a accelerometer.

    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 accelerometer a: 

    var comm_array = a.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get accelerometers from

  • flag (Flag)

    Flag set on the accelerometers that you want to retrieve

  • property (optional) (string)

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

    Returns

    Array of Accelerometer objects or properties

    Return type

    Array

    Example

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

    var a = Accelerometer.GetFlagged(m, f);

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

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

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

    Description

    Returns the Accelerometer object for a accelerometer ID.

    Arguments

  • Model (Model)

    Model to find the accelerometer in

  • number (integer)

    number of the accelerometer you want the Accelerometer object for

    Returns

    Accelerometer object (or null if accelerometer does not exist).

    Return type

    Accelerometer

    Example

    To get the Accelerometer object for accelerometer 100 in model m 

    var a = Accelerometer.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    accelerometer property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if Accelerometer property a.example is a parameter: 

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

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

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for accelerometer a: 

    var key = a.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for accelerometer a: 

    var cards = a.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last accelerometer in the model.

    Arguments

  • Model (Model)

    Model to get last accelerometer in

    Returns

    Accelerometer object (or null if there are no accelerometers in the model).

    Return type

    Accelerometer

    Example

    To get the last accelerometer in model m: 

    var a = Accelerometer.Last(m);

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

    Description

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

    Arguments

  • Model (Model)

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

    Accelerometer label.

    Return type

    Number

    Example

    To get the last free accelerometer label in model m: 

    var label = Accelerometer.LastFreeLabel(m);

    Next()

    Description

    Returns the next accelerometer in the model.

    Arguments

    No arguments

    Returns

    Accelerometer object (or null if there are no more accelerometers in the model).

    Return type

    Accelerometer

    Example

    To get the accelerometer in model m after accelerometer a: 

    var a = a.Next();

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

    Description

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

    Arguments

  • Model (Model)

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

    Accelerometer label.

    Return type

    Number

    Example

    To get the next free accelerometer label in model m: 

    var label = Accelerometer.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 accelerometer.

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

    Accelerometer object (or null if not picked)

    Return type

    Accelerometer

    Example

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

    var a = Accelerometer.Pick('Pick accelerometer from screen', m);

    Previous()

    Description

    Returns the previous accelerometer in the model.

    Arguments

    No arguments

    Returns

    Accelerometer object (or null if there are no more accelerometers in the model).

    Return type

    Accelerometer

    Example

    To get the accelerometer in model m before accelerometer a: 

    var a = a.Previous();

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

    Description

    Renumbers all of the accelerometers in the model.

    Arguments

  • Model (Model)

    Model that all accelerometers will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Accelerometer.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged accelerometers in the model.

    Arguments

  • Model (Model)

    Model that all the flagged accelerometers will be renumbered in

  • flag (Flag)

    Flag set on the accelerometers that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Accelerometer.RenumberFlagged(m, f, 1000000);

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting accelerometers

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    Accelerometer.Select(f, 'Select accelerometers', m);

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

    Accelerometer.Select(f, 'Select accelerometers', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the accelerometer.

    Arguments

  • flag (Flag)

    Flag to set on the accelerometer

    Returns

    No return value

    Example

    To set flag f for accelerometer a: 

    a.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch accelerometer a: 

    a.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged accelerometers will be sketched in

  • flag (Flag)

    Flag set on the accelerometers that you want to sketch

  • redraw (optional) (boolean)

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

    Accelerometer.SketchFlagged(m, flag);

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

    Description

    Returns the total number of accelerometers in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of accelerometers

    Return type

    Number

    Example

    To get the total number of accelerometers in model m: 

    var total = Accelerometer.Total(m);

    Unblank()

    Description

    Unblanks the accelerometer

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank accelerometer a: 

    a.Unblank();

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

    Description

    Unblanks all of the accelerometers in the model.

    Arguments

  • Model (Model)

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

    Accelerometer.UnblankAll(m);

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

    Description

    Unblanks all of the flagged accelerometers in the model.

    Arguments

  • Model (Model)

    Model that the flagged accelerometers will be unblanked in

  • flag (Flag)

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

    Accelerometer.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the accelerometers

    Returns

    No return value

    Example

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

    Accelerometer.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the accelerometer.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch accelerometer a: 

    a.Unsketch();

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

    Description

    Unsketches all accelerometers.

    Arguments

  • Model (Model)

    Model that all accelerometers will be unblanked in

  • redraw (optional) (boolean)

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

    Accelerometer.UnsketchAll(m);

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

    Description

    Unsketches all flagged accelerometers in the model.

    Arguments

  • Model (Model)

    Model that all accelerometers will be unsketched in

  • flag (Flag)

    Flag set on the accelerometers that you want to unsketch

  • redraw (optional) (boolean)

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

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

    Accelerometer object.

    Return type

    Accelerometer

    Example

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

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

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

    Description

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

    a.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this accelerometer.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for accelerometer a: 

    var xrefs = a.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for accelerometer a in keyword format 

    var str = a.toString();