Global Statistic Probe Object

Global statistics provide numerical information about a model, but are not necessarily related to one object in the system. Multiple objects in the system may share a global statistic by agreeing on its name. Values can then be independently written by the objects and the Simulation Kernel automatically merges their values into one statistic. Process models can declare global statistic names so that they are known to the Probe Editor, and global statistic probes can refer to them. For more information on global statistics, see Chapter 10 “Simulation Design” on page 375.

Global statistic probes are used to enable collection of global statistics. They can generate vector data, scalar data, or both.

The following table lists the built-in attributes of the global statistic probe object. For attribute definitions, see Probe Object Attribute Descriptions.

Table 43: Global Statistic Probe Object Built-In Attributes

Name Data Type
name string
draw style enumerated
group string
statistic string
ordinate label string
vector data toggle
vector start double
vector stop double
scalar data toggle
scalar type enumerated
scalar start double
scalar stop double
capture mode string
threshold comparison enumerated
threshold value double
threshold percent double
tag string
critical low value booldouble
warning low value booldouble
warning high value booldouble
critical high value booldouble