ldas-tools-framecpp  2.6.5
Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Common::IStream Class Reference

#include <IOStream.hh>

Inheritance diagram for FrameCPP::Common::IStream:
FrameCPP::Common::StreamBase FrameCPP::Common::IFrameStream FrameCPP::Common::IFrameStreamWrapper< DECL > FrameCPP::Common::IFrameStreamWrapper< DECL_PARAMS > FrameCPP::Common::IFrameStreamPlanWrapper< DECL >

Classes

class  Resizer
 Manipulator class for input streams. More...
 
class  resolver
 

Public Types

typedef std::istream::char_type char_type
 
typedef std::istream istream_type
 
typedef FrameBufferInterface buffer_type
 
typedef boost::shared_ptr< FrameSpec::Objectobject_type
 
typedef const Dictionary::streamref_type::element_type * const_stream_ref_ptr_type
 
typedef Dictionary::streamref_type streamref_type
 

Public Member Functions

 IStream (buffer_type *Buffer, bool AutoDelete=true)
 
virtual ~IStream ()
 
virtual void Cleanup ()
 
CheckSumFilterGetCheckSumFile () const
 
void SetCheckSumFile (const CheckSum::kind_type Type)
 
CheckSumFilterGetCheckSumFrame () const
 
void SetCheckSumFrame (const CheckSum::kind_type Type)
 
CheckSumFilterGetCheckSumObject () const
 
void SetCheckSumObject (const CheckSum::kind_type Type)
 
virtual const FrHeaderGetFrHeader () const
 
Dictionary::ptr_struct_key_type NextLookup (object_type Obj) const
 
void RemoveResolver (const void *Old, int MaxDepth)
 
template<typename T >
void PushPtr (boost::shared_ptr< T > *Obj)
 
template<typename T_NEW , typename T_OLD >
void ReplacePtr (boost::shared_ptr< T_NEW > *Obj, boost::shared_ptr< T_OLD > *OldPtr, const int MaxDepth)
 
template<typename T >
void PushRef (Container< T > &C)
 
template<typename T , typename OT >
void ReplaceRef (Container< T > &C, const Container< OT > &Old, const int MaxDepth)
 
FrameBufferInterfacerdbuf () const
 
IStreamread (char_type *S, std::streamsize N)
 
virtual ptr_struct_base_type Next (object_type Obj)
 
virtual ptr_struct_base_type Next (object_type::element_type *Obj)
 
ptr_struct_base_type ReadPtrStruct ()
 
void Resolve ()
 Method to resolve links. More...
 
cmn_streamsize_type Size ()
 Return the size of the stream. More...
 
template<typename T >
IStreamoperator>> (boost::shared_ptr< T > *Data)
 
template<typename T , const std::string &(T::*)() const F>
IStreamoperator>> (SearchContainer< T, F > &SC)
 
template<typename T >
IStreamoperator>> (Container< T > &C)
 
template<typename L >
IStreamoperator>> (STRING< L > &String)
 
template<typename L >
IStreamoperator>> (STRING_SHADOW< L > &String)
 
template<typename L >
IStreamoperator>> (std::vector< STRING< L > > &String)
 
template<typename DT >
IStreamoperator>> (std::vector< DT > &Data)
 
template<typename DT >
IStreamoperator>> (DT &Data)
 
template<typename T , typename S >
IStreamoperator>> (IStream::Resizer< T, S > Value)
 
bool ByteSwapping () const
 
template<>
IStreamoperator>> (LDASTools::AL::GPSTime &Data)
 
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 DictionaryGetDictionary () const
 
DictionaryGetDictionary ()
 

Protected Types

typedef boost::shared_ptr< resolverresolver_type
 
typedef std::list< resolver_typeresolver_container_type
 
typedef std::unique_ptr< MD5SumFiltermd5sum_filter_type
 
typedef LDASTools::AL::unordered_map< INT_2U, INT_2U > streamid_to_fsiid_type
 
typedef boost::shared_ptr< PTR_STRUCT_BASEptr_struct_base_type
 

Protected Member Functions

void nextReplace (object_type OldObj, object_type NewObj)
 
void byteSwapping (bool Value)
 
virtual void pushResolver (resolver_type Resolver)
 
object_type objectLookup (object_type::element_type *Pointer)
 
const resolver_container_typeresolverContainer () const
 
resolver_container_typeresolverContainer ()
 
void setAutoDeleteBuffer (const bool Value)
 
const FrameSpec::InfoframeSpecInfo () const
 
virtual void frameSpecInfo (const FrameSpec::Info *Spec)
 

Protected Attributes

bool m_logNextPtr
 
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
 
md5sum_filter_type m_file_md5sum
 MD5Sum value for the files. More...
 

Member Typedef Documentation

◆ buffer_type

◆ char_type

typedef std::istream::char_type FrameCPP::Common::IStream::char_type

