Class Index Cross Index Namespace Index

Class FrameCPP::Verify


Contained in: FrameCPP
Derived from: none
Derived by: none

#include "framecpp/Verify.hh"


public function member index:

Verify(); Default constructor
INT_8U BufferSize() const; Query the size of the I/O buffer
void BufferSize(INT_8U Bytes); Change the size of the I/O buffer
bool CheckDataValid() const; Query if the data valid field of the FrAdcData must be zero
void CheckDataValid(bool Check); Change requirement if the data valid field of the FrAdcData must be zero
bool CheckFileChecksum() const; Query if checksums will be calculated for a frame file
void CheckFileChecksum(bool Check); Change requirement for calculating the checksum of a frame file
bool CheckFrameChecksum() const; Query if checksums will be calculated for the frames of a frame file
void CheckFrameChecksum(bool Check); Change requirement for calculating the checksum of frames of a frame file
bool CheckMD5Sum() const; Query if md5sum will be calculated for the frame file
void CheckMD5Sum(bool Chekc); Change requirement for calculating the md5sum value for the frame file
std::string ErrorInfo() const; Retrieve additional infomation about an error.
bool MustHaveEOFChecksum() const; Query if the frame file must have the EOF checksum structure.
void MustHaveEOFChecksum(bool Confomance); Change requirement of the frame file having the EOF checksum structure
static std::string StrError(error_type ErrorNum); Return string describing error code
static std::string StrErrorType(const error_type Error); Retrieve the string representation of the error_type
bool Strict() const; Query strict conformance requirement
void Strict(bool Strictness); Change strict conformance requirement
bool UseMemoryMappedIO() const; Query if memory mapped I/O will be used
void UseMemoryMappedIO(bool UseMemoryMappedIO); Specify if to use memory mapped I/O.
bool ValidateMetadata() const; Query if metadata should be validated
void ValidateMetadata(bool ValidateMetadata); Specify if to validate metadata
error_type operator ()(const std::string& Filename); Verify a frame file
error_type operator ()(std::istream& Stream, std::auto_ptr< FrameFilename > FrameFilename = std::auto_ptr< FrameFilename >()); Verify a frame stream
 

private function member index:

void set_channel_site(char Site);
 

Description:



Function Member Descriptions:


FrameCPP::Verify::Verify - Default constructor


Verify();



FrameCPP::Verify::BufferSize - Query the size of the I/O buffer


INT_8U BufferSize() const;



FrameCPP::Verify::BufferSize - Change the size of the I/O buffer


void BufferSize(INT_8U Bytes);



FrameCPP::Verify::CheckDataValid - Query if the data valid field of the FrAdcData must be zero


bool CheckDataValid() const;



FrameCPP::Verify::CheckDataValid - Change requirement if the data valid field of the FrAdcData must be zero


void CheckDataValid(bool Check);



FrameCPP::Verify::CheckFileChecksum - Query if checksums will be calculated for a frame file


bool CheckFileChecksum() const;



FrameCPP::Verify::CheckFileChecksum - Change requirement for calculating the checksum of a frame file


void CheckFileChecksum(bool Check);



FrameCPP::Verify::CheckFrameChecksum - Query if checksums will be calculated for the frames of a frame file


bool CheckFrameChecksum() const;



FrameCPP::Verify::CheckFrameChecksum - Change requirement for calculating the checksum of frames of a frame file


void CheckFrameChecksum(bool Check);



FrameCPP::Verify::CheckMD5Sum - Query if md5sum will be calculated for the frame file


bool CheckMD5Sum() const;



FrameCPP::Verify::CheckMD5Sum - Change requirement for calculating the md5sum value for the frame file


void CheckMD5Sum(bool Chekc);



FrameCPP::Verify::ErrorInfo - Retrieve additional infomation about an error.


std::string ErrorInfo() const;



FrameCPP::Verify::MustHaveEOFChecksum - Query if the frame file must have the EOF checksum structure.


bool MustHaveEOFChecksum() const;



FrameCPP::Verify::MustHaveEOFChecksum - Change requirement of the frame file having the EOF checksum structure


void MustHaveEOFChecksum(bool Confomance);



FrameCPP::Verify::StrError - Return string describing error code


static std::string StrError(error_type ErrorNum);



FrameCPP::Verify::StrErrorType - Retrieve the string representation of the error_type


static std::string StrErrorType(const error_type Error);



FrameCPP::Verify::Strict - Query strict conformance requirement


bool Strict() const;



FrameCPP::Verify::Strict - Change strict conformance requirement


void Strict(bool Strictness);



FrameCPP::Verify::UseMemoryMappedIO - Query if memory mapped I/O will be used


bool UseMemoryMappedIO() const;



FrameCPP::Verify::UseMemoryMappedIO - Specify if to use memory mapped I/O.


void UseMemoryMappedIO(bool UseMemoryMappedIO);



FrameCPP::Verify::ValidateMetadata - Query if metadata should be validated


bool ValidateMetadata() const;



FrameCPP::Verify::ValidateMetadata - Specify if to validate metadata


void ValidateMetadata(bool ValidateMetadata);



FrameCPP::Verify::operator () - Verify a frame file


error_type operator ()(const std::string& Filename);



FrameCPP::Verify::operator () - Verify a frame stream


error_type operator ()(std::istream& Stream, std::auto_ptr< FrameFilename > FrameFilename = std::auto_ptr< FrameFilename >());



FrameCPP::Verify::set_channel_site


void set_channel_site(char Site);



Variable Member Descriptions:


FrameCPP::Verify::m_buffer_size -

INT_8U m_buffer_size;

FrameCPP::Verify::m_channel_validation -

detector_validation_type m_channel_validation;

FrameCPP::Verify::m_channel_validation_excess -

detector_validation_type m_channel_validation_excess;

FrameCPP::Verify::m_check_data_valid -

bool m_check_data_valid;

FrameCPP::Verify::m_check_file_checksum -

bool m_check_file_checksum;

FrameCPP::Verify::m_check_frame_checksum -

bool m_check_frame_checksum;

FrameCPP::Verify::m_check_md5sum -

bool m_check_md5sum;

FrameCPP::Verify::m_detector_validation -

detector_validation_type m_detector_validation;

FrameCPP::Verify::m_detector_validation_excess -

detector_validation_type m_detector_validation_excess;

FrameCPP::Verify::m_error_info -

std::ostringstream m_error_info;

FrameCPP::Verify::m_error_strings -

static const char* [] m_error_strings;

FrameCPP::Verify::m_error_type_strings -

static const char* [] m_error_type_strings;

FrameCPP::Verify::m_must_have_eof_checksum -

bool m_must_have_eof_checksum;

FrameCPP::Verify::m_strict -

bool m_strict;

FrameCPP::Verify::m_use_memory_mapped_io -

bool m_use_memory_mapped_io;

FrameCPP::Verify::m_validate_metadata -

bool m_validate_metadata;