ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
IFrameFStream Class Reference

#include <IFrameStream.hh>

Classes

class  iframe_stream_type
 

Public Types

enum  sub_element_type {
  HISTORY = FrameCPP::FrameH::HISTORY , DETECT_SIM = FrameCPP::FrameH::DETECT_SIM , DETECT_PROC = FrameCPP::FrameH::DETECT_PROC , AUX_DATA = FrameCPP::FrameH::AUX_DATA ,
  AUX_TABLE = FrameCPP::FrameH::AUX_TABLE , TYPE = FrameCPP::FrameH::TYPE , USER = FrameCPP::FrameH::USER , HISTORY = FrameCPP::FrameH::HISTORY ,
  DETECT_SIM = FrameCPP::FrameH::DETECT_SIM , DETECT_PROC = FrameCPP::FrameH::DETECT_PROC , AUX_DATA = FrameCPP::FrameH::AUX_DATA , AUX_TABLE = FrameCPP::FrameH::AUX_TABLE ,
  TYPE = FrameCPP::FrameH::TYPE , USER = FrameCPP::FrameH::USER
}
 
enum  sub_element_type {
  HISTORY = FrameCPP::FrameH::HISTORY , DETECT_SIM = FrameCPP::FrameH::DETECT_SIM , DETECT_PROC = FrameCPP::FrameH::DETECT_PROC , AUX_DATA = FrameCPP::FrameH::AUX_DATA ,
  AUX_TABLE = FrameCPP::FrameH::AUX_TABLE , TYPE = FrameCPP::FrameH::TYPE , USER = FrameCPP::FrameH::USER , HISTORY = FrameCPP::FrameH::HISTORY ,
  DETECT_SIM = FrameCPP::FrameH::DETECT_SIM , DETECT_PROC = FrameCPP::FrameH::DETECT_PROC , AUX_DATA = FrameCPP::FrameH::AUX_DATA , AUX_TABLE = FrameCPP::FrameH::AUX_TABLE ,
  TYPE = FrameCPP::FrameH::TYPE , USER = FrameCPP::FrameH::USER
}
 
typedef FrameCPP::FrameH::history_type fr_history_type
 
typedef FrameCPP::FrameH::history_type fr_history_type
 
typedef Common::IFrameStream::frame_library_type frame_library_type
 
typedef Common::IFrameStream::frame_library_type frame_library_type
 
typedef Common::IFrameStream::library_revision_type library_revision_type
 
typedef Common::IFrameStream::library_revision_type library_revision_type
 
typedef Common::IFrameStream::size_type size_type
 
typedef Common::IFrameStream::size_type size_type
 
typedef Common::IFrameStream::version_type version_type
 
typedef Common::IFrameStream::version_type version_type
 
typedef boost::shared_ptr< FrameHframe_h_type
 
typedef boost::shared_ptr< FrameHframe_h_type
 
typedef boost::shared_ptr< FrDetector > fr_detector_type
 
typedef boost::shared_ptr< FrDetector > fr_detector_type
 
typedef boost::shared_ptr< FrEvent > fr_event_type
 
typedef boost::shared_ptr< FrEvent > fr_event_type
 
typedef INT_4U fr_event_offset_type
 
typedef INT_4U fr_event_offset_type
 
typedef boost::shared_ptr< FrAdcDatafr_adc_data_type
 
typedef boost::shared_ptr< FrAdcDatafr_adc_data_type
 
typedef boost::shared_ptr< FrProcDatafr_proc_data_type
 
typedef boost::shared_ptr< FrProcDatafr_proc_data_type
 
typedef boost::shared_ptr< FrSerDatafr_ser_data_type
 
typedef boost::shared_ptr< FrSerDatafr_ser_data_type
 
typedef boost::shared_ptr< FrSimDatafr_sim_data_type
 
typedef boost::shared_ptr< FrSimDatafr_sim_data_type
 
typedef boost::shared_ptr< FrSimEvent > fr_sim_event_type
 
typedef boost::shared_ptr< FrSimEvent > fr_sim_event_type
 
typedef INT_4U fr_sim_event_offset_type
 
typedef INT_4U fr_sim_event_offset_type
 
typedef boost::shared_ptr< const FrTOCtoc_ret_type
 
