StructureEntity

StructureEntity

Class representing an entity to extract data from part of a structure

It extends the BaseEntity class

Constructor

new StructureEntity(entity_type, id, name, tag, measurements)

Source:
Example
let entity = new StructureEntity(
                         StructureEntity.SPRING_TRANSLATIONAL,
                         1,
                         "(X) Steering column Intrusion Spring",
                         StructureEntity.STEERING_COLUMN_FORE_AFT,
                         [new Measurement(Measurement.FORE_AFT_DISPLACEMENT, "ET")]);
Parameters:
Name Type Description
entity_type string Entity type constant
id number | string Entity id (label or database history name)
name string Entity name (this is used as the label in the GUI)
tag string Entity tag
measurements Array.<Measurement> List of raw measurements that can be read from the entity

Extends

Members

(static) A_PILLAR :string

Description:
  • A_PILLAR tag
Source:
A_PILLAR tag
Type:
  • string

(static) ACCELERATOR_PEDAL_FORE_AFT :string

Description:
  • ACCELERATOR_PEDAL_FORE_AFT tag
Source:
ACCELERATOR_PEDAL_FORE_AFT tag
Type:
  • string

(static) ACCELERATOR_PEDAL_LATERAL :string

Description:
  • ACCELERATOR_PEDAL_LATERAL tag
Source:
ACCELERATOR_PEDAL_LATERAL tag
Type:
  • string

(static) ACCELERATOR_PEDAL_VERTICAL :string

Description:
  • ACCELERATOR_PEDAL_VERTICAL tag
Source:
ACCELERATOR_PEDAL_VERTICAL tag
Type:
  • string

(static) B_PILLAR :string

Description:
  • B_PILLAR tag
Source:
B_PILLAR tag
Type:
  • string

(static) BRAKE_PEDAL_FORE_AFT :string

Description:
  • BRAKE_PEDAL_FORE_AFT tag
Source:
BRAKE_PEDAL_FORE_AFT tag
Type:
  • string

(static) BRAKE_PEDAL_LATERAL :string

Description:
  • BRAKE_PEDAL_LATERAL tag
Source:
BRAKE_PEDAL_LATERAL tag
Type:
  • string

(static) BRAKE_PEDAL_VERTICAL :string

Description:
  • BRAKE_PEDAL_VERTICAL tag
Source:
BRAKE_PEDAL_VERTICAL tag
Type:
  • string

(static) CENTRE_DASH_FORE_AFT :string

Description:
  • CENTRE_LOWER_DASH_FORE_AFT tag
Source:
CENTRE_LOWER_DASH_FORE_AFT tag
Type:
  • string

(static) CENTRE_DASH_LATERAL :string

Description:
  • CENTRE_DASH_LATERAL tag
Source:
CENTRE_DASH_LATERAL tag
Type:
  • string

(static) CENTRE_DASH_VERTICAL :string

Description:
  • CENTRE_DASH_VERTICAL tag
Source:
CENTRE_DASH_VERTICAL tag
Type:
  • string

(static) CENTRE_TOEPAN_FORE_AFT :string

Description:
  • CENTRE_TOEPAN_FORE_AFT tag
Source:
CENTRE_TOEPAN_FORE_AFT tag
Type:
  • string

(static) CENTRE_TOEPAN_LATERAL :string

Description:
  • CENTRE_TOEPAN_LATERAL tag
Source:
CENTRE_TOEPAN_LATERAL tag
Type:
  • string

(static) CENTRE_TOEPAN_VERTICAL :string

Description:
  • CENTRE_TOEPAN_VERTICAL tag
Source:
CENTRE_TOEPAN_VERTICAL tag
Type:
  • string

(static) CLUTCH_PEDAL_FORE_AFT :string

Description:
  • CLUTCH_PEDAL_FORE_AFT tag
Source:
CLUTCH_PEDAL_FORE_AFT tag
Type:
  • string

(static) CLUTCH_PEDAL_LATERAL :string