◆ const_stream_ref_ptr_type

typedef const Dictionary::streamref_type::element_type* FrameCPP::Common::StreamBase::const_stream_ref_ptr_type
inherited

◆ istream_type

◆ md5sum_filter_type

typedef std::unique_ptr< MD5SumFilter > FrameCPP::Common::StreamBase::md5sum_filter_type
protectedinherited

◆ object_type

typedef boost::shared_ptr< FrameSpec::Object > FrameCPP::Common::StreamBase::object_type
inherited

◆ ptr_struct_base_type

typedef boost::shared_ptr< PTR_STRUCT_BASE > FrameCPP::Common::StreamBase::ptr_struct_base_type
protectedinherited

◆ resolver_container_type

◆ resolver_type

typedef boost::shared_ptr< resolver > FrameCPP::Common::IStream::resolver_type
protected

◆ streamid_to_fsiid_type

typedef LDASTools::AL::unordered_map< INT_2U, INT_2U > FrameCPP::Common::StreamBase::streamid_to_fsiid_type
protectedinherited

◆ streamref_type

Constructor & Destructor Documentation

◆ IStream()

FrameCPP::Common::IStream::IStream ( buffer_type Buffer,
bool  AutoDelete = true 
)
inline

◆ ~IStream()

FrameCPP::Common::IStream::~IStream ( )
inlinevirtual

Member Function Documentation

◆ ByteSwapping()

bool FrameCPP::Common::IStream::ByteSwapping ( ) const
inline

◆ byteSwapping()

void FrameCPP::Common::IStream::byteSwapping ( bool  Value)
inlineprotected

◆ Cleanup()

void FrameCPP::Common::IStream::Cleanup ( )
virtual

Reimplemented from FrameCPP::Common::StreamBase.

Reimplemented in FrameCPP::Common::IFrameStream.

◆ frameSpecInfo() [1/2]

const FrameSpec::Info & FrameCPP::Common::StreamBase::frameSpecInfo ( ) const
inlineprotectedinherited

◆ frameSpecInfo() [2/2]

void FrameCPP::Common::StreamBase::frameSpecInfo ( const FrameSpec::Info Spec)
protectedvirtualinherited

Reimplemented in FrameCPP::Common::FrameStream.

◆ GetCheckSumFile()

CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumFile ( ) const
inline

◆ GetCheckSumFrame()

CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumFrame ( ) const
inline

◆ GetCheckSumObject()

CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumObject ( ) const
inline

◆ GetClassId()

INT_2U FrameCPP::Common::StreamBase::GetClassId ( const std::string &  ClassName) const
inherited

◆ GetDictionary() [1/2]

const Dictionary & FrameCPP::Common::StreamBase::GetDictionary ( ) const
inlineinherited

◆ GetDictionary() [2/2]

Dictionary & FrameCPP::Common::StreamBase::GetDictionary ( )
inlineinherited

◆ GetFrHeader()

const FrHeader & FrameCPP::Common::IStream::GetFrHeader ( ) const
virtual

Reimplemented in FrameCPP::Common::IFrameStream.

◆ GetFSIId()

INT_2U FrameCPP::Common::StreamBase::GetFSIId ( INT_2U  StreamId) const
inlineinherited

◆ Next() [1/2]

IStream::ptr_struct_base_type FrameCPP::Common::IStream::Next ( object_type  Obj)
virtual

◆ Next() [2/2]

IStream::ptr_struct_base_type FrameCPP::Common::IStream::Next ( object_type::element_type *  Obj)
virtual

Reimplemented in FrameCPP::Common::IFrameStream.

◆ NextLookup()

Dictionary::ptr_struct_key_type FrameCPP::Common::IStream::NextLookup ( object_type  Obj) const
inline

◆ nextReplace()

void FrameCPP::Common::IStream::nextReplace ( object_type  OldObj,
object_type  NewObj 
)
inlineprotected

◆ objectLookup()

IStream::object_type FrameCPP::Common::IStream::objectLookup ( object_type::element_type *  Pointer)
inlineprotected

◆ operator>>() [1/10]

template<typename T >
IStream & FrameCPP::Common::IStream::operator>> ( boost::shared_ptr< T > *  Data)
inline

◆ operator>>() [2/10]

template<typename T , const std::string &(T::*)() const F>
IStream & FrameCPP::Common::IStream::operator>> ( SearchContainer< T, F > &  SC)
inline

◆ operator>>() [3/10]

template<typename T >
IStream & FrameCPP::Common::IStream::operator>> ( Container< T > &  C)
inline

◆ operator>>() [4/10]

template<typename L >
IStream & FrameCPP::Common::IStream::operator>> ( STRING< L > &  String)
inline

◆ operator>>() [5/10]

template<typename L >
IStream & FrameCPP::Common::IStream::operator>> ( STRING_SHADOW< L > &  String)
inline

