tRecordingBlockBase Class Reference

a block of data to record (for more advanced data storage ), base class More...

#include <tRecorder.h>

Inheritance diagram for tRecordingBlockBase:

[legend]

Collaboration diagram for tRecordingBlockBase:

[legend]

List of all members.

Public Member Functions
bool	Initialize (char const *section, tRecording *recording)
	initializes this for recording
bool	Initialize (char const *section)
	initializes this for recording
void	Separator ()
	separates two recorded elements (more than usual)
Static Public Member Functions
static tRecording *	GetArchive ()
	returns the active recording
Protected Member Functions
	tRecordingBlockBase ()
	default constructor
	~tRecordingBlockBase ()
	ends a recording block
std::ostream &	GetRecordingStream () const
	returns the stream to record to
Protected Attributes
bool	separate_
	flag indicating whether a separation is needed before the next data element
Private Attributes
tRecording *	recording_
	the recording to record to

---

Detailed Description

a block of data to record (for more advanced data storage ), base class

Definition at line 258 of file tRecorder.h.

---

Constructor & Destructor Documentation

tRecordingBlockBase::tRecordingBlockBase

(

void

)

[protected]

default constructor

Definition at line 330 of file tRecorder.cpp.

        : separate_( true ), recording_( NULL )
{
}

tRecordingBlockBase::~tRecordingBlockBase

(

void

)

[protected]

ends a recording block

Definition at line 344 of file tRecorder.cpp.

References GetRecordingStream(), and recording_.

{
    // make sure everything is logged, even if program crashes
    if (recording_)
        GetRecordingStream().flush();

    recording_ = 0;
}

Here is the call graph for this function:

---

Member Function Documentation

bool tRecordingBlockBase::Initialize	(	char const *	section,
		tRecording *	recording
	)

initializes this for recording

Parameters:

	section	name of the section to start
	recording	recording to read block from

Returns:

true on success

Definition at line 260 of file tRecorder.cpp.

References tRecording::BeginSection(), and recording_.

Referenced by Initialize().

{
    // initialize recording pointer
    recording_ = recording;
    if (!recording_)
        return false;

    // start section
    recording_->BeginSection( section );

    // return success
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool tRecordingBlockBase::Initialize

(

char const *

section

)

initializes this for recording

Parameters:

section

name of the section to start

Returns:

true on success

Definition at line 285 of file tRecorder.cpp.

References tRecording::currentRecording_, and Initialize().

{
    // delegate
    return Initialize( section, tRecording::currentRecording_ );
}

Here is the call graph for this function:

void tRecordingBlockBase::Separator

(

void

)

separates two recorded elements (more than usual)

Definition at line 300 of file tRecorder.cpp.

References GetRecordingStream(), and separate_.

{
    GetRecordingStream() << "\n";
    separate_ = false;
}

Here is the call graph for this function:

tRecording * tRecordingBlockBase::GetArchive

(

void

)

[static]

returns the active recording

Returns:

the currently running recording

Definition at line 316 of file tRecorder.cpp.

References tRecording::currentRecording_.

Referenced by tRecorderBase::IsRecording().

{
    return tRecording::currentRecording_;
}

Here is the caller graph for this function:

std::ostream & tRecordingBlockBase::GetRecordingStream

(

)

const [protected]

returns the stream to record to

Returns:

the stream of the recording

Definition at line 363 of file tRecorder.cpp.

References tRecording::DoGetStream(), recording_, and tASSERT.

Referenced by Separator(), tRecordingBlock::Write(), and ~tRecordingBlockBase().

{
    tASSERT( recording_ );

    return recording_->DoGetStream();
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Data Documentation

bool tRecordingBlockBase::separate_ [protected]

flag indicating whether a separation is needed before the next data element

Definition at line 272 of file tRecorder.h.

Referenced by Separator(), and tRecordingBlock::Write().

tRecording* tRecordingBlockBase::recording_ [private]

the recording to record to

Definition at line 274 of file tRecorder.h.

Referenced by GetRecordingStream(), Initialize(), and ~tRecordingBlockBase().

---

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

• src/tools/tRecorder.h
• src/tools/tRecorder.cpp

---