Description:
  • CLUTCH_PEDAL_LATERAL tag
Source:
CLUTCH_PEDAL_LATERAL tag
Type:
  • string

(static) CLUTCH_PEDAL_VERTICAL :string

Description:
  • CLUTCH_PEDAL_VERTICAL tag
Source:
CLUTCH_PEDAL_VERTICAL tag
Type:
  • string

(static) DOOR_FORE_AFT :string

Description:
  • DOOR_FORE_AFT tag
Source:
DOOR_FORE_AFT tag
Type:
  • string

(static) FOOTREST_FORE_AFT :string

Description:
  • FOOTREST_FORE_AFT tag
Source:
FOOTREST_FORE_AFT tag
Type:
  • string

(static) FOOTREST_LATERAL :string

Description:
  • FOOTREST_LATERAL tag
Source:
FOOTREST_LATERAL tag
Type:
  • string

(static) FOOTREST_VERTICAL :string

Description:
  • FOOTREST_VERTICAL tag
Source:
FOOTREST_VERTICAL tag
Type:
  • string

(static) HEAD_EXCURSION :string

Description:
  • HEAD_EXCURSION tag
Source:
HEAD_EXCURSION tag
Type:
  • string

(static) LEFT_INSTRUMENT_PANEL_FORE_AFT :string

Description:
  • LEFT_INSTRUMENT_PANEL_FORE_AFT tag
Source:
LEFT_INSTRUMENT_PANEL_FORE_AFT tag
Type:
  • string

(static) LEFT_LOWER_DASH_FORE_AFT :string

Description:
  • LEFT_LOWER_DASH_FORE_AFT tag
Source:
LEFT_LOWER_DASH_FORE_AFT tag
Type:
  • string

(static) LEFT_LOWER_DASH_LATERAL :string

Description:
  • LEFT_LOWER_DASH_LATERAL tag
Source:
LEFT_LOWER_DASH_LATERAL tag
Type:
  • string

(static) LEFT_LOWER_DASH_VERTICAL :string

Description:
  • LEFT_LOWER_DASH_VERTICAL tag
Source:
LEFT_LOWER_DASH_VERTICAL tag
Type:
  • string

(static) LEFT_TOEPAN_FORE_AFT :string

Description:
  • LEFT_TOEPAN_FORE_AFT tag
Source:
LEFT_TOEPAN_FORE_AFT tag
Type:
  • string

(static) LEFT_TOEPAN_LATERAL :string

Description:
  • LEFT_TOEPAN_LATERAL tag
Source:
LEFT_TOEPAN_LATERAL tag
Type:
  • string

(static) LEFT_TOEPAN_VERTICAL :string

Description:
  • LEFT_TOEPAN_VERTICAL tag
Source:
LEFT_TOEPAN_VERTICAL tag
Type:
  • string

(static) LOWER_HINGE_1_FORE_AFT :string

Description:
  • LOWER_HINGE_1_FORE_AFT tag
Source:
LOWER_HINGE_1_FORE_AFT tag
Type:
  • string

(static) LOWER_HINGE_1_LATERAL :string

Description:
  • LOWER_HINGE_1_LATERAL tag
Source:
LOWER_HINGE_1_LATERAL tag
Type:
  • string

(static) LOWER_HINGE_1_VERTICAL :string

Description:
  • LOWER_HINGE_1_VERTICAL tag
Source:
LOWER_HINGE_1_VERTICAL tag
Type:
  • string

(static) LOWER_HINGE_2_FORE_AFT :string

Description:
  • LOWER_HINGE_2_FORE_AFT tag
Source:
LOWER_HINGE_2_FORE_AFT tag
Type:
  • string

(static) LOWER_HINGE_2_LATERAL :string

Description:
  • LOWER_HINGE_2_LATERAL tag
Source:
LOWER_HINGE_2_LATERAL tag
Type:
  • string

(static) LOWER_HINGE_2_VERTICAL :string