typedef boost::shared_ptr< const FrTOCtoc_ret_type
 

Public Member Functions

 IFrameFStream (const char *Filename)
 Constructor.
 
 IFrameFStream (const char *Filename, bool MemoryMappedIO, size_t BufferSize)
 Constructor.
 
 IFrameFStream (const char *Filename)
 Constructor.
 
 IFrameFStream (const char *Filename, bool MemoryMappedIO, size_t BufferSize)
 Constructor.
 
std::string Filename () const
 
std::string Filename () const
 
frame_library_type FrameLibrary () const
 
frame_library_type FrameLibrary () const
 
std::string FrameLibraryName () const
 
std::string FrameLibraryName () const
 
size_type GetNumberOfFrames () const
 
size_type GetNumberOfFrames () const
 
toc_ret_type GetTOC () const
 
toc_ret_type GetTOC () const
 
library_revision_type LibraryRevision () const
 
library_revision_type LibraryRevision () const
 
fr_detector_type ReadDetector (const std::string &Name)
 
fr_detector_type ReadDetector (const std::string &Name)
 
fr_adc_data_type ReadFrAdcData (INT_4U Frame, const std::string &Channel)
 
fr_adc_data_type ReadFrAdcData (INT_4U Frame, const std::string &Channel)
 
fr_event_type ReadFrEvent (INT_4U Frame, const std::string &Channel)
 
fr_event_type ReadFrEvent (const std::string &Channel, fr_event_offset_type Offset)
 
fr_event_type ReadFrEvent (INT_4U Frame, const std::string &Channel)
 
fr_event_type ReadFrEvent (const std::string &Channel, fr_event_offset_type Offset)
 
fr_history_type ReadFrHistory (INT_4U Frame)
 
fr_history_type ReadFrHistory (INT_4U Frame)
 
fr_proc_data_type ReadFrProcData (INT_4U Frame, const std::string &Channel)
 
fr_proc_data_type ReadFrProcData (INT_4U Frame, const std::string &Channel)
 
fr_ser_data_type ReadFrSerData (INT_4U Frame, const std::string &Channel)
 
fr_ser_data_type ReadFrSerData (INT_4U Frame, const std::string &Channel)
 
fr_sim_data_type ReadFrSimData (INT_4U Frame, const std::string &Channel)
 
fr_sim_data_type ReadFrSimData (INT_4U Frame, const std::string &Channel)
 
fr_sim_event_type ReadFrSimEvent (INT_4U Frame, const std::string &Channel)
 
fr_sim_event_type ReadFrSimEvent (const std::string &Channel, fr_sim_event_offset_type Offset)
 
fr_sim_event_type ReadFrSimEvent (INT_4U Frame, const std::string &Channel)
 
fr_sim_event_type ReadFrSimEvent (const std::string &Channel, fr_sim_event_offset_type Offset)
 
frame_h_type ReadFrameN (INT_4U Index)
 
frame_h_type ReadFrameN (INT_4U Index)
 
frame_h_type ReadFrameNSubset (INT_4U Index, INT_4U Elements)
 
frame_h_type ReadFrameNSubset (INT_4U Index, INT_4U Elements)
 
frame_h_type ReadNextFrame ()
 
frame_h_type ReadNextFrame ()
 
version_type Version () const
 
version_type Version () const
 

Static Public Attributes

static const int BUFFER_SIZE = 1024 * 1024
 
static const bool MEMORY_MAPPED_IO = false
 

Private Types

typedef LDASTools::AL::filebuf filebuf_type
 
typedef LDASTools::AL::filebuf filebuf_type
 
typedef Common::FrameBuffer< filebuf_typeframe_buffer_type
 
typedef Common::FrameBuffer< filebuf_typeframe_buffer_type
 
typedef iframe_stream_type frame_stream_type
 
typedef iframe_stream_type frame_stream_type
 
typedef boost::weak_ptr< const Common::FrTOC > toc_type
 
typedef boost::weak_ptr< const Common::FrTOC > toc_type
 

Private Attributes

boost::shared_array< CHAR > m_buffer
 
std::string m_filename
 
std::unique_ptr< frame_buffer_typem_frame_buffer
 
std::unique_ptr< frame_stream_typem_frame_stream
 
toc_type m_toc
 

Member Typedef Documentation

