ldas-tools-framecpp  2.6.4
Public Types | Public Member Functions | List of all members
FrameCPP::Common::FrameBufferInterface::Scanner Class Reference

Scan buffers conforming to the frame specification. More...

#include <FrameBufferInterface.hh>

Inheritance diagram for FrameCPP::Common::FrameBufferInterface::Scanner:
FrameCPP::Common::DynamicMemoryBufferT< BT >

Public Types

typedef start_time_normalized_type start_time_type
 
typedef delta_t_normalized_type delta_t_type
 
typedef INT_8U size_type
 type for number of bytes to read and size of buffer More...
 

Public Member Functions

 Scanner ()
 Constructor. More...
 
virtual ~Scanner ()
 Destructor. More...
 
delta_t_type DeltaT () const
 Retrieve the duration of the stream. More...
 
virtual void NextBlock (const char *Buffer, size_type Size)
 Add a buffer to the frame file memory image. More...
 
size_type NextBlockSize () const
 Return the number of bytes to be made available. More...
 
size_type Position () const
 Return the current position in the stream being scanned. More...
 
bool Ready () const
 Check if a complete frame file is ready for processing. More...
 
virtual void Reset ()
 Initialize buffer to accumulate a frame file. More...
 
start_time_type StartTime () const
 Retrieve the start time of the stream. More...
 

Detailed Description

Scan buffers conforming to the frame specification.

Member Typedef Documentation

◆ delta_t_type

◆ size_type

type for number of bytes to read and size of buffer

◆ start_time_type

Constructor & Destructor Documentation

◆ Scanner()

FrameCPP::Common::FrameBufferInterface::Scanner::Scanner ( )

Constructor.

◆ ~Scanner()

FrameCPP::Common::FrameBufferInterface::Scanner::~Scanner ( )
inlinevirtual

Destructor.

Note
Need to have an explicit destructor since there are virtual functions.

Member Function Documentation

◆ DeltaT()

FrameBufferInterface::Scanner::delta_t_type FrameCPP::Common::FrameBufferInterface::Scanner::DeltaT ( ) const
inline

Retrieve the duration of the stream.

◆ NextBlock()

void FrameCPP::Common::FrameBufferInterface::Scanner::NextBlock ( const char *  Buffer,
size_type  Size 
)
virtual

Add a buffer to the frame file memory image.

Parameters
[in]BufferThe buffer to scan
[in]SizeThe number of bytes in Buffer
Todo:
Instead of just bailing when failing to read the buffer, need to see if the buffer contains some subset of the ORIGINATOR string so as to allow resyncing to happen

Reimplemented in FrameCPP::Common::DynamicMemoryBufferT< BT >.

◆ NextBlockSize()

FrameBufferInterface::Scanner::size_type FrameCPP::Common::FrameBufferInterface::Scanner::NextBlockSize ( ) const
inline

Return the number of bytes to be made available.

◆ Position()

FrameBufferInterface::Scanner::size_type FrameCPP::Common::FrameBufferInterface::Scanner::Position ( ) const
inline

Return the current position in the stream being scanned.

◆ Ready()

bool FrameCPP::Common::FrameBufferInterface::Scanner::Ready ( ) const
inline

Check if a complete frame file is ready for processing.

◆ Reset()

void FrameCPP::Common::FrameBufferInterface::Scanner::Reset ( )
virtual

Initialize buffer to accumulate a frame file.

Reimplemented in FrameCPP::Common::DynamicMemoryBufferT< BT >.

◆ StartTime()

FrameBufferInterface::Scanner::start_time_type FrameCPP::Common::FrameBufferInterface::Scanner::StartTime ( ) const
inline

Retrieve the start time of the stream.


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