Description:
  • LOWER_HINGE_2_VERTICAL tag
Source:
LOWER_HINGE_2_VERTICAL tag
Type:
  • string

(static) LOWER_HINGE_3_FORE_AFT :string

Description:
  • LOWER_HINGE_3_FORE_AFT tag
Source:
LOWER_HINGE_3_FORE_AFT tag
Type:
  • string

(static) LOWER_HINGE_3_LATERAL :string

Description:
  • LOWER_HINGE_3_LATERAL tag
Source:
LOWER_HINGE_3_LATERAL tag
Type:
  • string

(static) LOWER_HINGE_3_VERTICAL :string

Description:
  • LOWER_HINGE_3_VERTICAL tag
Source:
LOWER_HINGE_3_VERTICAL tag
Type:
  • string

(static) PARKING_BRAKE_FORE_AFT :string

Description:
  • PARKING_BRAKE_FORE_AFT tag
Source:
PARKING_BRAKE_FORE_AFT tag
Type:
  • string

(static) PARKING_BRAKE_LATERAL :string

Description:
  • PARKING_BRAKE_LATERAL tag
Source:
PARKING_BRAKE_LATERAL tag
Type:
  • string

(static) PARKING_BRAKE_VERTICAL :string

Description:
  • PARKING_BRAKE_VERTICAL tag
Source:
PARKING_BRAKE_VERTICAL tag
Type:
  • string

(static) RIGHT_INSTRUMENT_PANEL_FORE_AFT :string

Description:
  • RIGHT_INSTRUMENT_PANEL_FORE_AFT tag
Source:
RIGHT_INSTRUMENT_PANEL_FORE_AFT tag
Type:
  • string

(static) RIGHT_LOWER_DASH_FORE_AFT :string

Description:
  • RIGHT_LOWER_DASH_FORE_AFT tag
Source:
RIGHT_LOWER_DASH_FORE_AFT tag
Type:
  • string

(static) RIGHT_LOWER_DASH_LATERAL :string

Description:
  • RIGHT_LOWER_DASH_LATERAL tag
Source:
RIGHT_LOWER_DASH_LATERAL tag
Type:
  • string

(static) RIGHT_LOWER_DASH_VERTICAL :string

Description:
  • RIGHT_LOWER_DASH_VERTICAL tag
Source:
RIGHT_LOWER_DASH_VERTICAL tag
Type:
  • string

(static) RIGHT_TOEPAN_FORE_AFT :string

Description:
  • RIGHT_TOEPAN_FORE_AFT tag
Source:
RIGHT_TOEPAN_FORE_AFT tag
Type:
  • string

(static) RIGHT_TOEPAN_LATERAL :string

Description:
  • RIGHT_TOEPAN_LATERAL tag
Source:
RIGHT_TOEPAN_LATERAL tag
Type:
  • string

(static) RIGHT_TOEPAN_VERTICAL :string

Description:
  • RIGHT_TOEPAN_VERTICAL tag
Source:
RIGHT_TOEPAN_VERTICAL tag
Type:
  • string

(static) ROCKER_PANEL_1_LATERAL :string

Description:
  • ROCKER_PANEL_1_LATERAL tag
Source:
ROCKER_PANEL_1_LATERAL tag
Type:
  • string

(static) ROCKER_PANEL_2_LATERAL :string

Description:
  • ROCKER_PANEL_2_LATERAL tag
Source:
ROCKER_PANEL_2_LATERAL tag
Type:
  • string

(static) ROCKER_PANEL_3_LATERAL :string

Description:
  • ROCKER_PANEL_3_LATERAL tag
Source:
ROCKER_PANEL_3_LATERAL tag
Type:
  • string

(static) STEERING_COLUMN_FORE_AFT :string

Description:
  • STEERING_COLUMN_FORE_AFT tag
Source:
STEERING_COLUMN_FORE_AFT tag
Type:
  • string

(static) STEERING_COLUMN_LATERAL :string

