ldas-tools-framecpp 3.0.4
|
#include <FrameStream.hh>
Classes | |
struct | detector_cmp |
Public Types | |
typedef OStream::buffer_type | buffer_type |
typedef INT_4U | chkSum_type |
typedef boost::shared_ptr< FrTOC > | toc_type |
typedef FrHeader::frame_library_type | frame_library_type |
typedef FrHeader::library_revision_type | library_revision_type |
typedef FrameSpec::version_type | version_type |
typedef const StreamRefInterface * | streamref_interface_type |
typedef INT_4U | fr_event_offset_type |
typedef INT_4U | fr_sim_event_offset_type |
typedef boost::shared_ptr< FrameSpec::Object > | object_type |
typedef std::ostream | ostream_type |
typedef ostream_type::char_type | char_type |
typedef const Dictionary::streamref_type::element_type * | const_stream_ref_ptr_type |
typedef Dictionary::streamref_type | streamref_type |
Public Member Functions | |
OFrameStream (buffer_type *Buffer, INT_2U Version=FRAME_SPEC_CURRENT) | |
OFrameStream (buffer_type *Buffer, INT_2U StreamVersion, INT_2U MemoryVersion) | |
OFrameStream (bool AutoDelete, buffer_type *Buffer, INT_2U Version=FRAME_SPEC_CURRENT) | |
~OFrameStream () | |
void | Close () |
void | DisableTOC () |
virtual INT_4U | GetNumberOfFrames () const |
const toc_type | GetTOC () const |
virtual INT_4U | GetTOCChecksum () const |
virtual INT_8U | GetTOCOffset () const |
void | SetAutoDeleteBuffer (const bool AutoDelete) |
Establish if the buffer is to be released with the Stream. | |
void | SetMD5Sum (bool Value) |
void | Write (object_type Obj) |
void | WriteFrame (object_type FrameObject, chkSum_type FrameChecksumType=Common::CheckSum::NONE) |
Write Frame data to the stream. | |
void | WriteFrame (object_type FrameObject, INT_2U CompressionScheme, INT_2U CompressionLevel, chkSum_type FrameChecksumType=CheckSum::NONE) |
Write Frame data to the stream. | |
void | WriteFrStatData (object_type FrameObject) |
OFrameStream (buffer_type *Buffer, INT_2U Version=FRAME_SPEC_CURRENT) | |
OFrameStream (buffer_type *Buffer, INT_2U StreamVersion, INT_2U MemoryVersion) | |
OFrameStream (bool AutoDelete, buffer_type *Buffer, INT_2U Version=FRAME_SPEC_CURRENT) | |
~OFrameStream () | |
void | Close () |
void | DisableTOC () |
virtual INT_4U | GetNumberOfFrames () const |
const toc_type | GetTOC () const |
virtual INT_4U | GetTOCChecksum () const |
virtual INT_8U | GetTOCOffset () const |
void | SetAutoDeleteBuffer (const bool AutoDelete) |
Establish if the buffer is to be released with the Stream. | |
void | SetMD5Sum (bool Value) |
void | Write (object_type Obj) |
void | WriteFrame (object_type FrameObject, chkSum_type FrameChecksumType=Common::CheckSum::NONE) |
Write Frame data to the stream. | |
void | WriteFrame (object_type FrameObject, INT_2U CompressionScheme, INT_2U CompressionLevel, chkSum_type FrameChecksumType=CheckSum::NONE) |
Write Frame data to the stream. | |
void | WriteFrStatData (object_type FrameObject) |
buffer_type * | rdbuf () const |
void | SetCheckSumFile (const CheckSum::kind_type Type) |
frame_library_type | FrameLibrary () const |
frame_library_type | FrameLibrary () const |
library_revision_type | LibraryRevision () const |
library_revision_type | LibraryRevision () const |
version_type | Version () const |
version_type | Version () const |
const std::string & | GetLastError () const |
const std::string & | GetLastError () const |
const MD5Sum & | GetMD5Sum () const |
const MD5Sum & | GetMD5Sum () const |
void | Compression (INT_2U &CompressionScheme, INT_2U &CompressionLevel) |
void | Compression (INT_2U &CompressionScheme, INT_2U &CompressionLevel) |
INT_2U | CompressionScheme () const |
INT_2U | CompressionScheme () const |
INT_2U | CompressionLevel () const |
INT_2U | CompressionLevel () const |
template<typename Header > | |
const Header * | GetFrHeader () const |
template<typename Header > | |
const Header * | GetFrHeader () const |
void | Next (object_type Obj, object_type NextObj) |
object_type | Next (object_type Obj) const |
void | Next (object_type Obj, object_type NextObj) |
object_type | Next (object_type Obj) const |
const PTR_STRUCT_BASE & | Reference (object_type Obj) const |
const PTR_STRUCT_BASE & | Reference (object_type Obj) const |
OStream & | write (const char_type *S, std::streamsize N) |
OStream & | write (const char_type *S, std::streamsize N) |
object_type | Pop () |
Get an object from the output queue. | |
object_type | Pop () |
Get an object from the output queue. | |
void | PushSingle (object_type Obj) |
Append an object to the output queue. | |
void | PushSingle (object_type Obj) |
Append an object to the output queue. | |
template<typename Iter > | |
void | PushMulti (Iter Start, Iter End, size_t Size) |
Append multiple objects to the output queue. | |
template<typename Iter > | |
void | PushMulti (Iter Start, Iter End, size_t Size) |
Append multiple objects to the output queue. | |
const Common::PTR_STRUCT_BASE & | NextPtrStruct (object_type Cur) const |
Create a PTR_STRUCT for next object. | |
const Common::PTR_STRUCT_BASE & | NextPtrStruct (const object_type::element_type *Cur) const |
Create a PTR_STRUCT for next object. | |
const Common::PTR_STRUCT_BASE & | NextPtrStruct (object_type Cur) const |
Create a PTR_STRUCT for next object. | |
const Common::PTR_STRUCT_BASE & | NextPtrStruct (const object_type::element_type *Cur) const |
Create a PTR_STRUCT for next object. | |
OStream & | operator<< (object_type Data) |
OStream & | operator<< (Pointer Data) |
template<typename T , const std::string &(T::*)() const F> | |
OStream & | operator<< (const SearchContainer< T, F > &SC) |
template<typename T > | |
OStream & | operator<< (const Container< T > &C) |
template<typename L > | |
OStream & | operator<< (const STRING< L > &String) |
template<typename L > | |
OStream & | operator<< (const STRING_SHADOW< L > &String) |
template<typename L > | |
OStream & | operator<< (const std::vector< STRING< L > > &Strings) |
template<typename DT > | |
OStream & | operator<< (const std::vector< DT > &N) |
template<typename DT > | |
OStream & | operator<< (const DT &N) |
OStream & | operator<< (object_type Data) |
OStream & | operator<< (Pointer Data) |
template<typename T , const std::string &(T::*)() const F> | |
OStream & | operator<< (const SearchContainer< T, F > &SC) |
template<typename T > | |
OStream & | operator<< (const Container< T > &C) |
template<typename L > | |
OStream & | operator<< (const STRING< L > &String) |
template<typename L > | |
OStream & | operator<< (const STRING_SHADOW< L > &String) |
template<typename L > | |
OStream & | operator<< (const std::vector< STRING< L > > &Strings) |
template<typename DT > | |
OStream & | operator<< (const std::vector< DT > &N) |
template<typename DT > | |
OStream & | operator<< (const DT &N) |
template<> | |
OStream & | operator<< (const LDASTools::AL::GPSTime &Data) |
template<> | |
OStream & | operator<< (const LDASTools::AL::GPSTime &Data) |
CheckSumFilter * | GetCheckSumFile () const |
CheckSumFilter * | GetCheckSumFile () const |
CheckSumFilter * | GetCheckSumFrame () const |
CheckSumFilter * | GetCheckSumFrame () const |
void | SetCheckSumFrame (const CheckSum::kind_type Type) |
void | SetCheckSumFrame (const CheckSum::kind_type Type) |
CheckSumFilter * | GetCheckSumObject () const |
CheckSumFilter * | GetCheckSumObject () const |
void | SetCheckSumObject (const CheckSum::kind_type Type) |
void | SetCheckSumObject (const CheckSum::kind_type Type) |
virtual void | Cleanup () |
INT_2U | GetClassId (const std::string &ClassName) const |
INT_2U | GetFSIId (INT_2U StreamId) const |
cmn_streamsize_type | PtrStructBytes () const |
const_stream_ref_ptr_type | ReferenceStreamRef () const |
const Dictionary & | GetDictionary () const |
Dictionary & | GetDictionary () |
Protected Types | |
typedef FrameSpec::ObjectInterface::unique_object_type | unique_object_type |
typedef std::unique_ptr< CheckSumFilter > | checksum_filter_type |
typedef std::unique_ptr< MD5SumFilter > | md5sum_filter_type |
typedef LDASTools::AL::unordered_map< INT_2U, INT_2U > | streamid_to_fsiid_type |
typedef boost::shared_ptr< PTR_STRUCT_BASE > | ptr_struct_base_type |
Protected Attributes | |
bool | m_closed_state |
std::unique_ptr< MD5SumFilter > | m_md5sumFilter |
Dictionary | m_dictionary |
object_type | m_null_stream_ref |
ptr_struct_base_type | m_ptr_struct_object |
streamid_to_fsiid_type | m_stream_id_to_fsi_id |
checksum_filter_type | m_file_checksum |
Checksum for file. | |
checksum_filter_type | m_frame_checksum |
Checksum for frame. | |
checksum_filter_type | m_obj_checksum |
Checksum for object. | |
md5sum_filter_type | m_file_md5sum |
MD5Sum value for the files. | |
Private Types | |
typedef boost::shared_ptr< FrDetector > | fr_detector_type |
typedef boost::shared_ptr< FrStatData > | fr_stat_data_type |
typedef std::set< INT_2U > | defined_container_type |
typedef std::list< fr_stat_data_type > | fr_stat_list_type |
typedef std::map< fr_detector_type, fr_stat_list_type, detector_cmp > | fr_stat_container_type |
typedef std::unique_ptr< buffer_type > | buffer_ptr_type |
typedef std::list< object_type > | object_queue_type |
Private Member Functions | |
void | init () |
void | write_stream_objects () |
void | init () |
void | write_stream_objects () |
template<typename T > | |
const FrameSpec::Object * | object_ptr (boost::shared_ptr< T > Obj) |
template<typename T > | |
const FrameSpec::Object * | object_ptr (const T *Obj) |
template<typename T > | |
const FrameSpec::Object * | object_ptr (boost::shared_ptr< T > Obj) |
template<typename T > | |
const FrameSpec::Object * | object_ptr (const T *Obj) |
template<> | |
const FrameSpec::Object * | object_ptr (const FrStatData *Obj) |
template<> | |
const FrameSpec::Object * | object_ptr (const FrStatData *Obj) |
Private Attributes | |
toc_type | m_toc |
INT_8U | m_toc_location |
INT_4U | m_frame_count |
defined_container_type | m_defined |
fr_stat_container_type | m_fr_stats |
bool | m_has_header |
frame_library_type | m_frame_library |
library_revision_type | m_library_revision |
version_type | m_memory_version |
Version number to use for frames in memory. | |
version_type | m_stream_version |
Version number to use for frames in stream. | |
streamref_interface_type | m_stream_ref |
std::string | m_last_error_message |
unique_object_type | m_file_header |
buffer_ptr_type | m_buffer |
bool | m_buffer_auto_delete |
bool | m_filter_internally |
object_queue_type | m_write_objects |
object_queue_type::iterator | m_write_objects_pos |
INT_2U | m_compression_scheme |
INT_2U | m_compression_level |
Friends | |
class | FrameCPP::OFrameFStream |
|
privateinherited |
|
inherited |
|
protectedinherited |
typedef INT_4U FrameCPP::Common::OFrameStream::chkSum_type |
|
inherited |
|
private |
|
private |
|
inherited |
|
inherited |
|
private |
|
private |
|
private |
|
inherited |
|
inherited |
|
protectedinherited |
|
privateinherited |
|
inherited |
|
inherited |
|
protectedinherited |
|
protectedinherited |
|
inherited |
|
inherited |
typedef boost::shared_ptr< FrTOC > FrameCPP::Common::OFrameStream::toc_type |
|
protectedinherited |
|
inherited |
FrameCPP::Common::OFrameStream::OFrameStream | ( | buffer_type * | Buffer, |
INT_2U | Version = FRAME_SPEC_CURRENT ) |
FrameCPP::Common::OFrameStream::OFrameStream | ( | buffer_type * | Buffer, |
INT_2U | StreamVersion, | ||
INT_2U | MemoryVersion ) |
FrameCPP::Common::OFrameStream::OFrameStream | ( | bool | AutoDelete, |
buffer_type * | Buffer, | ||
INT_2U | Version = FRAME_SPEC_CURRENT ) |
FrameCPP::Common::OFrameStream::~OFrameStream | ( | ) |
FrameCPP::Common::OFrameStream::OFrameStream | ( | buffer_type * | Buffer, |
INT_2U | Version = FRAME_SPEC_CURRENT ) |
FrameCPP::Common::OFrameStream::OFrameStream | ( | buffer_type * | Buffer, |
INT_2U | StreamVersion, | ||
INT_2U | MemoryVersion ) |
FrameCPP::Common::OFrameStream::OFrameStream | ( | bool | AutoDelete, |
buffer_type * | Buffer, | ||
INT_2U | Version = FRAME_SPEC_CURRENT ) |
FrameCPP::Common::OFrameStream::~OFrameStream | ( | ) |
|
virtualinherited |
Reimplemented in FrameCPP::Common::IFrameStream, FrameCPP::Common::IFrameStream, FrameCPP::Common::IStream, and FrameCPP::Common::IStream.
void FrameCPP::Common::OFrameStream::Close | ( | ) |
void FrameCPP::Common::OFrameStream::Close | ( | ) |
|
inlineinherited |
param[in,out] CompressionScheme param[in,out] CompressionType
|
inherited |
param[in,out] CompressionScheme param[in,out] CompressionType
|
inlineinherited |
|
inherited |
|
inlineinherited |
|
inherited |
|
inline |
void FrameCPP::Common::OFrameStream::DisableTOC | ( | ) |
|
inlineinherited |
|
inherited |
|
inlineprotectedinherited |
|
protectedinherited |
|
inlineprotectedinherited |
|
protectedvirtualinherited |
Reimplemented from FrameCPP::Common::StreamBase.
|
protectedvirtualinherited |
Reimplemented from FrameCPP::Common::StreamBase.
|
inlineinherited |
|
inherited |
|
inlineinherited |
|
inherited |
|
inlineinherited |
|
inherited |
|
inherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inherited |
|
inlineinherited |
|
inlineinherited |
|
inherited |
|
inlineinherited |
|
inherited |
|
inlinevirtual |
Reimplemented from FrameCPP::Common::OStream.
|
virtual |
Reimplemented from FrameCPP::Common::OStream.
|
inline |
const toc_type FrameCPP::Common::OFrameStream::GetTOC | ( | ) | const |
|
inlineprotected |
|
protected |
|
inlinevirtual |
Reimplemented from FrameCPP::Common::OStream.
|
virtual |
Reimplemented from FrameCPP::Common::OStream.
|
inlinevirtual |
Reimplemented from FrameCPP::Common::OStream.
|
virtual |
Reimplemented from FrameCPP::Common::OStream.
|
private |
|
private |
|
inlineinherited |
|
inherited |
|
inlineprotectedinherited |
|
protectedinherited |
|
inlineprotectedinherited |
|
protectedinherited |
|
protectedinherited |
Modify an object so it is appropriate for the stream.
[in] | Obj | The object that should be transformed. |
|
protectedinherited |
Modify an object so it is appropriate for the stream.
[in] | Obj | The object that should be transformed. |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Create a PTR_STRUCT for next object.
|
inherited |
Create a PTR_STRUCT for next object.
|
inherited |
Create a PTR_STRUCT for next object.
|
inherited |
Create a PTR_STRUCT for next object.
|
inlineprivateinherited |
|
privateinherited |
|
inlineprivateinherited |
|
inlineprivateinherited |
|
privateinherited |
|
privateinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inherited |
|
inlineinherited |
Get an object from the output queue.
This method retieves the next object to be written along with information indicating if the object should be deallocated once written.
|
inherited |
Get an object from the output queue.
|
inlineinherited |
|
inlineinherited |
Append multiple objects to the output queue.
[in] | Start | The first element to be added to the queue. |
[in] | End | The last element to be added to the queue. |
[in] | Size | The number of elements to be added to the queue. |
|
inlineinherited |
Append multiple objects to the output queue.
[in] | Start | The first element to be added to the queue. |
[in] | End | The last element to be added to the queue. |
[in] | Size | The number of elements to be added to the queue. |
|
inlineinherited |
Append an object to the output queue.
[in] | Obj | The object to be written. |
This method adds an object to the queue of objects to be written. It preserves the order in which the objects should be written to the stream by keeping a local iterator indicating the point of insertion.
|
inherited |
Append an object to the output queue.
[in] | Obj | The object to be written. |
|
inline |
|
inherited |
|
inherited |
|
inherited |
|
protectedvirtualinherited |
Reimplemented in FrameCPP::Common::IFrameStream, and FrameCPP::Common::IFrameStream.
|
protectedvirtualinherited |
Reimplemented in FrameCPP::Common::IFrameStream, and FrameCPP::Common::IFrameStream.
|
inline |
Establish if the buffer is to be released with the Stream.
[in] | AutoDelete | If true, then the buffer will be released with the destruction of this instance. If false, then the buffer will exist even after the destruction of this instance. |
void FrameCPP::Common::OFrameStream::SetAutoDeleteBuffer | ( | const bool | AutoDelete | ) |
Establish if the buffer is to be released with the Stream.
[in] | AutoDelete | If true, then the buffer will be released with the destruction of this instance. If false, then the buffer will exist even after the destruction of this instance. |
|
inlineprotectedinherited |
Establish if the buffer is to be released with the Stream.
[in] | Value | If true, then the buffer will be released with the destruction of this instance. If false, then the buffer will exist even after the destruction of this instance. |
|
protectedinherited |
Establish if the buffer is to be released with the Stream.
[in] | Value | If true, then the buffer will be released with the destruction of this instance. If false, then the buffer will exist even after the destruction of this instance. |
|
inline |
|
inlineinherited |
|
inherited |
|
inlineinherited |
|
inherited |
|
inlineprotectedinherited |
|
protectedinherited |
|
inlineprotectedinherited |
|
protectedinherited |
|
inline |
void FrameCPP::Common::OFrameStream::SetMD5Sum | ( | bool | Value | ) |
|
protectedinherited |
|
protectedinherited |
|
inlineprotectedinherited |
|
protectedinherited |
|
inlineprotectedinherited |
|
protectedinherited |
|
inlineinherited |
|
inherited |
|
inlineprotectedinherited |
|
protectedinherited |
void FrameCPP::Common::OFrameStream::Write | ( | object_type | Obj | ) |
void FrameCPP::Common::OFrameStream::Write | ( | object_type | Obj | ) |
|
inlineinherited |
|
private |
|
private |
void FrameCPP::Common::OFrameStream::WriteFrame | ( | object_type | FrameObject, |
chkSum_type | FrameChecksumType = Common::CheckSum::NONE ) |
Write Frame data to the stream.
void FrameCPP::Common::OFrameStream::WriteFrame | ( | object_type | FrameObject, |
chkSum_type | FrameChecksumType = Common::CheckSum::NONE ) |
Write Frame data to the stream.
void FrameCPP::Common::OFrameStream::WriteFrame | ( | object_type | FrameObject, |
INT_2U | CompressionScheme, | ||
INT_2U | CompressionLevel, | ||
chkSum_type | FrameChecksumType = CheckSum::NONE ) |
Write Frame data to the stream.
void FrameCPP::Common::OFrameStream::WriteFrame | ( | object_type | FrameObject, |
INT_2U | CompressionScheme, | ||
INT_2U | CompressionLevel, | ||
chkSum_type | FrameChecksumType = CheckSum::NONE ) |
Write Frame data to the stream.
void FrameCPP::Common::OFrameStream::WriteFrStatData | ( | object_type | FrameObject | ) |
void FrameCPP::Common::OFrameStream::WriteFrStatData | ( | object_type | FrameObject | ) |
|
friend |
|
privateinherited |
|
privateinherited |
|
protectedinherited |
|
privateinherited |
|
privateinherited |
|
private |
|
protectedinherited |
|
protectedinherited |
Checksum for file.
|
privateinherited |
|
protectedinherited |
MD5Sum value for the files.
|
privateinherited |
|
private |
|
protectedinherited |
Checksum for frame.
|
private |
|
privateinherited |
|
private |
|
privateinherited |
|
privateinherited |
|
protectedinherited |
|
privateinherited |
Version number to use for frames in memory.
|
protectedinherited |
|
protectedinherited |
Checksum for object.
|
protectedinherited |
|
mutableprotectedinherited |
|
privateinherited |
|
privateinherited |
Version number to use for frames in stream.
|
private |
|
private |
|
privateinherited |
|
privateinherited |