The pld header contains information about the run including the date/time, the title, and the run number. More...

#include <hribf_buffers.h>

Inheritance diagram for PLD_header:

Collaboration diagram for PLD_header:

Public Member Functions
	PLD_header ()
	Default constructor. More...

	~PLD_header ()
	Destructor. More...

unsigned int	GetBufferLength ()
	Get the length of the header buffer. More...

char *	GetFacility ()
	Get the total length of the buffer (in bytes) More...

char *	GetFormat ()

char *	GetStartDate ()

char *	GetEndDate ()

char *	GetRunTitle ()

unsigned int	GetRunNumber ()

unsigned int	GetMaxSpillSize ()

float	GetRunTime ()

void	SetStartDateTime ()
	Set the date and tiem of when the file is opened. More...

void	SetEndDateTime ()
	Set the date and time of when the file is closed. More...

void	SetFacility (std::string input_)
	Set the facility of the output pld file (max length 16). More...

void	SetTitle (std::string input_)
	Set the title of the output pld file (unlimited length). More...

void	SetRunNumber (unsigned int input_)

void	SetMaxSpillSize (unsigned int max_spill_size_)

void	SetRunTime (float time_)

virtual bool	Write (std::ofstream *file_)
	Write a pld style header to a file. More...

virtual bool	Read (std::ifstream *file_)
	Read a HEAD buffer from a pld format file. Return false if buffer has the wrong header and return true otherwise. More...

virtual void	Reset ()
	Set initial values. More...

void	Print ()
	Print header information. More...

void	PrintDelimited (const char &delimiter_='\t')
	Print header information in a delimited list. More...

Public Member Functions inherited from BufferType
unsigned int	GetBufferType ()

unsigned int	GetBufferSize ()

unsigned int	GetBufferEndFlag ()

bool	DebugMode ()

void	SetDebugMode (bool debug_=true)

bool	ReadHeader (std::ifstream *file_)
	Return true if the first word of the current buffer is equal to this buffer type. More...

Private Attributes
unsigned int	run_num

unsigned int	max_spill_size

float	run_time

char	format [17]

char	facility [17]

char	start_date [25]

char	end_date [25]

char *	run_title

time_t	runStartTime

time_t	runStopTime

Additional Inherited Members
Protected Member Functions inherited from BufferType
	BufferType (unsigned int bufftype_, unsigned int buffsize_, unsigned int buffend_=0xFFFFFFFF)
	Generic BufferType constructor. More...

Protected Attributes inherited from BufferType
unsigned int	bufftype

unsigned int	buffsize

unsigned int	buffend

unsigned int	zero

bool	debug_mode

Detailed Description

The pld header contains information about the run including the date/time, the title, and the run number.

Definition at line 70 of file hribf_buffers.h.

Constructor & Destructor Documentation

§ PLD_header()

PLD_header::PLD_header ( )

Default constructor.

Definition at line 98 of file hribf_buffers.cpp.

Here is the call graph for this function:

§ ~PLD_header()

PLD_header::~PLD_header ( )

Destructor.

Definition at line 103 of file hribf_buffers.cpp.

Member Function Documentation

§ GetBufferLength()

unsigned int PLD_header::GetBufferLength ( )

Get the length of the header buffer.

Definition at line 107 of file hribf_buffers.cpp.

Here is the caller graph for this function:

§ GetEndDate()

char* PLD_header::GetEndDate ( )

inline

Definition at line 96 of file hribf_buffers.h.

Here is the caller graph for this function:

§ GetFacility()

char* PLD_header::GetFacility ( )

inline

Get the total length of the buffer (in bytes)

Definition at line 90 of file hribf_buffers.h.

Here is the caller graph for this function:

§ GetFormat()

char* PLD_header::GetFormat ( )

inline

Definition at line 92 of file hribf_buffers.h.

Here is the caller graph for this function:

§ GetMaxSpillSize()

unsigned int PLD_header::GetMaxSpillSize ( )

inline

Definition at line 102 of file hribf_buffers.h.

Here is the caller graph for this function:

§ GetRunNumber()

unsigned int PLD_header::GetRunNumber ( )

inline

Definition at line 100 of file hribf_buffers.h.

Here is the caller graph for this function:

§ GetRunTime()

float PLD_header::GetRunTime ( )

inline

Definition at line 104 of file hribf_buffers.h.

Here is the caller graph for this function:

§ GetRunTitle()

char* PLD_header::GetRunTitle ( )

inline

Definition at line 98 of file hribf_buffers.h.

Here is the caller graph for this function:

§ GetStartDate()

char* PLD_header::GetStartDate ( )

inline

