Result Filters and Recorders¶
|
API
|
Result Filters and Recorders
Classes | |
| class | cResultFilter |
| Base class for result filters. More... | |
| class | cNumericResultFilter |
| Base class for filters that expect to receive an numeric value. More... | |
| class | cObjectResultFilter |
| Base class for filters that expect to receive an object. More... | |
| class | cResultListener |
| Common abstract base class for result filters and result recorders. More... | |
| class | cResultRecorder |
| Abstract base class for result recorders. More... | |
| class | cNumericResultRecorder |
| Abstract base class for numeric result recorders. More... | |
| class | WarmupPeriodFilter |
| Result filter that absorbs input values during the configured warm-up period (see warmup-period configuration option), and lets everything through once the warm-up period is over. More... | |
| class | DemuxFilter |
| Result filter that demultiplexes its input to several outputs. The selector (a.ka. demux label) is the name string of the details object emitted with the value, details->getFullName(). Results recorded on the various outputs are tagged with the demux label (i.e. the demux label appears as part of their names). More... | |
| class | TotalCountFilter |
| Result filter for counting the input values, including NaN and nullptr values. More... | |
| class | CountFilter |
| Result filter for counting signals. Signal values do not need to be numeric to be counted. NaN and nullptr values are ignored. More... | |
| class | ConstantFilter |
| Result filter that replaces every value with a constant. Signal values do not need to be numeric. More... | |
| class | Constant0Filter |
| Result filter that replaces every value with zero. More... | |
| class | Constant1Filter |
| Result filter that replaces every value with 1.0. More... | |
| class | TimeFilter |
| Result filter that yields the time of emitting the signal. More... | |
| class | IdentityFilter |
| This class is a no-op filter. More... | |
| class | MergeFilter |
| Filter that merges several inputs into one output. More... | |
| class | SkipNanFilter |
| Filter that removes (filters out) NaNs, and lets through all other values. More... | |
| class | ErrorNanFilter |
| Filter that raises a runtime error if it sees a NaN in the input. More... | |
| class | CountNanFilter |
| Filter that counts NaN values in the input. More... | |
| class | SumFilter |
| Filter that outputs the sum of signal values. NaN values in the input are ignored. More... | |
| class | MeanFilter |
| Result filter that computes the (time-weighted or unweighted) mean of signal values. NaN values in the input are ignored, or in the time-weighted case, they denote intervals to be ignored. More... | |
| class | MinFilter |
| Result filter that computes the minimum of signal values. NaN values in the input are ignored. More... | |
| class | MaxFilter |
| Result filter that computes the maximum of signal values. NaN values in the input are ignored. More... | |
| class | AverageFilter |
| Result filter that computes the arithmetic mean of signal values. NaN values in the input are ignored. More... | |
| class | TimeAverageFilter |
| Result filter that computes the time-weighted average of signal values, where each emitted value represents the level that will be maintained until the next emission. NaN values in the input denote intervals to be ignored. More... | |
| class | RateAverageFilter |
| Result filter that computes the time-weighted average of signal values, where each value represents the rate/throughput that was active during the interval preceding its emission time. NaN values in the input denote intervals to be ignored. More... | |
| class | RemoveRepeatsFilter |
| Result filter that removes repeated values. More... | |
| class | PacketBytesFilter |
| Filter that expects a cPacket and outputs its length in bytes (getByteLength()). Null (nullptr) values are ignored; non-cPacket objects are an error. More... | |
| class | PacketBitsFilter |
| Filter that expects a cPacket and outputs its length in bits (getBitLength()). Null (nullptr) values are ignored; non-cPacket objects are an error. More... | |
| class | SumPerDurationFilter |
| Filter that outputs the sum of signal values divided by the measurement interval (simtime minus warmupPeriod). NaN values in the input are ignored. More... | |
| class | VectorRecorder |
| Listener for recording a signal to an output vector. More... | |
| class | TotalCountRecorder |
| Listener for recording the count of signal values, including NaN and nullptr. More... | |
| class | CountRecorder |
| Listener for recording the count of signal values. Signal values do not need to be numeric to be counted. NaN and nullptr values are ignored. More... | |
| class | LastValueRecorder |
| Listener for recording the last non-NaN signal value. More... | |
| class | ErrorNanRecorder |
| Recorder that raises a runtime error if it sees a NaN in the input (and never records anything). More... | |
| class | SumRecorder |
| Listener for recording the sum of signal values. NaN values in the input are ignored. More... | |
| class | MeanRecorder |
| Listener for recording the (time-weighted or unweighted) mean of signal values. NaN values in the input are ignored, or in the time-weighted case, they denote intervals to be ignored. More... | |
| class | MinRecorder |
| Listener for recording the minimum of signal values. NaN values in the input are ignored. More... | |
| class | MaxRecorder |
| Listener for recording the maximum of signal values. NaN values in the input are ignored. More... | |
| class | AverageRecorder |
| Listener for recording the arithmetic mean of signal values. NaN values in the input are ignored. More... | |
| class | TimeAverageRecorder |
| Listener for recording the time-weighted average of signal values, where each emitted value represents the level that will be maintained until the next emission. NaN values in the input denote intervals to be ignored. More... | |
| class | RateAverageRecorder |
| Listener for recording the time-weighted average of signal values, where each value represents the rate/throughput that was active during the interval preceding its emission time. NaN values in the input denote intervals to be ignored. More... | |
| class | StatisticsRecorder |
| Listener for recording signal values via a cStatistic. NaN values in the input are ignored, or in the time-weighted case, they denote intervals to be ignored. More... | |
Description
Classes for declarative result collection.
Result filters and recorders are objects that participate in declarative statistics recording via \@statistic properties in NED files.
Central classes:
- cResultFilter is the base class for result filters
- cResultRecorder is the base class for result recorders
New result filter/recorder classes need to be registered with the Register_ResultFilter() / Register_ResultFilter2() and Register_ResultRecorder() / Register_ResultRecorder2() macros to be accessible from \@statistic .
Generated on for API by
1.14.0