Probe Object Attribute Descriptions
anim start
This attribute specifies the start of a window of simulation time over which to run the animation described by the probe. It is used in conjunction with the “anim stop” attribute to define a window of simulation time. The default of 0.0 seconds corresponds to the beginning of simulation time.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write | read |
| Default Value | 0.0 | |
| Units | seconds | |
| Constraints | 0.0 <= anim start <= anim stop |
anim stop
This attribute specifies the end of a window of simulation time over which to run the animation described by the probe. It is used in conjunction with the “anim start” attribute to define a window of simulation time. The default of “infinite” corresponds to the end of simulation time.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write | read |
| Default Value | infinite | |
| Units | seconds | |
| Constraints | 0.0 <= anim start <= anim stop |
attribute
This required attribute specifies the name of the simulation attribute or object attribute from which to collect data. If the “object” attribute is not specified, any simulation attribute defined by the process models in the network can be specified. If the “object” attribute is specified, only the attributes of the specified object can be selected.
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints |
background color
This attribute specifies the color of the outer frame (the part surrounding the plotting area) of the panel in which the statistic is animated. The value of this attribute has the form RGBnnn, where each integer n represents a color intensity. The first digit represents red, the second represents green, and the third represents blue. Therefore, RGB000 corresponds to black, RGB333 corresponds to white, RGB300 corresponds to red, and so on.
| Editing | Simulation | |
|---|---|---|
| Data Type | color | color |
| Access | read/write | read |
| Default Value | RGB222 | |
| Units | ||
| Constraints |
capture mode
This attribute specifies how to process the collected values before writing the values to the simulation output. In normal mode, all values are written without processing. Other modes modify or discard values, either to reduce the volume of output data, or to present an alternative view of the statistic. For more information on the supported capture modes, see Chapter 10 “Simulation Design” on page 375.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | normal | |
| Units | ||
| Constraints | normal, sample, bucket, glitch removal |
channel
This required attribute specifies the name of the channel that acts as the source of the statistic.
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | valid channel name |
critical low value
This attribute specifies a value below which the statistic value is considered critically low. In conjunction with the “warning low value”, “warning high value”, and “critical high value” attributes, it defines critically low, low, normal, high, and critically high value ranges that will be indicated in statistic graphs by green, yellow, and red backgrounds.
| Editing | Simulation | |
|---|---|---|
| Data Type | booldouble | booldouble |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | numeric value, “disabled” |
critical high value
This attribute specifies a value above which the statistic value is considered critically high. In conjunction with the “critical low value”, “warning low value”, and “warning high value” attributes, it defines critically low, low, normal, high, and critically high value ranges that will be indicated in statistic graphs by green, yellow, and red backgrounds.
| Editing | Simulation | |
|---|---|---|
| Data Type | booldouble | booldouble |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | numeric value, “disabled” |
demand
This required attribute specifies the name of the demand that acts as the source of the statistic.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | valid demand name |
draw style
This attribute specifies how the statistic is displayed the first time you display it in an analysis panel. You can also specify the draw style when you request that the statistic be collected, by specifying the style in the Statistic pop-up menu (see Chapter 3 “Project Editor” on page 89).
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | enumerated |
| Access | read/write | read |
| Default Value | linear | |
| Units | ||
| Constraints | sample-hold, bar, discrete, linear, square-wave, bar chart |
group
Statistics are organized into groups by protocol (IP or Ethernet, for example) or by application type (client FTP or Server Email, for example). This read-only attribute displays the group name.
The statistic browser shows statistics first by type (global, module, node, link, animation) and then by group. The statistics and groups displayed by the browser vary depending on whether you right-click in the workspace (to display global statistics) or on a specific object.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read | read |
| Default Value | none | |
| Units | ||
| Constraints |
initial width
This attribute specifies the initial width (in seconds) of the x-axis of the animation panel. The width remains at this value if the “scrolling” attribute is enabled.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write | read |
| Default Value | 0.0 | |
| Units | seconds | |
| Constraints |
label
Assigning a non-empty value to this attribute alters the function of a custom animation probe such that it no longer generally enables animation requests issued within the probed object (i.e., subnet, node, or module). Instead, the probe selectively enables those animation requests that reference a specific animation viewer ID. This animation viewer ID is associated with the custom animation probe and must be obtained via the KP op_anim_lprobe_anvid(). This KP accepts an argument that must match the value of the probe’s “label” attribute to return the probe’s associated viewer ID.
By referencing a viewer ID which is obtained from op_anim_lprobe_anvid(), animation KP invocations establish a dependency on the existence of an appropriately labeled custom animation probe. Therefore, labeled custom animation probes can be used to enable specific custom animation capabilities of a model, specified by an agreed upon name.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints |
link
This required attribute specifies the name of the link that acts as the source of the statistic.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | valid link name |
module
This attribute specifies the name of the module that acts as a source of animation requests or the collected statistic. It must be used in conjunction with the “subnet” and “node” attributes to uniquely specify the module of interest. This attribute should be left empty if the probe is intended to enable animations or collect a statistic for an entire node or an entire subnet.
Statistic probes
The “submodule” attribute can be used to specify a submodule within the module as the source of the statistic. This attribute can be left empty if the desired statistic is a module or submodule statistic that has been promoted to the node level.
Automatic animation probes
Currently, the only automatic animation representation supported for module-level probes is “state tracking”, which allows visualization of a process’ transitions through its STD.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | valid module name |
name
This attribute is a text string used to create a name for the probe. It is used for organizational purposes only and does not have any effect on the operation of the probe. It allows you to assign a name to a probe so that it is easier to recognize its function and it can be readily identified in reports. The default value is “pb_n” where n is an integer starting with one and increasing by one each time any new probe is created.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | “pb_n”: n is an integer | |
| Units | ||
| Constraints |
node
Statistic probes
This is a required attribute that specifies the name of the node that acts as the source of the collected statistic. To directly probe a module or submodule, specify one of the values for the “module” and/or “submodule” attributes.
Animation probes
This attribute holds either the name of the node that acts as a source of animation requests or the name of the parent node of a module that is to be animated. The probe applies to the node object itself if the “module” attribute is left empty. Otherwise, the probe applies to the specified module within the node. This attribute should be left empty if the probe is intended to enable animations for an entire subnet.
Automatic animation probes—Currently, the only automatic animation representation supported for node-level probes is “packet flows”, which tracks the flow of packets on the packet streams between modules.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | valid node name |
object
This attribute specifies the name of the object whose attribute is to be probed. The “object” attribute can be left blank, in which case the probe can only apply to simulation attributes. The object can be a subnet, node, link, module, or submodule. The object must be specified using standard hierarchical object naming format.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints |
ordinate label
This attribute, if not empty, specifies a name used for the collected statistic resulting from a probe. It applies to both scalar and vector statistics. It is generally used to override and simplify the default names automatically assigned to statistics (default names are based on the hierarchical name of the probed object).
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints |
panel height
This attribute specifies the height (in pixels) of the panel in which the statistic is animated. It is used with the “panel width”, “panel x” and “panel y” attributes to define the region occupied by the animation panel within the animation viewer.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read/write | read |
| Default Value | 304 | |
| Units | pixels | |
| Constraints | >= 100 |
panel name
This attribute specifies the name of the panel in which the statistic is displayed. If separate statistic animation probes specify the same window name and the same panel name, the resulting graphs are combined into the same statistic animation panel. The axes of the panel automatically adjust as necessary to display all of the traces that are present.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints |
panel width
This attribute specifies the width (in pixels) of the panel in which the statistic is animated. It is used with the “panel height”, “panel x” and “panel y” attributes to define the region occupied by the animation panel within the animation viewer.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read/write | read |
| Default Value | 442 | |
| Units | pixels | |
| Constraints | >= 100 |
panel x
This attribute specifies the x-coordinate (in pixels) of the upper-left corner of the panel in which the statistic is animated. It is used with the “panel width”, “panel height” and “panel y” attributes to define the region occupied by the animation panel within the animation viewer.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read/write | read |
| Default Value | 10 | |
| Units | pixels | |
| Constraints | >= 0 |
panel y
This attribute specifies the y-coordinate (in pixels) of the upper-left corner of the panel in which the statistic is animated. It is used with the “panel width”, “panel height” and “panel x” attributes to define the region occupied by the animation panel within the animation viewer.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read/write | read |
| Default Value | 10 | |
| Units | pixels | |
| Constraints | >= 0 |
path
This required attribute specifies the name of the path that acts as the source of the statistic.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | valid path name |
representation
This attribute specifies the form of animation that the probe generates for the object of interest. Before specifying this attribute value, the object of interest must be identified with a combination of “subnet”, “node” and “module” attributes. The possible values for the “representation” attribute depend on the type of object specified. For example, automatic animations of subnets can display packet flows or node movement; automatic animations of nodes can display packet flows; automatic animations of modules can display state tracking.
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | integer |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | a valid representation type for the probed object |
scalar data
This attribute is a toggle that either enables or prevents scalar data collection for the affected statistic. If it is enabled, the attribute “scalar type” defines the nature of the scalar data that is recorded and the attributes “scalar start” and “scalar stop” specify a time window during which data is gathered to compute the scalar statistic. Probed scalar data is recorded at the end of a simulation based on data gathered throughout the simulation. For more information on scalar statistics, see Chapter 11 “Data Analysis” on page 422 and Chapter 10 “Simulation Design” on page 375 of the Modeling Concepts manual.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle | toggle |
| Access | read/write | read |
| Default Value | disabled | |
| Units | ||
| Constraints |
scalar start
If the “scalar data” attribute has the value “enabled”, then “scalar start” and “scalar stop” together specify a window of simulation time over which the scalar statistic is computed. Specifically, only the updates in the probed statistic that occur within the specified time interval are considered for computation of the resulting scalar value.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write | read |
| Default Value | 0.0 | |
| Units | seconds | |
| Constraints | scalar start < scalar stop |
scalar stop
If the “scalar data” attribute has the value “enabled”, then “scalar start” and “scalar stop” together specify a window of simulation time over which the scalar statistic is computed. Specifically, only the updates in the probed statistic that occur within the specified time interval are considered for computation of the resulting scalar value.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write | read |
| Default Value | infinite | |
| Units | seconds | |
| Constraints | scalar start < scalar stop |
scalar type
If the attribute “scalar data” has the value “enabled”, then “scalar type” is used to calculate one of these metrics applied to the statistic of interest. For a complete description of these metrics, see Chapter 10 “Simulation Design” on page 375.
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | integer |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | last value, sample mean, time average, variance, min value, max value |
scrolling
When this attribute is enabled, the width of the animation panel remains fixed at the “initial width”. As the statistic receives updated values that exceed the currently displayed time range, the panel adjusts by shifting the time axis towards increasing values. The statistics therefore appears to scroll in the direction of decreasing values.
If scrolling is disabled, the analysis panel instead adjusts to show the new data by expanding the time axis. In this way, the entire history of the statistic is always visible, but the resolution with which it is plotted becomes progressively less over time.
| Editing | Simulation | |
|---|---|---|
| Data Type | boolean | boolean |
| Access | read/write | read |
| Default Value | 0.0 | |
| Units | ||
| Constraints |
src objid
This attribute uniquely identifies the probed simulation object, referenced by its object ID. The value of “src objid” is assigned by the system and is determined by other attributes of the probe (not all apply to every probe type): “subnet”, “node”, “module”, “submodule”, “link”, and “channel”.
This attribute exists only during simulation and is useful for verifying that probes are correctly configured.
| Editing | Simulation | |
|---|---|---|
| Data Type | not applicable | integer |
| Access | not applicable | read |
| Default Value | ||
| Units | ||
| Constraints |
statistic
This attribute represents the name of the statistic to be collected or animated. Most module and submodule types support a set of predefined statistics that are descriptive of their behavior or performance. In addition, processors and queues support a set of generic statistics whose values are driven by user-defined process models. For more information on available statistics, see Chapter 2 “Node Reference” on page 8.
Statistic animation probes
The value of this attribute must reference a statistic specified in a statistic probe within the same probe list. If the referenced statistic probe uses the “ordinate label” attribute, the statistic should be referenced using that value instead of its original name.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints |
submodule
This attribute can be used to specify the name of a submodule that acts as the source of the collected statistic. “submodule” is used in conjunction with the “subnet”, “node”, and “module” attributes to uniquely specify the submodule. This attribute can be set to the value NONE or left empty for probes that apply to statistics directly associated with a module or that have been promoted to the node level.
Specification of this attribute for a statistic is appropriate only for modules that support submodules, such as queue modules, transmitter modules, and receiver modules.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | valid submodule name |
subnet
For statistic probes, this required attribute specifies the name of the subnet containing the node, module, submodule, or link that acts as the source of the statistic. For animation probes, this attribute specifies the name of a subnetwork that is or contains an object that acts as a source of animation requests. The subnet name is hierarchical and is composed by concatenating the individual names of all of its parent subnets, separated by periods and ending with its own name.
The probe applies to the subnet object itself if the “node” and “module” attributes are left empty. Otherwise, the probe applies to the specified node or module within the subnet. Two animation representations are supported for subnet objects:
- Animation of packet flows allows the transfer of packets over communication links to be visualized
- Animation of node movement dynamically shows the displacement of mobile and satellite nodes
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | valid subnet name |
tag
Enter a value for this attribute only if you use multiple probes on the same statistic. In that case, “tag” differentiates among the resulting statistics displayed in the analysis. When you choose View Results, the tag string you specified becomes an additional level of hierarchy in the tree-view list of statistics.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | user choice | |
| Units | ||
| Constraints |
threshold comparison
This attribute specifies the comparison performed to determine if a statistic is in violation of a rule defined in a service level agreement (SLA). See Chapter 3 “Project Editor” on page 89 for details on service level agreements.
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | string |
| Access | read/write | read |
| Default Value | disabled | |
| Units | ||
| Constraints | disabled, <, >, >=, <= |
threshold percent
This attribute specifies the percentage of values in a bucket which are expected to conform to the threshold criteria for the bucket to be considered in compliance with the threshold. Assume, for example, that your SLA requires FTP Download Response Time to be 0.5 seconds for less than 75 percent of the time. You would specify “threshold percent” to be 75. If 75 percent of the values you collect are 0.5 seconds or less, the bucket is in compliance. If only 70 percent of the values are 0.5 seconds or less, the bucket is not in compliance.
Values are grouped into buckets, and the number of values that violate the threshold value (ViolationCount) is calculated. From ViolationCount the percent of values in violation can be derived. This percentage is compared to the threshold percent.
Depending on the specified collection mode, statistic values are grouped into multiple buckets or one bucket.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write | read |
| Default Value | 90.0 | |
| Units | ||
| Constraints |
threshold value
This attribute specifies the value that determines if a statistic value is a threshold violation. This attribute works with “threshold comparison”. Assume, for example, that for FTP download response time, “threshold value” is 0.5 seconds and “threshold comparison” is “greater than”. In this case, statistic values greater than 0.5 seconds would be threshold violations.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write | read |
| Default Value | 0.0 | |
| Units | ||
| Constraints |
trace color
This attribute specifies the color to be used for the trace when the statistic is animated. The value of this attribute has the form RGBnnn, where each integer n represents a color intensity. The first digit represents red, the second represents green, and the third represents blue. Therefore, RGB000 corresponds to black, RGB333 corresponds to white, RGB300 corresponds to red, and so on.
| Editing | Simulation | |
|---|---|---|
| Data Type | color | color |
| Access | read/write | read |
| Default Value | RGB030 (green) | |
| Units | ||
| Constraints |
trace style
This attribute specifies the draw style for the statistic being animated.
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | enumerated |
| Access | read/write | read |
| Default Value | linear | |
| Units | ||
| Constraints | sample-hold, bar, discrete, linear, square-wave, bar chart |
vector data
This attribute is a toggle that either enables or prevents vector data collection for the affected statistic. If it is enabled, the attributes “vector start” and “vector stop” define the interval of time during which updates to the statistic of interest, are recorded. In general, at least one of the “vector data” or “scalar data” attributes are enabled.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle | toggle |
| Access | read/write | read |
| Default Value | enabled | |
| Units | ||
| Constraints |
vector start
If the “vector data” attribute has the value “enabled”, the “vector start” and “vector stop” attributes together specify a window of simulation time over which updates to the probed statistic are recorded in the resulting output vector.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write | read |
| Default Value | 0.0 | |
| Units | seconds | |
| Constraints | vector start < vector stop |
vector stop
If the “vector data” attribute has the value “enabled”, the “vector start” and “vector stop” attributes together specify a window of simulation time over which updates to the probed statistic are recorded in the resulting output vector.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write | read |
| Default Value | infinite | |
| Units | seconds | |
| Constraints | vector start < vector stop |
warning low value
This attribute specifies a value below which the statistic value is considered low. In conjunction with the “critical low value”, “warning high value”, and “critical high value” attributes, it defines critically low, low, normal, high, and critically high value ranges that will be indicated in statistic graphs by green, yellow, and red backgrounds.
| Editing | Simulation | |
|---|---|---|
| Data Type | booldouble | booldouble |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | numeric value, “disabled” |
warning high value
This attribute specifies a value above which the statistic value is considered high. In conjunction with the “critical low value”, “warning low value”, and “critical high value” attributes, it defines critically low, low, normal, high, and critically high value ranges that will be indicated in statistic graphs by green, yellow, and red backgrounds.
| Editing | Simulation | |
|---|---|---|
| Data Type | booldouble | booldouble |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints | numeric value, “disabled” |
window height
This attribute specifies the height (in pixels) of the probe’s associated animation viewer. It is used with the “window x”, “window y”, and “window width” attributes to fully define the region occupied by the animation viewer.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read/write | read |
| Default Value | 300 | |
| Units | pixels | |
| Constraints | >= 100 |
window name
This attribute specifies the name of the window in which the probe’s animation will appear; this enables you to distinguish between several animated threads. In addition, it can serve as the basis for a rendezvous mechanism whereby several animation probes with the same “window name” send the animation requests they generate to the same animation viewer.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write | read |
| Default Value | ||
| Units | ||
| Constraints |
window width
This attribute specifies the width (in pixels) of the probe’s associated animation viewer. It is used with the “window x”, “window y”, and “window height” attributes to define the outline of the animation viewer.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read/write | read |
| Default Value | 500 | |
| Units | pixels | |
| Constraints | >= 100 |
window x
This attribute specifies the x-coordinate (in pixels) of the upper-left corner of the probe’s associated animation viewer. It is used with the “window y”, “window width”, and “window height” attributes to define the region occupied by the animation viewer.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read/write | read |
| Default Value | 10 | |
| Units | pixels | |
| Constraints | >= 0 |
window y
This attribute specifies the y-coordinate (in pixels) of the upper-left corner of the probe’s associated animation viewer. It is used with the “window x”, “window width”, and “window height” attributes to define the region occupied by the animation viewer.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read/write | read |
| Default Value | 10 | |
| Units | pixels | |
| Constraints | >= 0 |
zone color
This attribute specifies the color of the plotting area (zone) in which the statistic is drawn. The value of this attribute has the form RGBnnn, where each integer n represents a color intensity. The first digit represents red, the second represents green, and the third represents blue. Therefore, RGB000 corresponds to black, RGB333 corresponds to white, RGB300 corresponds to red, and so on.
| Editing | Simulation | |
|---|---|---|
| Data Type | color | color |
| Access | read/write | read |
| Default Value | RGB111 | |
| Units | ||
| Constraints |
zone height
This attribute specifies the height (in pixels) of the zone in which the statistic graph is animated.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | |
| Access | read/write | read |
| Default Value | 274 | |
| Units | pixels | |
| Constraints |
zone number
This attribute specifies the zone in which the statistic graph is animated. All graphs with the same window name and zone number are shown in the same zone.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read/write | read |
| Default Value | 1 | |
| Units | ||
| Constraints |