ldas-tools-framecpp  2.6.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Attributes | List of all members
FrameCPP::IFrameFStream Class Reference

#include <IFrameStream.hh>

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
}
 
typedef
FrameCPP::FrameH::history_type 
fr_history_type
 
typedef
Common::IFrameStream::frame_library_type 
frame_library_type
 
typedef
Common::IFrameStream::library_revision_type 
library_revision_type
 
typedef
Common::IFrameStream::size_type 
size_type
 
typedef
Common::IFrameStream::version_type 
version_type
 
typedef boost::shared_ptr< FrameHframe_h_type
 
typedef boost::shared_ptr
< FrDetector
fr_detector_type
 
typedef boost::shared_ptr
< FrEvent
fr_event_type
 
typedef INT_4U fr_event_offset_type
 
typedef boost::shared_ptr
< FrAdcData
fr_adc_data_type
 
typedef boost::shared_ptr
< FrProcData
fr_proc_data_type
 
typedef boost::shared_ptr
< FrSerData
fr_ser_data_type
 
typedef boost::shared_ptr
< FrSimData
fr_sim_data_type
 
typedef boost::shared_ptr
< FrSimEvent
fr_sim_event_type
 
typedef INT_4U fr_sim_event_offset_type
 

Public Member Functions

 IFrameFStream (const char *Filename)
 Constructor. More...
 
 IFrameFStream (const char *Filename, bool MemoryMappedIO, size_t BufferSize)
 Constructor. More...
 
std::string Filename () const
 
frame_library_type FrameLibrary () const
 
std::string FrameLibraryName () const
 
size_type GetNumberOfFrames () const
 
const FrTOCGetTOC () const
 
library_revision_type LibraryRevision () const
 
fr_detector_type ReadDetector (const std::string &Name)
 
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_history_type ReadFrHistory (INT_4U Frame)
 
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_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)
 
frame_h_type ReadFrameN (INT_4U Index)
 
frame_h_type ReadFrameNSubset (INT_4U Index, INT_4U Elements)
 
frame_h_type ReadNextFrame ()
 
version_type Version () const
 

Static Public Attributes

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

Member Typedef Documentation

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

Member Enumeration Documentation

Enumerator
HISTORY 
DETECT_SIM 
DETECT_PROC 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 

Constructor & Destructor Documentation

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

Constructor.

Parameters
[in]FilenameName of the input frame file
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.

Member Function Documentation

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

Member Data Documentation

const int FrameCPP::IFrameFStream::BUFFER_SIZE = 1024 * 1024
static
const bool FrameCPP::IFrameFStream::MEMORY_MAPPED_IO = false
static

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