Instrumentation package definition

@INSTRUMENTATION_PACKAGE_DEFINITION {
@INSTRUMENTATION_PACKAGE_NAME {InstPkgName} {
@COMPONENT_DEFINITION {
@OBJECT_NAME {ObjectName}
@COMPONENT_LABEL {ComponentLabel}
@GAUGE_DEFINITION {
@SENSOR_NAME {SensorName}
@GAUGE_LABEL {GaugeLabel}
@MASKS {m1, m2, m3, m4, m1, m5, m6}
}
@GAUGE_DEFINITION {
...
}
}
@COMPONENT_DEFINITION {
...
}
@COMMENTS {CommentText}
}
}

Notes

  1. The instrumentation package defines a collection of sensors of the model. This collection is organized as a number of components, and each components involves a number of gauges.
  2. A component is defined by its ObjectName and ComponentLabel. The ObjectName is the name of the object of the model associated with this component. The ComponentLabel is a label that will be used identify this particular component of the instrumentation package. All component labels must be unique within an instrumentation package.
  3. A gauge is defined its SensorName and GaugeLabel. The SensorName is the name of a sensor from which the gauge acquires its data. The sensor must be associated with the object, ObjectName, of the parent component. The GaugeLabel is a label that will be used identify this particular gauge of the instrumentation package. All gauge labels must be unique within an instrumentation package.
  4. Each gauge can involve up to six data channels associated with the corresponding channels of the associated sensor. In some cases, however, the gauge uses a subset of the sensor channels. The optional mask array, mi, i = 1, 2, ..., 6, defines the active channels: if mi = 1, the corresponding sensor channel is active, if mi = 0, the corresponding sensor channel is ignored. Default values: mi = 1, i = 1, 2, ..., 6.
  5. It is possible to attach comments to the definition of the object; these comments have no effect on its definition.

Example 1.

The following example defines a simple instrumentation package.

@INSTRUMENTATION_PACKAGE_DEFINITION {
@INSTRUMENTATION_PACKAGE_NAME {InstPkg} {
@COMPONENT_DEFINITION {
@OBJECT_NAME {Beam1}
@COMPONENT_LABEL {BarNumber1}
@GAUGE_DEFINITION {
@SENSOR_NAME {SensorBeam1Forces}
@GAUGE_LABEL {Gauge1}
@MASKS { 0, 1, 0, 1, 0 ,1}
}
@GAUGE_DEFINITION {
@SENSOR_NAME {SensorBeam1Velocities}
@GAUGE_LABEL {Gauge2}
}
}
@COMPONENT_DEFINITION {
@OBJECT_NAME {Beam2}
@COMPONENT_LABEL {BarNumber2}
@GAUGE_DEFINITION {
@SENSOR_NAME {SensorBeam2Forces}
@GAUGE_LABEL {Gauge3}
}
@GAUGE_DEFINITION {
@SENSOR_NAME {SensorBeam2Velocities}
@GAUGE_LABEL {Gauge4}
}
}
}
}

For gauges Gauge2, Gauge3, and Gauge4, all data channel are used. For Gauge1, channels 2, 4, and 6 for sensor SensorBeam1Forces become channels 1, 2, and 3 of the gauge, respectively.