Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members  

cTransientDetection Class Reference

#include <cdetect.h>

Inheritance diagram for cTransientDetection::

cObject cTDExpandingWindows List of all members.

Public Methods

Constructors, destructor, assignment.
 cTransientDetection (const cTransientDetection &r)
 cTransientDetection (const char *name=NULL)
virtual ~cTransientDetection ()
cTransientDetection& operator= (const cTransientDetection &)
Redefined cObject member functions.
virtual int netPack ()
virtual int netUnpack ()
Pure virtual functions to define the interface.
virtual void collect (double val)=0
virtual bool detected () const=0
virtual void reset ()=0
virtual void stop ()=0
virtual void start ()=0
Host object.
virtual void setHostObject (cStatistic *ptr)
virtual cStatistichostObject () const

Detailed Description

Virtual base class for transient detection classes.


Constructor & Destructor Documentation

cTransientDetection::cTransientDetection ( const cTransientDetection & r ) [inline]
 

Copy constructor.

cTransientDetection::cTransientDetection ( const char * name = NULL ) [inline, explicit]
 

Constructor.

cTransientDetection::~cTransientDetection ( ) [inline, virtual]
 

Destructor.


Member Function Documentation

void cTransientDetection::collect ( double val ) [pure virtual]
 

Should be redefined to update the detection algorithm with a value.

Reimplemented in cTDExpandingWindows.

bool cTransientDetection::detected ( ) const [pure virtual]
 

Should be redefined to return true if end of transient has been detected.

Reimplemented in cTDExpandingWindows.

cStatistic * cTransientDetection::hostObject ( ) const [inline, virtual]
 

Returns a pointer to the host object.

int cTransientDetection::netPack ( ) [virtual]
 

Serializes the object into a PVM or MPI send buffer. Used by the simulation kernel for parallel execution. See cObject for more details.

Reimplemented from cObject.

int cTransientDetection::netUnpack ( ) [virtual]
 

Deserializes the object from a PVM or MPI receive buffer Used by the simulation kernel for parallel execution. See cObject for more details.

Reimplemented from cObject.

cTransientDetection & cTransientDetection::operator= ( const cTransientDetection & ) [inline]
 

Assignment is not supported by this class: this method throws a cException when called.

void cTransientDetection::reset ( ) [pure virtual]
 

Should be redefined to reset detection algorithm.

Reimplemented in cTDExpandingWindows.

void cTransientDetection::setHostObject ( cStatistic * ptr ) [inline, virtual]
 

Sets the host object. This is internally called by cStatistic's addTransientDetection() method.

void cTransientDetection::start ( ) [pure virtual]
 

Should be redefined to start detection (further calls to collect() should update the detection algorithm.)

Reimplemented in cTDExpandingWindows.

void cTransientDetection::stop ( ) [pure virtual]
 

Should be redefined to stop detection (further calls to collect() should be ignored.)

Reimplemented in cTDExpandingWindows.


The documentation for this class was generated from the following file:
Generated at Mon Jun 16 23:37:33 2003 for OMNeT++ by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001