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

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

#include <ROMemoryBuffer.hh>

Public Member Functions

 ROMemoryStreamBuf ()
 Default constructor.
 
 ROMemoryStreamBuf ()
 Default constructor.
 
 ROMemoryStreamBuf ()
 Default constructor.
 

Protected Member Functions

virtual pos_type seekpos (pos_type Pos, std::ios_base::openmode Which)
 Repositions the next pointer in the input sequence.
 
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.
 
virtual buffer_type * setbuf (char_type *S, std::streamsize N)
 Provides the section of memory from which to read.
 
virtual pos_type seekpos (pos_type Pos, std::ios_base::openmode Which)
 Repositions the next pointer in the input sequence.
 
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.
 
virtual buffer_type * setbuf (char_type *S, std::streamsize N)
 Provides the section of memory from which to read.
 
virtual pos_type seekpos (pos_type Pos, std::ios_base::openmode Which)
 Repositions the next pointer in the input sequence.
 
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.
 
virtual buffer_type * setbuf (char_type *S, std::streamsize N)
 Provides the section of memory from which to read.
 

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.

Constructor & Destructor Documentation

◆ ROMemoryStreamBuf() [1/3]

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

Default constructor.

The default constructor manages a zero length buffer.

See also
setbuf

◆ ROMemoryStreamBuf() [2/3]

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

Default constructor.

See also
setbuf

◆ ROMemoryStreamBuf() [3/3]

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

Default constructor.

See also
setbuf

Member Function Documentation

◆ seekoff() [1/3]

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.

◆ seekoff() [2/3]

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

◆ seekoff() [3/3]

virtual 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() [1/3]

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.

◆ seekpos() [2/3]

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

◆ seekpos() [3/3]

virtual 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() [1/3]

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.

◆ setbuf() [2/3]

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

◆ setbuf() [3/3]

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