◆ filebuf_type [1/2]

typedef LDASTools::AL::filebuf FrameCPP::IFrameFStream::filebuf_type
private

◆ filebuf_type [2/2]

typedef LDASTools::AL::filebuf FrameCPP::IFrameFStream::filebuf_type
private

◆ fr_adc_data_type [1/2]

◆ fr_adc_data_type [2/2]

◆ fr_detector_type [1/2]

typedef boost::shared_ptr< FrDetector > FrameCPP::IFrameFStream::fr_detector_type

◆ fr_detector_type [2/2]

typedef boost::shared_ptr< FrDetector > FrameCPP::IFrameFStream::fr_detector_type

◆ fr_event_offset_type [1/2]

◆ fr_event_offset_type [2/2]

◆ fr_event_type [1/2]

typedef boost::shared_ptr< FrEvent > FrameCPP::IFrameFStream::fr_event_type

◆ fr_event_type [2/2]

typedef boost::shared_ptr< FrEvent > FrameCPP::IFrameFStream::fr_event_type

◆ fr_history_type [1/2]

typedef FrameCPP::FrameH::history_type FrameCPP::IFrameFStream::fr_history_type

◆ fr_history_type [2/2]

typedef FrameCPP::FrameH::history_type FrameCPP::IFrameFStream::fr_history_type

◆ fr_proc_data_type [1/2]

◆ fr_proc_data_type [2/2]

◆ fr_ser_data_type [1/2]

◆ fr_ser_data_type [2/2]

◆ fr_sim_data_type [1/2]

◆ fr_sim_data_type [2/2]

◆ fr_sim_event_offset_type [1/2]

◆ fr_sim_event_offset_type [2/2]

◆ fr_sim_event_type [1/2]

typedef boost::shared_ptr< FrSimEvent > FrameCPP::IFrameFStream::fr_sim_event_type

◆ fr_sim_event_type [2/2]

typedef boost::shared_ptr< FrSimEvent > FrameCPP::IFrameFStream::fr_sim_event_type

◆ frame_buffer_type [1/2]

typedef Common::FrameBuffer< filebuf_type > FrameCPP::IFrameFStream::frame_buffer_type
private

◆ frame_buffer_type [2/2]

typedef Common::FrameBuffer< filebuf_type > FrameCPP::IFrameFStream::frame_buffer_type
private

◆ frame_h_type [1/2]

typedef boost::shared_ptr< FrameH > FrameCPP::IFrameFStream::frame_h_type

◆ frame_h_type [2/2]

typedef boost::shared_ptr< FrameH > FrameCPP::IFrameFStream::frame_h_type

◆ frame_library_type [1/2]

◆ frame_library_type [2/2]

◆ frame_stream_type [1/2]

◆ frame_stream_type [2/2]

◆ library_revision_type [1/2]

◆ library_revision_type [2/2]

◆ size_type [1/2]

◆ size_type [2/2]

◆ toc_ret_type [1/2]

typedef boost::shared_ptr< const FrTOC > FrameCPP::IFrameFStream::toc_ret_type

◆ toc_ret_type [2/2]

typedef boost::shared_ptr< const FrTOC > FrameCPP::IFrameFStream::toc_ret_type

◆ toc_type [1/2]

typedef boost::weak_ptr< const Common::FrTOC > FrameCPP::IFrameFStream::toc_type
private

◆ toc_type [2/2]

typedef boost::weak_ptr< const Common::FrTOC > FrameCPP::IFrameFStream::toc_type
private

◆ version_type [1/2]

◆ version_type [2/2]

Member Enumeration Documentation

◆ sub_element_type [1/2]

Enumerator
HISTORY 
DETECT_SIM 
DETECT_PROC 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 
HISTORY 
DETECT_SIM 
DETECT_PROC 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 

◆ sub_element_type [2/2]

Enumerator
HISTORY 
DETECT_SIM 
DETECT_PROC 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 
HISTORY 
DETECT_SIM 
DETECT_PROC 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 

Constructor & Destructor Documentation

◆ IFrameFStream() [1/4]

FrameCPP::IFrameFStream::IFrameFStream ( const char * Filename)
inline

Constructor.

Parameters
[in]FilenameName of the input frame file

◆ IFrameFStream() [2/4]

