MAKLogger::DtCheckpointPolicy Class Reference

Checkpoint policy class responsible. More...

Inheritance diagram for MAKLogger::DtCheckpointPolicy:

Collaboration diagram for MAKLogger::DtCheckpointPolicy:

Public Types
enum	Policy { ByCount, BySize, ByTime }

Public Member Functions
virtual	~DtCheckpointPolicy ()
	DTOR. More...
virtual bool	timeForCheckpoint () const =0
	Function called to check to see if it is time to create a checkpoint, called after every packet is written. More...
virtual void	reset ()=0
	Function called if the checkpoint mechanism should be reset. More...
virtual void	checkpointWritten ()=0
	Function called after a checkpoint has been written. More...
virtual void	packetWritten (const DtPacket &)=0
	Function called after every packet written. More...
virtual void	connectFileOutput (DtMessageState *, DtLgrFileOutput *)
	Set the file output object. Called if the FileOuput changes. More...
virtual bool	interactionsCheckpointed () const
	Indicates if interactions should be checkpointed. More...
virtual void	setInteractionsCheckpointed (bool enable)
	Indicate if interactions should be checkpointed. More...

Protected Types
typedef DtObserverFunctor < DtCheckpointPolicy, DtPacket >	PacketObserverFunctor
	Type of the functor connecting the checkpoint policy to the output. More...

Protected Member Functions
void	onPacketWritten (const DtPacket &)

Protected Attributes
PacketObserverFunctor	myPacketWrittenObserver
DtMessageState *	myMessageState
DtLgrFileOutput *	myLgrFileOutput
bool	myCheckpointInteractions

Private Member Functions
	DtCheckpointPolicy (const DtCheckpointPolicy &)
	Not Implemented. More...
DtCheckpointPolicy &	operator= (const DtCheckpointPolicy &)
	Not Implemented. More...

Detailed Description

Checkpoint policy class responsible.

Member Typedef Documentation

typedef DtObserverFunctor<DtCheckpointPolicy,DtPacket> MAKLogger::DtCheckpointPolicy::PacketObserverFunctor

protected

Type of the functor connecting the checkpoint policy to the output.

Member Enumeration Documentation

enum MAKLogger::DtCheckpointPolicy::Policy

Enumerator
ByCount
BySize
ByTime

Constructor & Destructor Documentation

virtual MAKLogger::DtCheckpointPolicy::~DtCheckpointPolicy ( )

virtual

DTOR.

MAKLogger::DtCheckpointPolicy::DtCheckpointPolicy ( const DtCheckpointPolicy &  )

private

Not Implemented.

Member Function Documentation

virtual void MAKLogger::DtCheckpointPolicy::checkpointWritten ( )

pure virtual

Function called after a checkpoint has been written.

Implemented in MAKLogger::DtCheckpointByTime, MAKLogger::DtCheckpointByCount, and MAKLogger::DtCheckpointBySize.

virtual void MAKLogger::DtCheckpointPolicy::connectFileOutput ( DtMessageState *  , DtLgrFileOutput *    )

virtual

Set the file output object. Called if the FileOuput changes.

virtual bool MAKLogger::DtCheckpointPolicy::interactionsCheckpointed ( ) const

virtual

Indicates if interactions should be checkpointed.

void MAKLogger::DtCheckpointPolicy::onPacketWritten ( const DtPacket &  )

protected

DtCheckpointPolicy& MAKLogger::DtCheckpointPolicy::operator= ( const DtCheckpointPolicy &  )

private

Not Implemented.

virtual void MAKLogger::DtCheckpointPolicy::packetWritten ( const DtPacket &  )

pure virtual

Function called after every packet written.

This should be a fast function.

Implemented in MAKLogger::DtCheckpointByTime, MAKLogger::DtCheckpointByCount, and MAKLogger::DtCheckpointBySize.

virtual void MAKLogger::DtCheckpointPolicy::reset ( )

pure virtual

Function called if the checkpoint mechanism should be reset.

Implemented in MAKLogger::DtCheckpointByTime, MAKLogger::DtCheckpointByCount, and MAKLogger::DtCheckpointBySize.

virtual void MAKLogger::DtCheckpointPolicy::setInteractionsCheckpointed ( bool  enable )

virtual

Indicate if interactions should be checkpointed.

virtual bool MAKLogger::DtCheckpointPolicy::timeForCheckpoint ( ) const

pure virtual

Function called to check to see if it is time to create a checkpoint, called after every packet is written.

Return values

true	Time for checkpoint.
false	Not time for checkpoint.

Implemented in MAKLogger::DtCheckpointByTime, MAKLogger::DtCheckpointByCount, and MAKLogger::DtCheckpointBySize.

Member Data Documentation

bool MAKLogger::DtCheckpointPolicy::myCheckpointInteractions

protected

DtLgrFileOutput* MAKLogger::DtCheckpointPolicy::myLgrFileOutput

protected

DtMessageState* MAKLogger::DtCheckpointPolicy::myMessageState

protected

PacketObserverFunctor MAKLogger::DtCheckpointPolicy::myPacketWrittenObserver

protected

---

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

• lgrCheckpointPolicy.h