Structure

Structure

Class representing a structural component

It extends the BaseComponent class

Constructor

new Structure(structure_type, entities)

Source:
Example
let structure = new Structure(Structure.A_PILLAR, [entity1, entity2]);
Parameters:
Name Type Description
structure_type string Structure type constant
entities Array.<StructureEntity> Array of StructureEntity instances

Extends

Members

(static) A_PILLAR :string

Description:
  • A-Pillar structure
Source:
A-Pillar structure
Type:
  • string

(static) ACCELERATOR_PEDAL :string

Description:
  • Accelerator pedal structure
Source:
Accelerator pedal structure
Type:
  • string

(static) B_PILLAR :string

Description:
  • B-Pillar structure
Source:
B-Pillar structure
Type:
  • string

(static) BRAKE_PEDAL :string

Description:
  • Brake pedal structure
Source:
Brake pedal structure
Type:
  • string

(static) CLUTCH_PEDAL :string

Description:
  • Clutch pedal structure
Source:
Clutch pedal structure
Type:
  • string

(static) DOOR :string

Description:
  • Door structure
Source:
Door structure
Type:
  • string

(static) DRIVER_CENTRE_TOEPAN :string

Description:
  • Driver centre toepan structure
Source:
Driver centre toepan structure
Type:
  • string

(static) DRIVER_FOOTREST :string

Description:
  • Driver footrest structure
Source:
Driver footrest structure
Type:
  • string

(static) DRIVER_LEFT_TOEPAN :string

Description:
  • Driver left toepan structure
Source:
Driver left toepan structure
Type:
  • string

(static) DRIVER_LOWER_HINGE_1 :string

Description:
  • Driver lower hinge 1 structure
Source:
Driver lower hinge 1 structure
Type:
  • string

(static) DRIVER_LOWER_HINGE_2 :string

Description:
  • Driver lower hinge 2 structure
Source:
Driver lower hinge 2 structure
Type:
  • string

(static) DRIVER_LOWER_HINGE_3 :string

Description:
  • Driver lower hinge 3 structure
Source:
Driver lower hinge 3 structure
Type:
  • string

(static) DRIVER_RIGHT_TOEPAN :string

Description:
  • Driver right toepan structure
Source:
Driver right toepan structure
Type:
  • string

(static) DRIVER_ROCKER_PANEL_1 :string

Description:
  • Driver rocker panel 1 structure
Source:
Driver rocker panel 1 structure
Type:
  • string

(static) DRIVER_ROCKER_PANEL_2 :string

Description:
  • Driver Rocker panel 2 structure
Source:
Driver Rocker panel 2 structure
Type:
  • string

(static) DRIVER_ROCKER_PANEL_3 :string

Description:
  • Driver Rocker panel 3 structure
Source:
Driver Rocker panel 3 structure
Type:
  • string

(static) DRIVER_UPPER_DASH :string

Description:
  • Driver upper dash structure
Source:
Driver upper dash structure
Type:
  • string

(static) DRIVER_UPPER_HINGE_1 :string

Description:
  • Driver upper hinge 1 structure
Source:
Driver upper hinge 1 structure
Type:
  • string

(static) DRIVER_UPPER_HINGE_2 :string

Description:
  • Driver upper hinge 2 structure
Source:
Driver upper hinge 2 structure
Type:
  • string

(static) DRIVER_UPPER_HINGE_3 :string

Description:
  • Driver upper hinge 3 structure
Source:
Driver upper hinge 3 structure
Type:
  • string

(static) HEAD_EXCURSION :string

Description:
  • Head excursion structure
Source:
Head excursion structure
Type:
  • string

(static) LEFT_INSTRUMENT_PANEL :string

Description:
  • Left instrument panel structure
Source:
Left instrument panel structure
Type:
  • string

(static) PARKING_BRAKE :string

Description:
  • Parking brake structure
Source:
Parking brake structure
Type:
  • string

(static) PASSENGER_CENTRE_DASH :string

Description:
  • Passenger centre dash structure
Source:
Passenger centre dash structure
Type:
  • string

(static) PASSENGER_CENTRE_TOEPAN :string

Description:
  • Passenger centre toepan structure
Source:
Passenger centre toepan structure
Type:
  • string

(static) PASSENGER_FOOTREST :string

Description:
  • Passenger footrest structure
Source:
Passenger footrest structure
Type:
  • string

(static) PASSENGER_LEFT_LOWER_DASH :string

Description:
  • Passenger left lower dash structure
Source:
Passenger left lower dash structure
Type:
  • string

(static) PASSENGER_LEFT_TOEPAN :string

Description:
  • Passenger left toepan structure
Source:
Passenger left toepan structure
Type:
  • string

(static) PASSENGER_LOWER_HINGE_1 :string

Description:
  • Passenger lower hinge 1 structure
Source:
Passenger lower hinge 1 structure
Type:
  • string

