ldas-tools-framecpp  2.5.8
Public Types | Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Common::ROMemoryStreamBuf Class Reference

Handles a read-only memory stream. More...

#include <BaseMemoryBuffer.hh>

Inheritance diagram for FrameCPP::Common::ROMemoryStreamBuf:

Public Types

typedef std::streambuf buffer_type
 
typedef buffer_type::char_type char_type
 
typedef buffer_type::pos_type pos_type
 
typedef buffer_type::off_type off_type
 
typedef buffer_type::pos_type size_type
 
typedef buffer_type::int_type int_type
 

Public Member Functions

 ROMemoryStreamBuf ()
 Default constructor. More...
 

Protected Member Functions

virtual pos_type seekpos (pos_type Pos, std::ios_base::openmode Which)
 Repositions the next pointer in the input sequence. More...
 
virtual pos_type seekoff (off_type Off, std::ios_base::seekdir Way, std::ios_base::openmode Which)
 Repositions the next pointer in the input sequence. More...
 
virtual buffer_typesetbuf (char_type *S, std::streamsize N)
 Provides the section of memory from which to read. More...
 

Detailed Description

Handles a read-only memory stream.

This class is to be used with an IFrameStream to provide a mechanism to read frames that are currently in memory.

Member Typedef Documentation

◆ buffer_type

◆ char_type

typedef buffer_type::char_type FrameCPP::Common::ROMemoryStreamBuf::char_type

◆ int_type

typedef buffer_type::int_type FrameCPP::Common::ROMemoryStreamBuf::int_type

◆ off_type

typedef buffer_type::off_type FrameCPP::Common::ROMemoryStreamBuf::off_type

◆ pos_type

typedef buffer_type::pos_type FrameCPP::Common::ROMemoryStreamBuf::pos_type

◆ size_type

typedef buffer_type::pos_type FrameCPP::Common::ROMemoryStreamBuf::size_type

Constructor & Destructor Documentation

◆ ROMemoryStreamBuf()

FrameCPP::Common::ROMemoryStreamBuf::ROMemoryStreamBuf ( )

Default constructor.

The default constructor manages a zero length buffer.

See also
setbuf

Member Function Documentation

◆ seekoff()

ROMemoryStreamBuf::pos_type FrameCPP::Common::ROMemoryStreamBuf::seekoff ( off_type  Off,
std::ios_base::seekdir  Way,
std::ios_base::openmode  Which 
)
protectedvirtual

Repositions the next pointer in the input sequence.

Parameters
[in]OffRelative position to set the position indicator to.
[in]WayDefines base position to apply relative offset to. It can be one of the following constants:
Constant Explanation
beg The beginning of the stream
end The ending of the stream
cur The current position of the stream
[in]WhichDefines which of the input sequences to affect. It can be one or a combination of the following constants:
Constant Explanation
in Affect the input sequence
out Affect the output sequence
Returns
The resulting absolute position as defined by the position indicator.

◆ seekpos()

ROMemoryStreamBuf::pos_type FrameCPP::Common::ROMemoryStreamBuf::seekpos ( pos_type  Pos,
std::ios_base::openmode  Which 
)
protectedvirtual

Repositions the next pointer in the input sequence.

Parameters
[in]PosAbsolute position to set the position indicator to.
[in]WhichDefines which of the input sequences to affect. It can be one or a combination of the following constants:
Constant Explanation
in Affect the input sequence
out Affect the output sequence
Returns
The resulting absolute position as defined by the position indicator.

◆ setbuf()

ROMemoryStreamBuf::buffer_type * FrameCPP::Common::ROMemoryStreamBuf::setbuf ( char_type S,
std::streamsize  N 
)
protectedvirtual

Provides the section of memory from which to read.

Parameters
[in]SStarting address of memory to manage as input buffer.
[in]NSize of memory buffer.
Returns
Returns this.

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