Constructor
new OccupantEntity(entity_type, id, name, tag, measurements, history_titleopt, isoopt)
- Source:
Example
let entity = new OccupantEntity(
OccupantEntity.NODE,
1,
"Node X Acceleration",
OccupantEntity.HEAD_NODE,
[new Measurement(Measurement.X_ACCELERATION, "AX")]);
Parameters:
Name | Type | Attributes | Default | 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 (name in the default entity id csv file) | ||
measurements |
Array.<Measurement> | List of raw measurements that can be read from the entity | ||
history_title |
string |
<optional> |
""
|
The entity database history title |
iso |
string |
<optional> |
""
|
The entity iso name |
Extends
Members
(static) ABDOMEN_BEAM_BACK :string
- Description:
- ABDOMEN_BEAM_BACK entity tag
- Source:
ABDOMEN_BEAM_BACK entity tag
Type:
- string
(static) ABDOMEN_BEAM_FRNT :string
- Description:
- ABDOMEN_BEAM_FRNT entity tag
- Source:
ABDOMEN_BEAM_FRNT entity tag
Type:
- string
(static) ABDOMEN_BEAM_MID :string
- Description:
- ABDOMEN_BEAM_MID entity tag
- Source:
ABDOMEN_BEAM_MID entity tag
Type:
- string
(static) ABDOMEN_COMPRESSION_LEFT_NODE_1 :string
- Description:
- ABDOMEN_COMPRESSION_LEFT_NODE_1 entity tag
- Source:
ABDOMEN_COMPRESSION_LEFT_NODE_1 entity tag
Type:
- string
(static) ABDOMEN_COMPRESSION_LEFT_NODE_2 :string
- Description:
- ABDOMEN_COMPRESSION_LEFT_NODE_2 entity tag
- Source:
ABDOMEN_COMPRESSION_LEFT_NODE_2 entity tag
Type:
- string
(static) ABDOMEN_COMPRESSION_RIGHT_NODE_1 :string
- Description:
- ABDOMEN_COMPRESSION_RIGHT_NODE_1 entity tag
- Source:
ABDOMEN_COMPRESSION_RIGHT_NODE_1 entity tag
Type:
- string
(static) ABDOMEN_COMPRESSION_RIGHT_NODE_2 :string
- Description:
- ABDOMEN_COMPRESSION_RIGHT_NODE_2 entity tag
- Source:
ABDOMEN_COMPRESSION_RIGHT_NODE_2 entity tag
Type:
- string
(static) ABDOMEN_LOWER_SPRING_ROT :string
- Description:
- ABDOMEN_LOWER_SPRING_ROT entity tag
- Source:
ABDOMEN_LOWER_SPRING_ROT entity tag
Type:
- string
(static) ABDOMEN_LOWER_SPRING_TRANS :string
- Description:
- ABDOMEN_LOWER_SPRING_TRANS entity tag
- Source:
ABDOMEN_LOWER_SPRING_TRANS entity tag
Type:
- string
(static) ABDOMEN_UPPER_SPRING_ROT :string
- Description:
- ABDOMEN_UPPER_SPRING_ROT entity tag
- Source:
ABDOMEN_UPPER_SPRING_ROT entity tag
Type:
- string
(static) ABDOMEN_UPPER_SPRING_TRANS :string
- Description:
- ABDOMEN_UPPER_SPRING_TRANS entity tag
- Source:
ABDOMEN_UPPER_SPRING_TRANS entity tag
Type:
- string
(static) BOTTOM_ABDOMEN_TRANSDUCER :string
- Description:
- BOTTOM_ABDOMEN_TRANSDUCER entity tag
- Source:
BOTTOM_ABDOMEN_TRANSDUCER entity tag
Type:
- string
(static) BOTTOM_FEMUR_BEAM :string
- Description:
- BOTTOM_FEMUR_BEAM entity tag
- Source:
BOTTOM_FEMUR_BEAM entity tag
Type:
- string
(static) CHEST_BOTTOM_RIB_SPRING_ROT :string
- Description:
- CHEST_BOTTOM_RIB_SPRING_ROT entity tag
- Source:
CHEST_BOTTOM_RIB_SPRING_ROT entity tag
Type:
- string
(static) CHEST_BOTTOM_RIB_SPRING_TRANS :string
- Description:
- CHEST_BOTTOM_RIB_SPRING_TRANS entity tag
- Source:
CHEST_BOTTOM_RIB_SPRING_TRANS entity tag
Type:
- string
(static) CHEST_BOTTOM_THORAX_TRANSDUCER :string
- Description:
- CHEST_BOTTOM_THORAX_TRANSDUCER entity tag
- Source:
CHEST_BOTTOM_THORAX_TRANSDUCER entity tag
Type:
- string
(static) CHEST_COMPRESSION_LOWER_LEFT_NODE_1 :string
- Description:
- CHEST_COMPRESSION_LOWER_LEFT_NODE_1 entity tag
- Source:
CHEST_COMPRESSION_LOWER_LEFT_NODE_1 entity tag
Type:
- string
(static) CHEST_COMPRESSION_LOWER_LEFT_NODE_2 :string
- Description:
- CHEST_COMPRESSION_LOWER_LEFT_NODE_2 entity tag
- Source:
CHEST_COMPRESSION_LOWER_LEFT_NODE_2 entity tag
Type:
- string
(static) CHEST_COMPRESSION_LOWER_RIGHT_NODE_1 :string
- Description:
- CHEST_COMPRESSION_LOWER_RIGHT_NODE_1 entity tag
- Source:
CHEST_COMPRESSION_LOWER_RIGHT_NODE_1 entity tag
Type:
- string
(static) CHEST_COMPRESSION_LOWER_RIGHT_NODE_2 :string
- Description:
- CHEST_COMPRESSION_LOWER_RIGHT_NODE_2 entity tag
- Source:
CHEST_COMPRESSION_LOWER_RIGHT_NODE_2 entity tag
Type:
- string
(static) CHEST_COMPRESSION_UPPER_LEFT_NODE_1 :string
- Description:
- CHEST_COMPRESSION_UPPER_LEFT_NODE_1 entity tag
- Source:
CHEST_COMPRESSION_UPPER_LEFT_NODE_1 entity tag
Type:
- string
(static) CHEST_COMPRESSION_UPPER_LEFT_NODE_2 :string
- Description:
- CHEST_COMPRESSION_UPPER_LEFT_NODE_2 entity tag
- Source:
CHEST_COMPRESSION_UPPER_LEFT_NODE_2 entity tag
Type:
- string
(static) CHEST_COMPRESSION_UPPER_RIGHT_NODE_1 :string
- Description:
- CHEST_COMPRESSION_UPPER_RIGHT_NODE_1 entity tag
- Source:
CHEST_COMPRESSION_UPPER_RIGHT_NODE_1 entity tag
Type:
- string
(static) CHEST_COMPRESSION_UPPER_RIGHT_NODE_2 :string
- Description:
- CHEST_COMPRESSION_UPPER_RIGHT_NODE_2 entity tag
- Source:
CHEST_COMPRESSION_UPPER_RIGHT_NODE_2 entity tag
Type:
- string
(static) CHEST_MIDDLE_RIB_SPRING_ROT :string
- Description:
- CHEST_MIDDLE_RIB_SPRING_ROT entity tag
- Source:
CHEST_MIDDLE_RIB_SPRING_ROT entity tag
Type:
- string
(static) CHEST_MIDDLE_RIB_SPRING_TRANS :string
- Description:
- CHEST_MIDDLE_RIB_SPRING_TRANS entity tag
- Source:
CHEST_MIDDLE_RIB_SPRING_TRANS entity tag
Type:
- string
(static) CHEST_MIDDLE_THORAX_TRANSDUCER :string
- Description:
- CHEST_MIDDLE_THORAX_TRANSDUCER entity tag
- Source:
CHEST_MIDDLE_THORAX_TRANSDUCER entity tag
Type:
- string
(static) CHEST_NODE_X
- Description:
- CHEST_NODE_X entity tag
- Source:
CHEST_NODE_X entity tag
(static) CHEST_NODE_Y :string
- Description:
- CHEST_NODE_Y entity tag
- Source:
CHEST_NODE_Y entity tag
Type:
- string
(static) CHEST_NODE_Z :string
- Description:
- CHEST_NODE_Z entity tag
- Source:
CHEST_NODE_Z entity tag
Type:
- string
(static) CHEST_SPRING
- Description:
- CHEST_SPRING entity tag
- Source:
CHEST_SPRING entity tag
(static) CHEST_SPRING_LOW :string
- Description:
- CHEST_SPRING_LOW entity tag
- Source:
CHEST_SPRING_LOW entity tag
Type:
- string
(static) CHEST_SPRING_MID :string
- Description:
- CHEST_SPRING_MID entity tag
- Source:
CHEST_SPRING_MID entity tag
Type:
- string
(static) CHEST_SPRING_UPP :string
- Description:
- CHEST_SPRING_UPP entity tag
- Source:
CHEST_SPRING_UPP entity tag
Type:
- string
(static) CHEST_TOP_THORAX_TRANSDUCER :string
- Description:
- CHEST_TOP_THORAX_TRANSDUCER entity tag
- Source:
CHEST_TOP_THORAX_TRANSDUCER entity tag
Type:
- string
(static) CHEST_UPPER_RIB_SPRING_ROT :string
- Description:
- CHEST_UPPER_RIB_SPRING_ROT entity tag
- Source:
CHEST_UPPER_RIB_SPRING_ROT entity tag
Type:
- string
(static) CHEST_UPPER_RIB_SPRING_TRANS :string
- Description:
- CHEST_UPPER_RIB_SPRING_TRANS entity tag
- Source:
CHEST_UPPER_RIB_SPRING_TRANS entity tag
Type:
- string
(static) HEAD_NODE :string
- Description:
- HEAD_NODE entity tag
- Source:
HEAD_NODE entity tag
Type:
- string
(static) HEAD_NODE_Y :string
- Description:
- HEAD_NODE_Y entity tag
- Source:
HEAD_NODE_Y entity tag
Type:
- string
(static) HEAD_NODE_Z :string
- Description:
- HEAD_NODE_Z entity tag
- Source:
HEAD_NODE_Z entity tag
Type:
- string
(static) LEFT_ACETABULUM_LOADCELL :string
- Description:
- LEFT_ACETABULUM_LOADCELL entity tag
- Source:
LEFT_ACETABULUM_LOADCELL entity tag
Type:
- string
(static) LEFT_FEMUR_LOADCELL :string
- Description:
- LEFT_FEMUR_LOADCELL entity tag
- Source:
LEFT_FEMUR_LOADCELL entity tag
Type:
- string
(static) LEFT_FOOT_NODE :string
- Description:
- LEFT_FOOT_NODE entity tag
- Source:
LEFT_FOOT_NODE entity tag
Type:
- string
(static) LEFT_KNEE_TRANSDUCER :string
- Description:
- LEFT_KNEE_TRANSDUCER entity tag
- Source:
LEFT_KNEE_TRANSDUCER entity tag
Type:
- string
(static) LEFT_LOWER_TIBIA_LOADCELL :string
- Description:
- LEFT_LOWER_TIBIA_LOADCELL entity tag
- Source:
LEFT_LOWER_TIBIA_LOADCELL entity tag
Type:
- string
(static) LEFT_UPPER_TIBIA_LOADCELL :string
- Description:
- LEFT_UPPER_TIBIA_LOADCELL entity tag
- Source:
LEFT_UPPER_TIBIA_LOADCELL entity tag
Type:
- string
(static) LUMBAR_BEAM :string
- Description:
- LUMBAR_BEAM entity tag
- Source:
LUMBAR_BEAM entity tag
Type:
- string
(static) NECK_LOADCELL :string
- Description:
- NECK_LOADCELL entity tag
- Source:
NECK_LOADCELL entity tag
Type:
- string
(static) NECK_LOWER_BEAM :string
- Description:
- NECK_LOWER_BEAM entity tag
- Source:
NECK_LOWER_BEAM entity tag
Type:
- string
(static) NECK_UPPER_BEAM :string
- Description:
- NECK_UPPER_BEAM entity tag
- Source:
NECK_UPPER_BEAM entity tag
Type:
- string
(static) PELVIS_BEAM :string
- Description:
- PELVIS_BEAM entity tag
- Source:
PELVIS_BEAM entity tag
Type:
- string
(static) PUBIC_SYMPHYSIS_BEAM :string
- Description:
- PUBIC_SYMPHYSIS_BEAM entity tag
- Source:
PUBIC_SYMPHYSIS_BEAM entity tag
Type:
- string
(static) RIGHT_ACETABULUM_LOADCELL :string
- Description:
- RIGHT_ACETABULUM_LOADCELL entity tag
- Source:
RIGHT_ACETABULUM_LOADCELL entity tag
Type:
- string
(static) RIGHT_FEMUR_LOADCELL :string
- Description:
- RIGHT_FEMUR_LOADCELL entity tag
- Source:
RIGHT_FEMUR_LOADCELL entity tag
Type:
- string
(static) RIGHT_FOOT_NODE :string
- Description:
- RIGHT_FOOT_NODE entity tag
- Source:
RIGHT_FOOT_NODE entity tag
Type:
- string
(static) RIGHT_KNEE_TRANSDUCER :string
- Description:
- RIGHT_KNEE_TRANSDUCER entity tag
- Source:
RIGHT_KNEE_TRANSDUCER entity tag
Type:
- string
(static) RIGHT_LOWER_TIBIA_LOADCELL :string
- Description:
- RIGHT_LOWER_TIBIA_LOADCELL entity tag
- Source:
RIGHT_LOWER_TIBIA_LOADCELL entity tag
Type:
- string
(static) RIGHT_UPPER_TIBIA_LOADCELL :string
- Description:
- RIGHT_UPPER_TIBIA_LOADCELL entity tag
- Source:
RIGHT_UPPER_TIBIA_LOADCELL entity tag
Type:
- string
(static) SHOULDER_LEFT_BEAM :string
- Description:
- SHOULDER_LEFT_BEAM entity tag
- Source:
SHOULDER_LEFT_BEAM entity tag
Type:
- string
(static) SHOULDER_RIGHT_BEAM :string
- Description:
- SHOULDER_RIGHT_BEAM entity tag
- Source:
SHOULDER_RIGHT_BEAM entity tag
Type:
- string
(static) SHOULDER_TRANSDUCER :string
- Description:
- SHOULDER_TRANSDUCER entity tag
- Source:
SHOULDER_TRANSDUCER entity tag
Type:
- string
(static) TOP_ABDOMEN_TRANSDUCER :string
- Description:
- TOP_ABDOMEN_TRANSDUCER entity tag
- Source:
TOP_ABDOMEN_TRANSDUCER entity tag
Type:
- string
(static) UPPER_FEMUR_BEAM :string
- Description:
- UPPER_FEMUR_BEAM entity tag
- Source:
UPPER_FEMUR_BEAM entity tag
Type:
- string
(static) XSECTION_ACETABULAR_ID :string
- Description:
- XSECTION_ACETABULAR_ID entity tag
- Source:
XSECTION_ACETABULAR_ID entity tag
Type:
- string
(static) XSECTION_ILIAC_ID :string
- Description:
- XSECTION_ILIAC_ID entity tag
- Source:
XSECTION_ILIAC_ID entity 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:
- Array.<Measurement>
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(body_part_typeopt) → {Array.<string>}
- Description:
- Returns an array of all the available entity tag strings
- Source:
Example
// Get all entity tags
let all_entity_tags = OccupantEntity.EntityTags();
// Get entity tags for the neck
let neck_entity_tags = OccupantEntityTags(OccupantBodyPart.NECK);
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
body_part_type |
string |
<optional> |
null
|
Body part type, if given only tags for that body part type will be returned, otherwise all entity tags are returned |
Returns:
- Type
- Array.<string>
(static) FromJSON(json) → (nullable) {OccupantEntity}
- Description:
- construct an OccupantEntity from JSON
- Source:
Parameters:
Name | Type | Description |
---|---|---|
json |
Object |
Returns:
- Type
- OccupantEntity
(static) FromTagAndType(tag, entity_type, id, history_titleopt, isoopt)
- Description:
- This is used to create the entities (with name and measurements) when reading in the json occupants as the json strips the name and measurement data out to keep it clean and easier to read
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
tag |
string | the entity tag e.g. HEAD_NODE_Y | ||
entity_type |
string | the entity type e.g. node, beam, spring tr, section... | ||
id |
string | number | the id of the entity | ||
history_title |
string |
<optional> |
""
|
The entity database history title |
iso |
string |
<optional> |
""
|
The entity iso name |
(static) GetNameAndMeasurements(tag, entity_type) → {NameMeasurement}
- Description:
- Returns array of measurments based on the tag and the entity_type
- Source:
Parameters:
Name | Type | Description |
---|---|---|
tag |
string | e.g. "HEAD_NODE" |
entity_type |
string |
Returns:
//TODO GOOGLE THIS or ASK Chris if no luck
- Type
- NameMeasurement
toJSON() → {object}
- Description:
- JSON representation
- Source:
- Overrides:
Example
let json = entity.toJSON();
Returns:
- Type
- object