(static) PASSENGER_LOWER_HINGE_2 :string

Description:
  • Passenger lower hinge 2 structure
Source:
Passenger lower hinge 2 structure
Type:
  • string

(static) PASSENGER_LOWER_HINGE_3 :string

Description:
  • Passenger lower hinge 3 structure
Source:
Passenger lower hinge 3 structure
Type:
  • string

(static) PASSENGER_RIGHT_LOWER_DASH :string

Description:
  • Passenger right lower dash structure
Source:
Passenger right lower dash structure
Type:
  • string

(static) PASSENGER_RIGHT_TOEPAN :string

Description:
  • Passenger right toepan structure
Source:
Passenger right toepan structure
Type:
  • string

(static) PASSENGER_ROCKER_PANEL_1 :string

Description:
  • Passenger rocker panel 1 structure
Source:
Passenger rocker panel 1 structure
Type:
  • string

(static) PASSENGER_ROCKER_PANEL_2 :string

Description:
  • Passenger Rocker panel 2 structure
Source:
Passenger Rocker panel 2 structure
Type:
  • string

(static) PASSENGER_ROCKER_PANEL_3 :string

Description:
  • Passenger Rocker panel 3 structure
Source:
Passenger Rocker panel 3 structure
Type:
  • string

(static) PASSENGER_UPPER_DASH :string

Description:
  • Passenger upper dash structure
Source:
Passenger upper dash structure
Type:
  • string

(static) PASSENGER_UPPER_HINGE_1 :string

Description:
  • Passenger upper hinge 1 structure
Source:
Passenger upper hinge 1 structure
Type:
  • string

(static) PASSENGER_UPPER_HINGE_2 :string

Description:
  • Passenger upper hinge 2 structure
Source:
Passenger upper hinge 2 structure
Type:
  • string

(static) PASSENGER_UPPER_HINGE_3 :string

Description:
  • Passenger upper hinge 3 structure
Source:
Passenger upper hinge 3 structure
Type:
  • string

(static) RIGHT_INSTRUMENT_PANEL :string

Description:
  • Right instrument panel structure
Source:
Right instrument panel structure
Type:
  • string

(static) STEERING_COLUMN :string

Description:
  • Steering column structure
Source:
Steering column structure
Type:
  • string

component_type :string

Description:
  • Component constant
Source:
Overrides:
Component constant
Type:
  • string

entities :Array.<BaseEntity>

Description:
  • Array of BaseEntity instances
Source:
Overrides:
Array of BaseEntity instances
Type:

Methods

(static) CreateAcceleratorPedalEntities() → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the accelerator pedal structure
Source:
Example
let entities = Structure.CreateAcceleratorPedalEntities();
Returns:
Type
Array.<StructureEntity>

(static) CreateAPillarEntities() → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the A-Pillar structure
Source:
Example
let entities = Structure.CreateAPillarEntities();
Returns:
Type
Array.<StructureEntity>

(static) CreateBPillarEntities() → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the B-Pillar structure

    The B-Pillar assessment is done in D3PLOT by taking a cross-section through the structure. It requires the cut-section method (constant X, Y or Z, or three nodes) the B-Pillar parts, shift deform nodes, the ground Z coordinate, the seat centre Y coordinate and the H-point Z coordinate.

    This is different to the all the other structure assessments that are carried out in T/HIS by extracting data from database history entities.

    As such, this doesn't really fit into the Structure - StructureEntity - Measurement model, so just return an empty array here so that it appears in the list of structures in the GUI.

    The pre and post GUIs have bespoke logic for selecting, writing, reading and processing the B-Pillar data.

Source:
Example
let entities = Structure.CreateBPillarEntities();
Returns:
Type
Array.<StructureEntity>

(static) CreateBrakePedalEntities() → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the brake pedal structure
Source:
Example
let entities = Structure.CreateBrakePedalEntities();
Returns:
Type
Array.<StructureEntity>

(static) CreateCentreDashEntities() → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the centre dash structure
Source:
Example
let entities = Structure.CreateCentreDashEntities();
Returns:
Type
Array.<StructureEntity>

(static) CreateClutchPedalEntities() → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the clutch pedal structure
Source:
Example
let entities = Structure.CreateClutchPedalEntities();
Returns:
Type
Array.<StructureEntity>

(static) CreateDoorEntities() → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the door structure
Source:
Example
let entities = Structure.CreateDoorEntities();
Returns:
Type
Array.<StructureEntity>

(static) CreateFootrestEntities(occupant) → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the footrest structure
Source:
Example
let entities = Structure.CreateFootrestEntities("Driver");
Parameters:
Name Type Description
occupant string "Driver" or "Passenger"
Returns:
Type
Array.<StructureEntity>

(static) CreateFromUserData(user_data_structure) → {Structure}

Description:
  • Creates a Structure instance from user data
