TimeAverageRecorder Class Reference

API: TimeAverageRecorder Class Reference
API
TimeAverageRecorder Class Reference
Inheritance diagram for TimeAverageRecorder:
[legend]

Public Member Functions

virtual std::string str () const override
Public Member Functions inherited from cResultRecorder
virtual const char * getName () const override
virtual std::string getFullPath () const override
Public Member Functions inherited from cResultListener
virtual void receiveSignal (cComponent *source, simsignal_t signalID, bool b, cObject *details) override
virtual void receiveSignal (cComponent *source, simsignal_t signalID, intval_t l, cObject *details) override
virtual void receiveSignal (cComponent *source, simsignal_t signalID, uintval_t l, cObject *details) override
virtual void receiveSignal (cComponent *source, simsignal_t signalID, double d, cObject *details) override
virtual void receiveSignal (cComponent *source, simsignal_t signalID, const SimTime &v, cObject *details) override
virtual void receiveSignal (cComponent *source, simsignal_t signalID, const char *s, cObject *details) override
virtual void receiveSignal (cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) override
virtual void subscribedTo (cComponent *component, simsignal_t signalID) override
virtual void unsubscribedFrom (cComponent *component, simsignal_t signalID) override
virtual void finish (cComponent *component, simsignal_t signalID) override
virtual int getSubscribeCount () const override
Public Member Functions inherited from cObject
 cObject ()
 cObject (const cObject &other)=default
virtual ~cObject ()
virtual const char * getClassName () const
bool isName (const char *s) const
virtual const char * getFullName () const
virtual std::string getClassAndFullName () const
virtual std::string getClassAndFullPath () const
const cObjectgetThisPtr () const
virtual std::ostream & printOn (std::ostream &os) const
virtual cObjectdup () const
virtual void parsimPack (cCommBuffer *buffer) const
virtual void parsimUnpack (cCommBuffer *buffer)
virtual cObjectgetOwner () const
virtual bool isOwnedObject () const
virtual bool isSoftOwner () const
virtual void forEachChild (cVisitor *v)
cObjectfindObject (const char *name, bool deep=true)
virtual cClassDescriptorgetDescriptor () const
void copyNotSupported () const
Public Member Functions inherited from cIListener
 cIListener ()
 cIListener (const cIListener &other)
virtual ~cIListener ()

Additional Inherited Members

Protected Member Functions inherited from cObject
virtual void take (cOwnedObject *obj)
virtual void drop (cOwnedObject *obj)
void dropAndDelete (cOwnedObject *obj)
Protected Member Functions inherited from cIListener
virtual void unsubscribeAll ()

Description

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.

This recorder uses forward-sample-hold interpolation: when a value V is emitted at time T, it represents the level that remains constant from T onwards. Typical use cases include recording average queue length or buffer occupancy.

See also
RateAverageRecorder

Member Function Documentation

◆ str()

virtual std::string str ( ) const
overridevirtual

Returns a brief, one-line description of the object. The returned string does (should) NOT include the object's name and class. This method is used to display object information at several places in the Qtenv GUI, among others.

Reimplemented from cObject.