DoStructureAssessmentStructureData

DoStructureAssessmentStructureData

Class to hold data for a structure its model ID, unit system and extra data Used as an argument in the ProtocolAssessment.DoStructureAssessment function

Constructor

new DoStructureAssessmentStructureData(structure, model_id, unit_system, extraopt)

Source:
Example
let sd = new DoStructureAssessmentStructureData(s, 1, Workflow.UNIT_SYSTEM_U2);
Parameters:
Name Type Attributes Default Description
structure Structure Structure instance
model_id number Model ID
unit_system number Unit system, e.g. Workflow.UNIT_SYSTEM_U2
extra object <optional>
null Extra data

Members

extra :Object

Description:
  • Object for extra data
Source:
Object for extra data
Type:
  • Object

model_id :number

Description:
  • Model ID
Source:
Model ID
Type:
  • number

model_id :number

Description:
  • Model ID
Source:
Model ID
Type:
  • number

structure :Structure

Description:
  • Structure instance
Source:
Structure instance
Type:

structure :Structure

Description:
  • Structure instance
Source:
Structure instance
Type:

unit_system :number

Description:
  • Unit system, e.g. Workflow.UNIT_SYSTEM_U2
Source:
Unit system, e.g. Workflow.UNIT_SYSTEM_U2
Type:
  • number

unit_system :number

Description:
  • Unit system, e.g. Workflow.UNIT_SYSTEM_U2
Source:
Unit system, e.g. Workflow.UNIT_SYSTEM_U2
Type:
  • number

DoStructureAssessmentStructureData

Class to hold data for a structure its model ID and unit system Used as an argument in the ProtocolAssessment.DoStructureAssessment function

Constructor

new DoStructureAssessmentStructureData(structure, model_id, unit_system)

Source:
Example
let sd = new DoStructureAssessmentStructureData(s, 1, Workflow.UNIT_SYSTEM_U2);
Parameters:
Name Type Description
structure Structure Structure instance
model_id number Model ID
unit_system number Unit system, e.g. Workflow.UNIT_SYSTEM_U2

Members

extra :Object

Description:
  • Object for extra data
Source:
Object for extra data
Type:
  • Object

model_id :number

Description:
  • Model ID
Source:
Model ID
Type:
  • number

model_id :number

Description:
  • Model ID
Source:
Model ID
Type:
  • number

structure :Structure

Description:
  • Structure instance
Source:
Structure instance
Type:

structure :Structure

Description:
  • Structure instance
Source:
Structure instance
Type:

unit_system :number

Description:
  • Unit system, e.g. Workflow.UNIT_SYSTEM_U2
Source:
Unit system, e.g. Workflow.UNIT_SYSTEM_U2
Type:
  • number

unit_system :number

Description:
  • Unit system, e.g. Workflow.UNIT_SYSTEM_U2
Source:
Unit system, e.g. Workflow.UNIT_SYSTEM_U2
Type:
  • number