Source:
Example
for (let s of user_data.structures) {
    let structure = Structure.CreateFromUserData(s);
}
Parameters:
Name Type Description
user_data_structure Object A single structure object from the user data
Returns:
Type
Structure

(static) CreateHeadExcursionEntities() → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the Head Excursion structure The Head Excursion assessment is done in D3PLOT by taking a cross-section through the structure. It requires the cut-section method (constant X, Y or Z, or three nodes) the head parts, barrier parts, shift deform nodes, the seat centre Y coordinate and whether there's a counter measure.

    This is different to the all the other structure assessments that are carried out in T/HIS by extracting data from database history entities.

    As such, this doesn't really fit into the Structure - StructureEntity - Measurement model, so just return an empty array here so that it appears in the list of structures in the GUI.

    The pre and post GUIs have bespoke logic for selecting, writing, reading and processing the Head Excursion data.

Source:
Example
let entities = Structure.CreateBPillarEntities();
Returns:
Type
Array.<StructureEntity>

(static) CreateHingeEntities(occupant, position, number) → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for a hinge structure
Source:
Example
let entities = Structure.CreateHingeEntities("Driver", "Lower", 1);
Parameters:
Name Type Description
occupant string "Driver" or "Passenger"
position string "Lower" or "Upper"
number number Hinge number 1, 2 or 3
Returns:
Type
Array.<StructureEntity>

(static) CreateLeftInstrumentPanelEntities() → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the left instrument panel structure
Source:
Example
let entities = Structure.CreateLeftInstrumentEntities();
Returns:
Type
Array.<StructureEntity>

(static) CreateLowerDashEntities(side) → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the lower dash structure
Source:
Example
let entities = Structure.CreateLowerDashEntities("Left");
Parameters:
Name Type Description
side string "Left" or "Right" side
Returns:
Type
Array.<StructureEntity>

(static) CreateParkingBrakeEntities() → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the parking brake structure
Source:
Example
let entities = Structure.CreateParkingBrakeEntities();
Returns:
Type
Array.<StructureEntity>

(static) CreateRightInstrumentPanelEntities() → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the right instrument panel structure
Source:
Example
let entities = Structure.CreateRightInstrumentEntities();
Returns:
Type
Array.<StructureEntity>

(static) CreateRockerPanelEntities(occupant, number) → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for a rocker panel structure
Source:
Example
let entities = Structure.CreateRockerPanelEntities("Driver", 1);
Parameters:
Name Type Description
occupant string "Driver" or "Passenger"
number number Rocker panel number 1, 2 or 3
Returns:
Type
Array.<StructureEntity>

(static) CreateSteeringColumnEntities() → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the steering column structure
Source:
Example
let entities = Structure.CreateSteeringColumnEntities();
Returns:
Type
Array.<StructureEntity>

(static) CreateStructure(structure_type) → {Structure}

Description:
  • Returns a Structure instance with the required StructureEntities. The entity IDs are set to 0.
Source:
Example
let structure = Structure.CreateStructure(Structure.A_PILLAR);
Parameters:
Name Type Description
structure_type string Structure type constant
Returns:
Type
Structure

(static) CreateToepanEntities(occupant, location) → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for a toepan structure
Source:
Example
let entities = Structure.CreateToepanEntities("Driver", "Left");
Parameters:
Name Type Description
occupant string "Driver" or "Passenger"
location string "Left", "Centre" or "Right"
Returns:
Type
Array.<StructureEntity>

(static) CreateUpperDashEntities(occupant) → {Array.<StructureEntity>}

Description:
  • Creates and returns StructureEntity instances for the upper dash structure
Source:
Example
let entities = Structure.CreateUpperDashEntities("Driver");
Parameters:
Name Type Description
occupant string "Driver" or "Passenger"
Returns:
Type
Array.<StructureEntity>

(static) fromString() → {string}

Description:
  • From string representation with hypens and underscores replaced with spaces and first letter of every word capitalized
Source:
Example
let s = Structure.fromString("Passenger-Rocker-Panel-3");
Returns:
Type
string

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

Description:
  • Return an alphabetical array of all the available structure type strings
Source:
Example
let structure_types = Structure.Types();
Returns:
Type
Array.<string>

GetEntityByTag(tag) → (nullable) {BaseEntity}

Description:
  • Get an BaseEntity by tag
Source:
Overrides:
Example
let entity = component.GetEntityByTag(OccupantEntity.HEAD_NODE);
Parameters:
Name Type Description
tag string Entity tag
Returns:
Type
BaseEntity

ReadRawStructureMeasurements(model) → {ComponentMeasurementCurves}

Description:
  • Reads the raw structure measurements into T/HIS and returns them in a ComponentMeasurementCurves instance
Source:
Parameters:
Name Type Description
model Model Model to read data from
Returns:
Type
ComponentMeasurementCurves

toJSON() → {object}

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

toString() → {string}

Description:
  • String representation
Source:
Example
let s = structure.toString();
Returns:
Type
string