FrameCPP::IFrameFStream::IFrameFStream ( const char * Filename,
bool MemoryMappedIO,
size_t BufferSize = IFrameFStream::BUFFER_SIZE )
inline

Constructor.

Parameters
[in]FilenameName of the input frame file
[in]MemoryMappedIOTrue if memory mapped io should be used, false otherwise.
[in]BufferSizeNumber of bytes to use for file buffering.

◆ IFrameFStream() [3/4]

FrameCPP::IFrameFStream::IFrameFStream ( const char * Filename)

Constructor.

Parameters
[in]FilenameName of the input frame file

◆ IFrameFStream() [4/4]

FrameCPP::IFrameFStream::IFrameFStream ( const char * Filename,
bool MemoryMappedIO,
size_t BufferSize )

Constructor.

Parameters
[in]FilenameName of the input frame file
[in]MemoryMappedIOTrue if memory mapped io should be used, false otherwise.
[in]BufferSizeNumber of bytes to use for file buffering.

Member Function Documentation

◆ Filename() [1/2]

std::string FrameCPP::IFrameFStream::Filename ( ) const
inline

◆ Filename() [2/2]

std::string FrameCPP::IFrameFStream::Filename ( ) const

◆ FrameLibrary() [1/2]

IFrameFStream::frame_library_type FrameCPP::IFrameFStream::FrameLibrary ( ) const
inline

◆ FrameLibrary() [2/2]

frame_library_type FrameCPP::IFrameFStream::FrameLibrary ( ) const

◆ FrameLibraryName() [1/2]

std::string FrameCPP::IFrameFStream::FrameLibraryName ( ) const
inline

◆ FrameLibraryName() [2/2]

std::string FrameCPP::IFrameFStream::FrameLibraryName ( ) const

◆ GetNumberOfFrames() [1/2]

IFrameFStream::size_type FrameCPP::IFrameFStream::GetNumberOfFrames ( ) const
inline

◆ GetNumberOfFrames() [2/2]

size_type FrameCPP::IFrameFStream::GetNumberOfFrames ( ) const

◆ GetTOC() [1/2]

IFrameFStream::toc_ret_type FrameCPP::IFrameFStream::GetTOC ( ) const
inline

◆ GetTOC() [2/2]

toc_ret_type FrameCPP::IFrameFStream::GetTOC ( ) const

◆ LibraryRevision() [1/2]

IFrameFStream::library_revision_type FrameCPP::IFrameFStream::LibraryRevision ( ) const
inline

◆ LibraryRevision() [2/2]

library_revision_type FrameCPP::IFrameFStream::LibraryRevision ( ) const

◆ ReadDetector() [1/2]

IFrameFStream::fr_detector_type FrameCPP::IFrameFStream::ReadDetector ( const std::string & Name)
inline

◆ ReadDetector() [2/2]

fr_detector_type FrameCPP::IFrameFStream::ReadDetector ( const std::string & Name)

◆ ReadFrAdcData() [1/2]

IFrameFStream::fr_adc_data_type FrameCPP::IFrameFStream::ReadFrAdcData ( INT_4U Frame,
const std::string & Channel )
inline

◆ ReadFrAdcData() [2/2]

fr_adc_data_type FrameCPP::IFrameFStream::ReadFrAdcData ( INT_4U Frame,
const std::string & Channel )

◆ ReadFrameN() [1/2]

IFrameFStream::frame_h_type FrameCPP::IFrameFStream::ReadFrameN ( INT_4U Index)
inline

◆ ReadFrameN() [2/2]

frame_h_type FrameCPP::IFrameFStream::ReadFrameN ( INT_4U Index)

◆ ReadFrameNSubset() [1/2]

IFrameFStream::frame_h_type FrameCPP::IFrameFStream::ReadFrameNSubset ( INT_4U Index,
INT_4U Elements )
inline

◆ ReadFrameNSubset() [2/2]

frame_h_type FrameCPP::IFrameFStream::ReadFrameNSubset ( INT_4U Index,
INT_4U Elements )

◆ ReadFrEvent() [1/4]

IFrameFStream::fr_event_type FrameCPP::IFrameFStream::ReadFrEvent ( const std::string & Channel,
fr_event_offset_type Offset )
inline