Description:
  • STEERING_COLUMN_LATERAL tag
Source:
STEERING_COLUMN_LATERAL tag
Type:
  • string

(static) STEERING_COLUMN_VERTICAL :string

Description:
  • STEERING_COLUMN_VERTICAL tag
Source:
STEERING_COLUMN_VERTICAL tag
Type:
  • string

(static) UPPER_DASH_FORE_AFT :string

Description:
  • UPPER_DASH_FORE_AFT tag
Source:
UPPER_DASH_FORE_AFT tag
Type:
  • string

(static) UPPER_DASH_LATERAL :string

Description:
  • UPPER_DASH_LATERAL tag
Source:
UPPER_DASH_LATERAL tag
Type:
  • string

(static) UPPER_DASH_VERTICAL :string

Description:
  • UPPER_DASH_VERTICAL tag
Source:
UPPER_DASH_VERTICAL tag
Type:
  • string

(static) UPPER_HINGE_1_FORE_AFT :string

Description:
  • UPPER_HINGE_1_FORE_AFT tag
Source:
UPPER_HINGE_1_FORE_AFT tag
Type:
  • string

(static) UPPER_HINGE_1_LATERAL :string

Description:
  • UPPER_HINGE_1_LATERAL tag
Source:
UPPER_HINGE_1_LATERAL tag
Type:
  • string

(static) UPPER_HINGE_1_VERTICAL :string

Description:
  • UPPER_HINGE_1_VERTICAL tag
Source:
UPPER_HINGE_1_VERTICAL tag
Type:
  • string

(static) UPPER_HINGE_2_FORE_AFT :string

Description:
  • UPPER_HINGE_2_FORE_AFT tag
Source:
UPPER_HINGE_2_FORE_AFT tag
Type:
  • string

(static) UPPER_HINGE_2_LATERAL :string

Description:
  • UPPER_HINGE_2_LATERAL tag
Source:
UPPER_HINGE_2_LATERAL tag
Type:
  • string

(static) UPPER_HINGE_2_VERTICAL :string

Description:
  • UPPER_HINGE_2_VERTICAL tag
Source:
UPPER_HINGE_2_VERTICAL tag
Type:
  • string

(static) UPPER_HINGE_3_FORE_AFT :string

Description:
  • UPPER_HINGE_3_FORE_AFT tag
Source:
UPPER_HINGE_3_FORE_AFT tag
Type:
  • string

(static) UPPER_HINGE_3_LATERAL :string

Description:
  • UPPER_HINGE_3_LATERAL tag
Source:
UPPER_HINGE_3_LATERAL tag
Type:
  • string

(static) UPPER_HINGE_3_VERTICAL :string

Description:
  • UPPER_HINGE_3_VERTICAL tag
Source:
UPPER_HINGE_3_VERTICAL tag
Type:
  • string

entity_type :string

Description:
  • Entity type constant
Source:
Overrides:
Entity type constant
Type:
  • string

history_title :string

Description:
  • The history_title text for the label
Source:
Overrides:
The history_title text for the label
Type:
  • string

id :string|number

Description:
  • Entity id (label or database history name)
Source:
Overrides:
Entity id (label or database history name)
Type:
  • string | number

iso :string

Description:
  • The iso text for the label
Source:
Overrides:
The iso text for the label
Type:
  • string

measurements :Array.<Measurement>

Description:
  • Measurements
Source:
Overrides:
Measurements
Type:

name :string

Description:
  • Entity name
Source:
Overrides:
Entity name
Type:
  • string

tag :string

Description:
  • Entity tag
Source:
Overrides:
Entity tag
Type:
  • string

Methods

(static) EntityTags() → {Array.<string>}

Description:
  • Returns an array of all the available entity tag strings
Source:
Example
let entity_tags = StructureEntity.EntityTags();
Returns:
Type
Array.<string>

toJSON() → {object}

Description:
  • JSON representation
Source:
Overrides:
Example
let json = entity.toJSON();
Returns:
Type
object