package require EVB::inputStatistics
EVB::inputStatistics::statusDisplay window ?options?
$window configure options
$window cget ?option-name?
$window addDataSource id ?args?
$window removeDataSource id
$window updateDataSource id args
$window getDataSource id
$window listSources
Provides a megawidget that displays queue input statistics. The widget is made up of a summary region and a region that is a dynamic number of source queue widgets (see ::EVB::inputStatistics::queueDisplay for more information).
The summary display is managed via configuration options (see OPTIONS below), while methods are provided to manage the contents of the detailed per queue statistics displays (see METHODS below).
-fragmentsSets the number of fragments that are in all queues. This is intended to be the total number of fragments awaiting output. It appears in the summary part of the widget.
-oldestSets the timestamp of the oldest fragment in all queues. This appears in the summary display part of the widget.
-newestSets the timestamp of the newest fragment in all queues. This appears in the summary display part of the widget.
-deepestidSets the source id of the input queue that currently has the most fragments in it. This appears in the summary display part of the widget.
-deepestdepthSets the number of fragments in the the queue that has the most fragments. This appears in the summary display part of the widget.
-columns
The per queue statistic displays are organized into a table.
This option defines the number of columns in that table.
The number of rows is determined by the number of source
queues that are displayed. The default for
-columns is 1.
This option is dynamic. When changed, the table layout of
the table immediately changes.
EVB::inputStatistics::statusDisplay window ?options?
Creates a new status display. The window
parameter is a Tk window path and represents a frame that
encloses the megawidget. It also represents the
object when invoking the methods described in this section.
The remainder of the parameters are configuration options and their values. See the OPTIONS section above for a description of the allowed options.
$window configure options
Changes the valueo of one or more configuration options
described by the list of options.
The legal options are described above in the
OPTIONS section of this manpage.
$window cget ?option-name?
If an option-name is provided,
the value of that option is returned. If no option
name is provided the value of all options are returned.
See OPTIONS above for the set of options supported by this widget.
$window addDataSource id ?args?
Adds a new data source queue widget to the per queue
statistics table. The id parameter
is the input source id this queue statistics display
will represent.
If args is supplied,
it should be additonal option/value pairs for an
EVB::inputstatsitics::queueDisplay
widget. For information about the options that are
supported, see the OPTIONS section of
::EVB::inputStatistics::queueDisplay.
$window removeDataSource id
Removes the data source id from
the data source statistics display.
$window updateDataSource id args
Updates the contents of one of the source queue
statistics. id is the
queue identifier for the statistics widget to update.
args are option/value pairs
for the EVB::inputstatsitics::queueDisplay
widget. For information about the options that are
supported, see the OPTIONS section of
::EVB::inputStatistics::queueDisplay.
$window getDataSource id
Returns the widget that corresponds to the
source queue statistics widget id.
For more information about what can be done with this
widget see
::EVB::inputStatistics::queueDisplay
For information about the options that are
supported, see the OPTIONS section of
::EVB::inputStatistics::queueDisplay.
Note that you should not destroy this widget manually but shouild use the removeDataSource method of this widget instead. If you do not heed this advice errors will almost certainly result.
$window listSources
Returns a list of the data source ids that correspond to queue widgets that exist. Each one of these can be used in a call to e.g. gtDataSource without an error.