Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::ImageFrameWriter

Creates frame image in user supplied output string stream `s'.
Contained in: FrameCPP::Version_3_4_5
Derived from: FrameCPP::Version_3_4_5::FrameWriterTOC
Derived by: none

#include "../../../../../lib/framecpp/src/Version3_4_5/imageframewriter.hh"


public function member index:

ImageFrameWriter(std::stringstream& s);
ost();
~ImageFrameWriter();
inline REAL_4 adcBias(int offset); Get ADC Bias by offset.
inline INT_4U adcChannelGroup(int offset); Get ADC channel group number by offset.
inline INT_4U adcChannelNumber(int offset); Get ADC channel number by offset.
inline INT_2U adcDataValid(int offset); Get ADC Data Valid flag by offset.
inline INT_2U* adcDataValidPtr(int offset); Get pointer to the Data Valid flag.
inline INT_4U adcDataVectorPtr(int offset); Given the offset find the ADC data vector ptr.
inline REAL_8 adcFShift(int offset); Get ADC Frequency Shift by offset.
inline INT_4U adcNBits(int offset); Get ADC NBits field by offset.
inline REAL_8 adcSampleRate(int offset); Get ADC sampling rate by offset.
inline REAL_4 adcSlope(int offset); Get ADC Slope by offset.
inline INT_4U adcTimeOffsetN(int offset); Get ADC Time offset nanoseconds by offset.
inline INT_4U adcTimeOffsetS(int offset); Get ADC Time Offset seconds by offset.
inline const std::vector<INT_8U>& getPositionEOF() const; Get end of frame positions.
inline const INT_8U getTOCOffset() const; Get the table of contents offset.
inline int nameLength(int offset);
inline void seekVectorData(int offset); Given the offset to the start of the vector structure, move the input strstream position to the beginning of the `data'
inline void setFrameFileAttributes(INT_4S run, INT_4U frameNumber, INT_4U dqual, INT_4U gps, INT_2U gpsInc, INT_4U gpsn, INT_2U leapS, INT_4S localTime); Set frame file attributes in all frames.
inline void startRecord(INT_2U classId, INT_4U length, const Base* b); Overrides superclass. Called from the superclass.
 

Description:

Remembers offsets into `s.str()' for every structure instance written out by the means of inheriting TOC writer class and ultimately TOC class. Provides accessors and mutators for the frame file image.


Function Member Descriptions:


FrameCPP::Version_3_4_5::ImageFrameWriter::ImageFrameWriter


ImageFrameWriter(std::stringstream& s);

Exceptions:
ExceptionDescription
write_failureWrite failed.



FrameCPP::Version_3_4_5::ImageFrameWriter::ost


ost();



FrameCPP::Version_3_4_5::ImageFrameWriter::~ImageFrameWriter


~ImageFrameWriter();

Exceptions:
ExceptionDescription
write_failureWrite failed.



FrameCPP::Version_3_4_5::ImageFrameWriter::adcBias - Get ADC Bias by offset.


inline REAL_4 adcBias(int offset);



FrameCPP::Version_3_4_5::ImageFrameWriter::adcChannelGroup - Get ADC channel group number by offset.


inline INT_4U adcChannelGroup(int offset);



FrameCPP::Version_3_4_5::ImageFrameWriter::adcChannelNumber - Get ADC channel number by offset.


inline INT_4U adcChannelNumber(int offset);



FrameCPP::Version_3_4_5::ImageFrameWriter::adcDataValid - Get ADC Data Valid flag by offset.


inline INT_2U adcDataValid(int offset);



FrameCPP::Version_3_4_5::ImageFrameWriter::adcDataValidPtr - Get pointer to the Data Valid flag.


inline INT_2U* adcDataValidPtr(int offset);
Deferencing this pointer could produce SIGBUS.




FrameCPP::Version_3_4_5::ImageFrameWriter::adcDataVectorPtr - Given the offset find the ADC data vector ptr.


inline INT_4U adcDataVectorPtr(int offset);



FrameCPP::Version_3_4_5::ImageFrameWriter::adcFShift - Get ADC Frequency Shift by offset.


inline REAL_8 adcFShift(int offset);



FrameCPP::Version_3_4_5::ImageFrameWriter::adcNBits - Get ADC NBits field by offset.


inline INT_4U adcNBits(int offset);



FrameCPP::Version_3_4_5::ImageFrameWriter::adcSampleRate - Get ADC sampling rate by offset.


inline REAL_8 adcSampleRate(int offset);



FrameCPP::Version_3_4_5::ImageFrameWriter::adcSlope - Get ADC Slope by offset.


inline REAL_4 adcSlope(int offset);



FrameCPP::Version_3_4_5::ImageFrameWriter::adcTimeOffsetN - Get ADC Time offset nanoseconds by offset.


inline INT_4U adcTimeOffsetN(int offset);



FrameCPP::Version_3_4_5::ImageFrameWriter::adcTimeOffsetS - Get ADC Time Offset seconds by offset.


inline INT_4U adcTimeOffsetS(int offset);



FrameCPP::Version_3_4_5::ImageFrameWriter::getPositionEOF - Get end of frame positions.


inline const std::vector<INT_8U>& getPositionEOF() const;



FrameCPP::Version_3_4_5::ImageFrameWriter::getTOCOffset - Get the table of contents offset.


inline const INT_8U getTOCOffset() const;



FrameCPP::Version_3_4_5::ImageFrameWriter::nameLength


inline int nameLength(int offset);



FrameCPP::Version_3_4_5::ImageFrameWriter::seekVectorData - Given the offset to the start of the vector structure, move the input strstream position to the beginning of the `data'


inline void seekVectorData(int offset);



FrameCPP::Version_3_4_5::ImageFrameWriter::setFrameFileAttributes - Set frame file attributes in all frames.


inline void setFrameFileAttributes(INT_4S run, INT_4U frameNumber, INT_4U dqual, INT_4U gps, INT_2U gpsInc, INT_4U gpsn, INT_2U leapS, INT_4S localTime);



FrameCPP::Version_3_4_5::ImageFrameWriter::startRecord - Overrides superclass. Called from the superclass.


inline void startRecord(INT_2U classId, INT_4U length, const Base* b);

Exceptions:
ExceptionDescription
write_failureWrite failed.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::ImageFrameWriter::EOFposition - offset to the beginnings of the End Of Frame structures.

std::vector<INT_8U> EOFposition;

FrameCPP::Version_3_4_5::ImageFrameWriter::ost - frame file image created in this string stream.

std::stringstream & ost;

FrameCPP::Version_3_4_5::ImageFrameWriter::toc_offset - offset to the beginning of the TOC structure.

INT_8U toc_offset;

FrameCPP::Version_3_4_5::ImageFrameWriter::vectInstanceOffsetMap - Vector instance offset map

std::map<INT_2U, std::vector<INT_4U> > vectInstanceOffsetMap;
Mapping works like this: instanceId -> vector instanceId is ++ for every newly output Vect structure. Vector has the element for each frame written. Each vector element is an offset to the start of Vect structure in the frame. The offset is measured in `ost->str()'.