Definition at line 94 of file hribf_buffers.h.

Here is the caller graph for this function:

§ Print()

void PLD_header::Print ( void )

Print header information.

Definition at line 232 of file hribf_buffers.cpp.

Here is the caller graph for this function:

§ PrintDelimited()

void PLD_header::PrintDelimited ( const char & delimiter_ = '\t' )

Print header information in a delimited list.

Definition at line 245 of file hribf_buffers.cpp.

Here is the caller graph for this function:

§ Read()

bool PLD_header::Read ( std::ifstream * file_ )

virtual

Read a HEAD buffer from a pld format file. Return false if buffer has the wrong header and return true otherwise.

Read a pld style header from a file.

Reimplemented from BufferType.

Definition at line 183 of file hribf_buffers.cpp.

Here is the caller graph for this function:

§ Reset()

void PLD_header::Reset ( void )

virtual

Set initial values.

Reimplemented from BufferType.

Definition at line 220 of file hribf_buffers.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

§ SetEndDateTime()

void PLD_header::SetEndDateTime ( )

Set the date and time of when the file is closed.

Definition at line 123 of file hribf_buffers.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

§ SetFacility()

void PLD_header::SetFacility ( std::string input_ )

Set the facility of the output pld file (max length 16).

Definition at line 134 of file hribf_buffers.cpp.

Here is the call graph for this function:

§ SetMaxSpillSize()

void PLD_header::SetMaxSpillSize ( unsigned int max_spill_size_ )

inline

Definition at line 116 of file hribf_buffers.h.

Here is the caller graph for this function:

§ SetRunNumber()

void PLD_header::SetRunNumber ( unsigned int input_ )

inline

Definition at line 114 of file hribf_buffers.h.

Here is the caller graph for this function:

§ SetRunTime()

void PLD_header::SetRunTime ( float time_ )

inline

Definition at line 118 of file hribf_buffers.h.

Here is the call graph for this function:

§ SetStartDateTime()

void PLD_header::SetStartDateTime ( )

Set the date and tiem of when the file is opened.

Definition at line 115 of file hribf_buffers.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

§ SetTitle()

void PLD_header::SetTitle ( std::string input_ )

Set the title of the output pld file (unlimited length).

Definition at line 139 of file hribf_buffers.cpp.

Here is the caller graph for this function:

§ Write()

bool PLD_header::Write ( std::ofstream * file_ )

virtual

Write a pld style header to a file.

HEAD buffer (1 word buffer type, 1 word run number, 1 word maximum spill size, 4 word format, 2 word facility, 6 word date, 1 word title length (x in bytes), x/4 word title, 1 word end of buffer

Reimplemented from BufferType.

Definition at line 149 of file hribf_buffers.cpp.

Here is the caller graph for this function:

Field Documentation

§ end_date

char PLD_header::end_date[25]

private

Definition at line 78 of file hribf_buffers.h.

§ facility

char PLD_header::facility[17]

private

Definition at line 76 of file hribf_buffers.h.

§ format

char PLD_header::format[17]

private

Definition at line 75 of file hribf_buffers.h.

§ max_spill_size

unsigned int PLD_header::max_spill_size

private

Definition at line 73 of file hribf_buffers.h.

§ run_num

unsigned int PLD_header::run_num

private

Definition at line 72 of file hribf_buffers.h.

§ run_time

float PLD_header::run_time

private

Definition at line 74 of file hribf_buffers.h.

§ run_title

char* PLD_header::run_title

private

Definition at line 79 of file hribf_buffers.h.

§ runStartTime

time_t PLD_header::runStartTime

private

Definition at line 81 of file hribf_buffers.h.

§ runStopTime

time_t PLD_header::runStopTime

private

Definition at line 82 of file hribf_buffers.h.

§ start_date

char PLD_header::start_date[25]

private

Definition at line 77 of file hribf_buffers.h.

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ PLD_header()

§ ~PLD_header()

Member Function Documentation

§ GetBufferLength()

§ GetEndDate()

§ GetFacility()

§ GetFormat()

§ GetMaxSpillSize()

§ GetRunNumber()

§ GetRunTime()

§ GetRunTitle()

§ GetStartDate()

§ Print()

§ PrintDelimited()

§ Read()

§ Reset()

§ SetEndDateTime()

§ SetFacility()

§ SetMaxSpillSize()

§ SetRunNumber()

§ SetRunTime()

§ SetStartDateTime()

§ SetTitle()

§ Write()

Field Documentation

§ end_date

§ facility

§ format

§ max_spill_size

§ run_num

§ run_time

§ run_title

§ runStartTime

§ runStopTime

§ start_date