Probes

The Wireless functionality adds a new probe type. The Coupled Node Statistic Probe is similar to a Node Statistic Probe, but constrains the collected data to relate only to the interaction between two modules, which can be in separate nodes. Thus, it is useful for capturing statistics between mobile nodes.

Coupled Node Statistic Probe Object

The Coupled Node Statistic Probe object is typically used to specify the selective collection of a radio receiver statistic with respect to the transmissions of a particular radio transmitter. You must assign the subnet, node, and module attributes of a coupled probe to uniquely specify the module in the network where statistic collection is enabled. Because coupled probes currently apply only to radio receivers, the submodule attribute corresponds to a radio receiver channel, and must be assigned a value (radio receivers have no statistics other than those of their channels). Also, the coupled subnet, coupled node, and coupled module attributes serve to specify the particular module whose interaction with the probed module is of interest.

Like ordinary statistic probes, coupled node statistic probes can be used to collect vector or scalar data, or both. For more information on scalar and vector statistics, see “Data Analysis” on page 422 of Modeling Concepts manual. The graphical representation of a coupled node statistic probe appears below.

Figure 65: Coupled Node Statistic Probe Representation

Coupled Node Statistic Probe Representation

Coupled Node Statistic Probe Object Attributes

The built-in attributes of the coupled node statistic probe object are listed below, in alphabetical order.

Table 31: Coupled Node Statistic Probe Object Built-In Attributes

Name Data Type
capture mode string
coupled module string
coupled node string
coupled subnet string
draw style enumerated
group string
module string
name string
node string
ordinate label string
scalar data toggle
scalar start double
scalar stop double
scalar type enumerated
src objid integer
statistic string
submodule string
subnet string
vector data toggle
vector start double
vector stop double

capture mode

This attribute specifies how to process the collected values prior to writing the values to the simulation’s 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.

Editing Simulation
Data Type string string
Access read / write read
Default Value normal
Units
Constraints normal, sample, bucket, glitch removal

coupled module

The coupled subnet, coupled node, and coupled module attributes serve to specify the particular module whose interaction with the probed module is of interest. Currently, because coupled probes apply only to radio receiver channel objects, the coupled module must be a radio transmitter module. A coupled probe on certain radio receiver channel statistics is effective only with respect to transmissions from the selected transmitter module.

Editing Simulation
Data Type string string
Access read / write read
Default Value
Units
Constraints valid module name

coupled node

The coupled subnet, coupled node, and coupled module attributes serve to specify the particular module whose interaction with the probed module is of interest. Currently, because coupled probes apply only to radio receiver channel objects, the coupled module must be a radio transmitter module. A coupled probe on certain radio receiver channel statistics is effective only with respect to transmissions from the selected transmitter module.

Editing Simulation
Data Type string string
Access read / write read
Default Value
Units
Constraints valid node name

coupled subnet

The coupled subnet, coupled node, and coupled module attributes serve to specify the particular module whose interaction with the probed module is of interest. Currently, because coupled probes apply only to radio receiver channel objects, the coupled module must be a radio transmitter module. A coupled probe on certain radio receiver channel statistics is effective only with respect to transmissions from the selected transmitter module.

Editing Simulation
Data Type string string
Access read / write read
Default Value
Units
Constraints valid subnet name

draw style

This attribute specifies how the statistic will be 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.

After you display the statistic in a graph, by specifying the style in the Graph pop-up menu.

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 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

module

This attribute specifies the name of the module that acts as the source of the collected statistic. module is used in conjunction with the subnet and node attributes to uniquely specify the module within the network model. In addition, the submodule attribute can be used to specify a submodule within the module as the source of the statistic. Because coupled probes currently apply only to radio receivers, the submodule attribute corresponds to a radio receiver channel, and must be assigned a value (radio receivers have no statistics other than those of their channels).

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 coupled node statistic probe. It is used for organizational purposes only, and does not have any effect on the operation of the probe. It allows the user to label the probe so that it is easier to identify its function. The default value for name is pbn, 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 pbn, n >= 1
Units
Constraints

node

This attribute specifies the name of the parent node of the module that acts as the source of the collected statistic. node is used in conjunction with the subnet and module attributes to uniquely specify the module.

Editing Simulation
Data Type string string
Access read / write read
Default Value
Units
Constraints valid node name

ordinate label

This attribute, if not empty, specifies a name to be 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.

Editing Simulation
Data Type string string
Access read / write read
Default Value
Units
Constraints

scalar data

This attribute is a boolean that either enables or prevents scalar data collection for the affected statistic. If this attribute is set to “enabled”, the scalar type, scalar start, and scalar stop attributes define the nature of the scalar data that is recorded. Probed scalar data is recorded at the end of a simulation based on properties of the statistic 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 Modeling Concepts manual.

Editing Simulation
Data Type boolean boolean
Access read / write read
Default Value disabled
Units
Constraints

scalar start

If the scalar data attribute has the value “enabled”, scalar start and scalar stop together specify a window of simulation time over which the scalar statistic is computed. 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”, scalar start and scalar stop together specify a window of simulation time over which the scalar statistic is computed. 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

This attribute can represent one of the following metrics: “last value”, “sample mean”, “time average”, “variance”, “min value”, or “max value”. If the scalar data attribute has the value “enabled”, scalar type is used to calculate one of these metrics applied to the statistic of interest. For a complete description of each of these metrics, see Chapter 10 “Simulation Design” on page 375 of Modeling Concepts manual.

Editing Simulation
Data Type enumerated integer
Access read / write read
Default Value
Units
Constraints

src objid

This attribute uniquely identifies the probed simulation object, referenced via its object ID. The value of src objid is assigned by the system and is determined by other attributes of the probe: subnet, node, module, and submodule.

This attribute exists only during simulation and is useful for verifying that probes are correctly configured.

Editing Simulation
Data Type N/A integer
Access N/A read
Default Value
Units
Constraints

statistic

This attribute represents the name of the statistic to be collected. 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 statistics whose values are driven by user-defined process models. Currently, because coupled probes apply only to radio receiver channel objects, only certain radio receiver statistics are supported for this attribute (as listed in “Wireless Statistic Probes” on page 35).

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. The submodule attribute is used in conjunction with the subnet, node, and module attributes to uniquely specify the submodule. Because coupled probes currently apply only to radio receivers, the submodule attribute corresponds to a radio receiver channel, and must be assigned a value (radio receivers have no statistics other than those of their channels).

Editing Simulation
Data Type string integer
Access read / write read
Default Value
Units
Constraints valid submodule name

subnet

This attribute specifies the name of the subnet that contains the module that acts as the source of the coupled statistic. subnet is used in conjunction with the node and module attributes to uniquely specify the module. 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.

Editing Simulation
Data Type string string
Access read / write read
Default Value
Units
Constraints valid subnet name

vector data

This attribute is a toggle that either enables or prevents vector data collection for the affected statistic. If it is “enabled”, the vector start and vector stop attributes 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 is “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

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com