Probe Reference

Most models that contain more than a few objects can generate large amounts of output data during simulations. The sources of output data include predefined and user-defined statistics, automatic animation, and custom-programmed animation. Generally, only a fraction of the output data is of interest during a simulation run and decisions about which data to collect are application-specific. To enable users to specify the data they want to collect, Riverbed Modeler uses a special object called a probe. A probe is defined for each source of data that the user wants to enable; sources to which no probes are applied are effectively silent. Probes are grouped into a probe list so they can be applied collectively to a model when a simulation is executed.

Several types of probes are provided so you can capture different types of output data. This section describes the attributes of each type of probe. For more information about using probes, see Chapter 10 "Simulation Design" on page 375.

Table 38: Supported Probe Types

Probe Type Function
Node Statistic Probe Object Collects values concerning the activities of a module or submodule within a node. Can produce vector (time-series) or scalar (individual values) statistics.
Link Statistic Probe Object Collects values concerning the activities of a point-to-point or bus link. Can produce vector or scalar statistics.
Path Statistic Probe Object Collects values concerning the activities of a path. Can produce vector or scalar statistics.
Demand Statistic Probe Object Collects values concerning the activities of a demand. Can produce vector or scalar statistics.
Global Statistic Probe Object Collects values that are related to multiple objects in the system. All objects can contribute to the statistic in a distributed manner. Supports both vector and scalar statistics.
Attribute Probe Object Generates scalar statistics for attributes of the simulation model, which may be declared simulation attributes, or promoted object attributes.
Automatic Animation Probe Object Enables standard forms of animation for the activities occurring within a specific object. Supported animation forms include packet flows, node movement, and state transitions.
Statistic Animation Probe Object Enables standard animation of vector statistics, which are dynamically graphed as the simulation progresses.
Custom Animation Probe Object Enables animation programmed by the user. The simulation Kernel provides a general set of animation primitives to allow model developers to create application-specific animations.
Live Statistic Probe Object Collects values for a statistic to be displayed in real time as a simulation runs.