ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Common::FrameBufferInterface::Scanner Class Reference

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

#include <FrameBufferInterface.hh>

Inheritance diagram for FrameCPP::Common::FrameBufferInterface::Scanner:
Collaboration diagram for FrameCPP::Common::FrameBufferInterface::Scanner:

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
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

Public Member Functions

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

Private Attributes

boost::shared_ptr< FrHeaderfile_header
boost::shared_ptr< FrHeaderfile_header_base
bool frame_file_cached
FrameSpec::Infoframe_spec
boost::shared_ptr< FrameHframe_h
FrameSpec::Info::frame_object_types frame_h_id
const char * frame_h_name
boost::shared_ptr< FrEndOfFilefr_end_of_file
FrameSpec::Info::frame_object_types fr_end_of_file_id
const char * fr_end_of_file_name
boost::shared_ptr< FrSHfr_sh
boost::shared_ptr< StreamRefInterfacestream_ref
size_type next_block_size
size_type position
INT_2U frame_count
start_time_type start_time
start_time_type end_time

Static Private Attributes

static const size_type RESET_NEXT_BLOCK_SIZE

Detailed Description

Scan buffers conforming to the frame specification.

Member Typedef Documentation

◆ delta_t_type [1/2]

◆ delta_t_type [2/2]

◆ size_type [1/2]

type for number of bytes to read and size of buffer

◆ size_type [2/2]

type for number of bytes to read and size of buffer

◆ start_time_type [1/2]

◆ start_time_type [2/2]

Constructor & Destructor Documentation

◆ Scanner() [1/2]

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

Constructor.

◆ ~Scanner() [1/2]

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

Destructor.

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

◆ Scanner() [2/2]

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

Constructor.

◆ ~Scanner() [2/2]

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

Destructor.

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

Member Function Documentation

◆ DeltaT() [1/2]

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

Retrieve the duration of the stream.

◆ DeltaT() [2/2]

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

Retrieve the duration of the stream.

◆ NextBlock() [1/2]

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 >, and FrameCPP::Common::DynamicMemoryBufferT< BT >.

◆ NextBlock() [2/2]

virtual 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

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

◆ NextBlockSize() [1/2]

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

Return the number of bytes to be made available.

◆ NextBlockSize() [2/2]

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

Return the number of bytes to be made available.

◆ Position() [1/2]

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

Return the current position in the stream being scanned.

◆ Position() [2/2]

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

Return the current position in the stream being scanned.

◆ Ready() [1/2]

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

Check if a complete frame file is ready for processing.

◆ Ready() [2/2]

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

Check if a complete frame file is ready for processing.

◆ Reset() [1/2]

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

Initialize buffer to accumulate a frame file.

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

◆ Reset() [2/2]

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

Initialize buffer to accumulate a frame file.

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

◆ StartTime() [1/2]

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

Retrieve the start time of the stream.

◆ StartTime() [2/2]

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

Retrieve the start time of the stream.

Member Data Documentation

◆ end_time

start_time_type FrameCPP::Common::FrameBufferInterface::Scanner::end_time
private

◆ file_header

boost::shared_ptr< FrHeader > FrameCPP::Common::FrameBufferInterface::Scanner::file_header
private

◆ file_header_base

boost::shared_ptr< FrHeader > FrameCPP::Common::FrameBufferInterface::Scanner::file_header_base
private

◆ fr_end_of_file

boost::shared_ptr< FrEndOfFile > FrameCPP::Common::FrameBufferInterface::Scanner::fr_end_of_file
private

◆ fr_end_of_file_id

FrameSpec::Info::frame_object_types FrameCPP::Common::FrameBufferInterface::Scanner::fr_end_of_file_id
private

◆ fr_end_of_file_name

const char * FrameCPP::Common::FrameBufferInterface::Scanner::fr_end_of_file_name
private

◆ fr_sh

boost::shared_ptr< FrSH > FrameCPP::Common::FrameBufferInterface::Scanner::fr_sh
private

◆ frame_count

INT_2U FrameCPP::Common::FrameBufferInterface::Scanner::frame_count
private

◆ frame_file_cached

bool FrameCPP::Common::FrameBufferInterface::Scanner::frame_file_cached
private

◆ frame_h

boost::shared_ptr< FrameH > FrameCPP::Common::FrameBufferInterface::Scanner::frame_h
private

◆ frame_h_id

FrameSpec::Info::frame_object_types FrameCPP::Common::FrameBufferInterface::Scanner::frame_h_id
private

◆ frame_h_name

const char * FrameCPP::Common::FrameBufferInterface::Scanner::frame_h_name
private

◆ frame_spec

FrameSpec::Info * FrameCPP::Common::FrameBufferInterface::Scanner::frame_spec
private

◆ next_block_size

size_type FrameCPP::Common::FrameBufferInterface::Scanner::next_block_size
private

◆ position

size_type FrameCPP::Common::FrameBufferInterface::Scanner::position
private

◆ RESET_NEXT_BLOCK_SIZE

const size_type FrameCPP::Common::FrameBufferInterface::Scanner::RESET_NEXT_BLOCK_SIZE
staticprivate
Initial value:
=
FrHeader::SizeOf( )

◆ start_time

start_time_type FrameCPP::Common::FrameBufferInterface::Scanner::start_time
private

◆ stream_ref

boost::shared_ptr< StreamRefInterface > FrameCPP::Common::FrameBufferInterface::Scanner::stream_ref
private

The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Common/FrameBufferInterface.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/FrameBufferInterface.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/FrameBufferInterface.cc