Class Index Cross Index Namespace Index

Class FrameCPP::Version_6::OFrameStream

Class to handle frame I/O.
Contained in: FrameCPP::Version_6
Derived from: Common::OFrameStream FrameCPP::Version_6::FrameStreamBase
Derived by: none

#include "../../../../../lib/framecpp/src/Version6/OFrameStream.hh"


public function member index:

OFrameStream(std::ostream& Stream, const std::vector< io_calls_type >& LibraryDefs, INT_4U NumberOfClassTypes, CheckSum::kind_type CheckSumMethod = CheckSum::CRC , const std::string& Originator = DEFAULT_ORIGINATOR); Constructor
OFrameStream(std::ostream& Stream, CheckSum::kind_type CheckSumMethod = CheckSum::CRC, const std::string& Originator = DEFAULT_ORIGINATOR);
~OFrameStream(); Destructor
void AppendObject(FrBase& Object); Append an object to the current stream
void WriteDictionary(FrBase& Base);
void WriteDictionary(const FrBase& Base);
void WriteFrBasePtr(const FrBase* Object);
void WriteFrStatData(FrStatData& StatData);
void WriteFrame(FrameH& Frame, CheckSum::kind_type CheckSumMethod = CheckSum::NONE);
void WriteFrame(FrameH& Frame, FrVect::compression_scheme_type Method, int Level, CheckSum::kind_type CheckSumMethod = CheckSum::NONE);
void WriteObject(FrBase& Base, bool Compress = false, FrVect::compression_scheme_type Method = FrVect::RAW, int Level = 0);
void close();
OFrameStream& operator <<(const T* Data); Write data to the stream
OFrameStream& operator <<(const std::vector< T >& Data); Write a vector of data to the stream
OFrameStream& operator <<(const T& Data); Write data to the stream
OFrameStream& operator <<(Container< T >& Data); Write container to the stream
OFrameStream& operator <<(const Container< T >& Data); Write container to the stream
void write(FrBase& Object);
void write(const void*Buffer, INT_8U Length);
 

private function member index:

OFrameStream(const OFrameStream&);
void init(INT_4U NumberOfClassTypes, CheckSum::kind_type CheckSumMethod, const std::string& Originator);
const OFrameStream& operator =(const OFrameStream&);
 

Description:



Function Member Descriptions:


FrameCPP::Version_6::OFrameStream::OFrameStream - Constructor


OFrameStream(std::ostream& Stream, const std::vector< io_calls_type >& LibraryDefs, INT_4U NumberOfClassTypes, CheckSum::kind_type CheckSumMethod = CheckSum::CRC , const std::string& Originator = DEFAULT_ORIGINATOR);

Parameters:
ParameterDescription
std::iostream& StreamInput or Output stream



FrameCPP::Version_6::OFrameStream::OFrameStream


OFrameStream(std::ostream& Stream, CheckSum::kind_type CheckSumMethod = CheckSum::CRC, const std::string& Originator = DEFAULT_ORIGINATOR);



FrameCPP::Version_6::OFrameStream::OFrameStream


OFrameStream(const OFrameStream&);



FrameCPP::Version_6::OFrameStream::~OFrameStream - Destructor


~OFrameStream();



FrameCPP::Version_6::OFrameStream::AppendObject - Append an object to the current stream


void AppendObject(FrBase& Object);



FrameCPP::Version_6::OFrameStream::WriteDictionary


void WriteDictionary(FrBase& Base);



FrameCPP::Version_6::OFrameStream::WriteDictionary


void WriteDictionary(const FrBase& Base);



FrameCPP::Version_6::OFrameStream::WriteFrBasePtr


void WriteFrBasePtr(const FrBase* Object);



FrameCPP::Version_6::OFrameStream::WriteFrStatData


void WriteFrStatData(FrStatData& StatData);



FrameCPP::Version_6::OFrameStream::WriteFrame


void WriteFrame(FrameH& Frame, CheckSum::kind_type CheckSumMethod = CheckSum::NONE);



FrameCPP::Version_6::OFrameStream::WriteFrame


void WriteFrame(FrameH& Frame, FrVect::compression_scheme_type Method, int Level, CheckSum::kind_type CheckSumMethod = CheckSum::NONE);



FrameCPP::Version_6::OFrameStream::WriteObject


void WriteObject(FrBase& Base, bool Compress = false, FrVect::compression_scheme_type Method = FrVect::RAW, int Level = 0);



FrameCPP::Version_6::OFrameStream::close


void close();



FrameCPP::Version_6::OFrameStream::init


void init(INT_4U NumberOfClassTypes, CheckSum::kind_type CheckSumMethod, const std::string& Originator);



FrameCPP::Version_6::OFrameStream::operator << - Write data to the stream


OFrameStream& operator <<(const T* Data);



FrameCPP::Version_6::OFrameStream::operator << - Write a vector of data to the stream


OFrameStream& operator <<(const std::vector< T >& Data);



FrameCPP::Version_6::OFrameStream::operator << - Write data to the stream


OFrameStream& operator <<(const T& Data);



FrameCPP::Version_6::OFrameStream::operator << - Write container to the stream


OFrameStream& operator <<(Container< T >& Data);



FrameCPP::Version_6::OFrameStream::operator << - Write container to the stream


OFrameStream& operator <<(const Container< T >& Data);



FrameCPP::Version_6::OFrameStream::operator =


const OFrameStream& operator =(const OFrameStream&);



FrameCPP::Version_6::OFrameStream::write


void write(FrBase& Object);
Write an object to the stream

Parameters:
ParameterDescription
FrBase& ObjectObject to be written. The instance value will be adjusted appropriately.



FrameCPP::Version_6::OFrameStream::write


void write(const void*Buffer, INT_8U Length);



Variable Member Descriptions:


FrameCPP::Version_6::OFrameStream::DEFAULT_ORIGINATOR -

static const std::string DEFAULT_ORIGINATOR;

FrameCPP::Version_6::OFrameStream::m_active_callbacks -

std::vector< callback_key_type > m_active_callbacks;

FrameCPP::Version_6::OFrameStream::m_callback_methods -

std::vector< Callback* > m_callback_methods;

FrameCPP::Version_6::OFrameStream::m_fr_stat_map -

fr_stat_map_type m_fr_stat_map;

FrameCPP::Version_6::OFrameStream::m_instantiate_cb -

Callback* m_instantiate_cb;

FrameCPP::Version_6::OFrameStream::m_print_stack -

print_stack_type m_print_stack;

FrameCPP::Version_6::OFrameStream::m_print_stack_insertion -

print_stack_type::iterator m_print_stack_insertion;

FrameCPP::Version_6::OFrameStream::m_toc -

FrTOC m_toc;
Table of contents to use. When reading the stream, the TOC is consulted for object offsets. When writing, the TOC is generated as objects are written and written to file when the FrameStream is delete or closed.