◆ ReadFrEvent() [2/4]

fr_event_type FrameCPP::IFrameFStream::ReadFrEvent ( const std::string & Channel,
fr_event_offset_type Offset )

◆ ReadFrEvent() [3/4]

IFrameFStream::fr_event_type FrameCPP::IFrameFStream::ReadFrEvent ( INT_4U Frame,
const std::string & Channel )
inline

◆ ReadFrEvent() [4/4]

fr_event_type FrameCPP::IFrameFStream::ReadFrEvent ( INT_4U Frame,
const std::string & Channel )

◆ ReadFrHistory() [1/2]

IFrameFStream::fr_history_type FrameCPP::IFrameFStream::ReadFrHistory ( INT_4U Frame)
inline

◆ ReadFrHistory() [2/2]

fr_history_type FrameCPP::IFrameFStream::ReadFrHistory ( INT_4U Frame)

◆ ReadFrProcData() [1/2]

IFrameFStream::fr_proc_data_type FrameCPP::IFrameFStream::ReadFrProcData ( INT_4U Frame,
const std::string & Channel )
inline

◆ ReadFrProcData() [2/2]

fr_proc_data_type FrameCPP::IFrameFStream::ReadFrProcData ( INT_4U Frame,
const std::string & Channel )

◆ ReadFrSerData() [1/2]

IFrameFStream::fr_ser_data_type FrameCPP::IFrameFStream::ReadFrSerData ( INT_4U Frame,
const std::string & Channel )
inline

◆ ReadFrSerData() [2/2]

fr_ser_data_type FrameCPP::IFrameFStream::ReadFrSerData ( INT_4U Frame,
const std::string & Channel )

◆ ReadFrSimData() [1/2]

IFrameFStream::fr_sim_data_type FrameCPP::IFrameFStream::ReadFrSimData ( INT_4U Frame,
const std::string & Channel )
inline

◆ ReadFrSimData() [2/2]

fr_sim_data_type FrameCPP::IFrameFStream::ReadFrSimData ( INT_4U Frame,
const std::string & Channel )

◆ ReadFrSimEvent() [1/4]

IFrameFStream::fr_sim_event_type FrameCPP::IFrameFStream::ReadFrSimEvent ( const std::string & Channel,
fr_sim_event_offset_type Offset )
inline

◆ ReadFrSimEvent() [2/4]

fr_sim_event_type FrameCPP::IFrameFStream::ReadFrSimEvent ( const std::string & Channel,
fr_sim_event_offset_type Offset )

◆ ReadFrSimEvent() [3/4]

IFrameFStream::fr_sim_event_type FrameCPP::IFrameFStream::ReadFrSimEvent ( INT_4U Frame,
const std::string & Channel )
inline

◆ ReadFrSimEvent() [4/4]

fr_sim_event_type FrameCPP::IFrameFStream::ReadFrSimEvent ( INT_4U Frame,
const std::string & Channel )

◆ ReadNextFrame() [1/2]

IFrameFStream::frame_h_type FrameCPP::IFrameFStream::ReadNextFrame ( )
inline

◆ ReadNextFrame() [2/2]

frame_h_type FrameCPP::IFrameFStream::ReadNextFrame ( )

◆ Version() [1/2]

IFrameFStream::version_type FrameCPP::IFrameFStream::Version ( ) const
inline

◆ Version() [2/2]

version_type FrameCPP::IFrameFStream::Version ( ) const

Member Data Documentation

◆ BUFFER_SIZE

static const int FrameCPP::IFrameFStream::BUFFER_SIZE = 1024 * 1024
static

◆ m_buffer

boost::shared_array< CHAR > FrameCPP::IFrameFStream::m_buffer
private

◆ m_filename

std::string FrameCPP::IFrameFStream::m_filename
private

◆ m_frame_buffer

std::unique_ptr< frame_buffer_type > FrameCPP::IFrameFStream::m_frame_buffer
private

◆ m_frame_stream

std::unique_ptr< frame_stream_type > FrameCPP::IFrameFStream::m_frame_stream
private

◆ m_toc

toc_type FrameCPP::IFrameFStream::m_toc
private

◆ MEMORY_MAPPED_IO

static const bool FrameCPP::IFrameFStream::MEMORY_MAPPED_IO = false
static

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