RubberBand::RubberBandStretcher::Logger Struct Reference

Interface for log callbacks that may optionally be provided to the stretcher on construction. More...

#include <RubberBandStretcher.h>

Public Member Functions
virtual void	log (const char *)=0
	Receive a log message with no numeric values.
virtual void	log (const char *, double)=0
	Receive a log message and one accompanying numeric value.
virtual void	log (const char *, double, double)=0
	Receive a log message and two accompanying numeric values.
virtual	~Logger ()

Detailed Description

Interface for log callbacks that may optionally be provided to the stretcher on construction.

If a Logger is provided, the stretcher will call one of these functions instead of sending output to cerr when there is something to report. This allows debug output to be diverted to an application's logging facilities, and/or handled in an RT-safe way. See setDebugLevel() for details about how and when RubberBandStretcher reports something in this way.

The message text passed to each of these log functions is a C-style string with no particular guaranteed lifespan. If you need to retain it, copy it before returning. Do not free it.

See also

setDebugLevel

setDefaultDebugLevel

Definition at line 467 of file RubberBandStretcher.h.

Constructor & Destructor Documentation

~Logger()

virtual RubberBand::RubberBandStretcher::Logger::~Logger ( )

inlinevirtual

Definition at line 477 of file RubberBandStretcher.h.

Member Function Documentation

log() [1/3]

virtual void RubberBand::RubberBandStretcher::Logger::log ( const char * )

pure virtual

Receive a log message with no numeric values.

log() [2/3]

virtual void RubberBand::RubberBandStretcher::Logger::log ( const char * , double  )

pure virtual

Receive a log message and one accompanying numeric value.

log() [3/3]

virtual void RubberBand::RubberBandStretcher::Logger::log ( const char * , double , double  )

pure virtual

Receive a log message and two accompanying numeric values.

---

The documentation for this struct was generated from the following file:

• RubberBandStretcher.h