◆ operator>>() [6/10]

template<typename L >
IStream & FrameCPP::Common::IStream::operator>> ( std::vector< STRING< L > > &  String)
inline

◆ operator>>() [7/10]

template<typename DT >
IStream & FrameCPP::Common::IStream::operator>> ( std::vector< DT > &  Data)
inline

◆ operator>>() [8/10]

template<typename DT >
IStream & FrameCPP::Common::IStream::operator>> ( DT &  Data)
inline

◆ operator>>() [9/10]

template<typename T , typename S>
IStream & FrameCPP::Common::IStream::operator>> ( IStream::Resizer< T, S >  Value)
inline

◆ operator>>() [10/10]

template<>
IStream& FrameCPP::Common::IStream::operator>> ( LDASTools::AL::GPSTime &  Data)
inline

◆ PtrStructBytes()

cmn_streamsize_type FrameCPP::Common::StreamBase::PtrStructBytes ( ) const
inlineinherited

◆ PushPtr()

template<typename T >
void FrameCPP::Common::IStream::PushPtr ( boost::shared_ptr< T > *  Obj)
inline

◆ PushRef()

template<typename T >
void FrameCPP::Common::IStream::PushRef ( Container< T > &  C)
inline

◆ pushResolver()

void FrameCPP::Common::IStream::pushResolver ( resolver_type  Resolver)
protectedvirtual

Reimplemented in FrameCPP::Common::IFrameStream.

◆ rdbuf()

IStream::buffer_type * FrameCPP::Common::IStream::rdbuf ( ) const
inline

◆ read()

IStream & FrameCPP::Common::IStream::read ( char_type S,
std::streamsize  N 
)
inline

◆ ReadPtrStruct()

IStream::ptr_struct_base_type FrameCPP::Common::IStream::ReadPtrStruct ( )

Reads the next group of bytes from the stream as a PTR_STRUCT as defined by the active frame specification associated with the stream.

◆ ReferenceStreamRef()

StreamBase::const_stream_ref_ptr_type FrameCPP::Common::StreamBase::ReferenceStreamRef ( ) const
inherited

◆ RemoveResolver()

void FrameCPP::Common::IStream::RemoveResolver ( const void *  Old,
int  MaxDepth 
)
inline

◆ ReplacePtr()

template<typename T_NEW , typename T_OLD >
void FrameCPP::Common::IStream::ReplacePtr ( boost::shared_ptr< T_NEW > *  Obj,
boost::shared_ptr< T_OLD > *  OldPtr,
const int  MaxDepth 
)
inline

◆ ReplaceRef()

template<typename T , typename OT >
void FrameCPP::Common::IStream::ReplaceRef ( Container< T > &  C,
const Container< OT > &  Old,
const int  MaxDepth 
)
inline

◆ Resolve()

void FrameCPP::Common::IStream::Resolve ( )

Method to resolve links.

◆ resolverContainer() [1/2]

const IStream::resolver_container_type & FrameCPP::Common::IStream::resolverContainer ( ) const
inlineprotected

◆ resolverContainer() [2/2]

IStream::resolver_container_type & FrameCPP::Common::IStream::resolverContainer ( )
inlineprotected

◆ setAutoDeleteBuffer()

void FrameCPP::Common::IStream::setAutoDeleteBuffer ( const bool  Value)
inlineprotected

◆ SetCheckSumFile()

void FrameCPP::Common::IStream::SetCheckSumFile ( const CheckSum::kind_type  Type)
inline

◆ SetCheckSumFrame()

void FrameCPP::Common::IStream::SetCheckSumFrame ( const CheckSum::kind_type  Type)
inline

◆ SetCheckSumObject()

void FrameCPP::Common::IStream::SetCheckSumObject ( const CheckSum::kind_type  Type)
inline

◆ Size()

cmn_streamsize_type FrameCPP::Common::IStream::Size ( )
inline

Return the size of the stream.

Returns
The number of bytes that compose the stream

Member Data Documentation

◆ m_dictionary

Dictionary FrameCPP::Common::StreamBase::m_dictionary
protectedinherited

◆ m_file_md5sum

md5sum_filter_type FrameCPP::Common::StreamBase::m_file_md5sum
protectedinherited

MD5Sum value for the files.

◆ m_logNextPtr

bool FrameCPP::Common::IStream::m_logNextPtr
protected

◆ m_null_stream_ref

object_type FrameCPP::Common::StreamBase::m_null_stream_ref
protectedinherited

◆ m_ptr_struct_object

ptr_struct_base_type FrameCPP::Common::StreamBase::m_ptr_struct_object
protectedinherited

◆ m_stream_id_to_fsi_id

streamid_to_fsiid_type FrameCPP::Common::StreamBase::m_stream_id_to_fsi_id
mutableprotectedinherited

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