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

#include <ROMemoryBuffer.hh>

Inherits streambuf, streambuf, streambuf, and streambuf.

Public Member Functions
	ROMemoryStreamBuf ()
	Default constructor. More...

	ROMemoryStreamBuf ()
	Default constructor. More...

	ROMemoryStreamBuf ()
	Default constructor. More...

	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_type *	setbuf (char_type *S, std::streamsize N)
	Provides the section of memory from which to read. More...

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_type *	setbuf (char_type *S, std::streamsize N)
	Provides the section of memory from which to read. More...

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_type *	setbuf (char_type *S, std::streamsize N)
	Provides the section of memory from which to read. More...

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_type *	setbuf (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.

Constructor & Destructor Documentation

◆ ROMemoryStreamBuf() [1/4]

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

Default constructor.

The default constructor manages a zero length buffer.

See also: setbuf

◆ ROMemoryStreamBuf() [2/4]

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

Default constructor.

See also: setbuf

◆ ROMemoryStreamBuf() [3/4]

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

Default constructor.

See also: setbuf

◆ ROMemoryStreamBuf() [4/4]

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

Default constructor.

See also: setbuf

Member Function Documentation

◆ seekoff() [1/4]

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] Off Relative position to set the position indicator to.

[in]

Way

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

Which

Defines 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/4]

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] Off Relative position to set the position indicator to.

[in]

Way

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

Which

Defines 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/4]

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] Off Relative position to set the position indicator to.

[in]

Way

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

Which

Defines 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() [4/4]

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] Off Relative position to set the position indicator to.

[in]

Way

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

Which

Defines 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/4]

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] Pos Absolute position to set the position indicator to.

[in]

Which

Defines 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/4]

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] Pos Absolute position to set the position indicator to.

[in]

Which

Defines 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/4]

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] Pos Absolute position to set the position indicator to.

[in]

Which

Defines 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() [4/4]

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] Pos Absolute position to set the position indicator to.

[in]

Which

Defines 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/4]

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]	S	Starting address of memory to manage as input buffer.
[in]	N	Size of memory buffer.

Returns: Returns this.

◆ setbuf() [2/4]

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]	S	Starting address of memory to manage as input buffer.
[in]	N	Size of memory buffer.

Returns: Returns this.

◆ setbuf() [3/4]

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]	S	Starting address of memory to manage as input buffer.
[in]	N	Size of memory buffer.

Returns: Returns this.

◆ setbuf() [4/4]

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]	S	Starting address of memory to manage as input buffer.
[in]	N	Size of memory buffer.

Returns: Returns this.

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

/build/ldas-tools-framecpp-2.7.0/debian/tmp/usr/include/framecpp/Common/BaseMemoryBuffer.hh
/build/ldas-tools-framecpp-2.7.0/src/Common/ROMemoryBuffer.hh
/build/ldas-tools-framecpp-2.7.0/src/Common/BaseMemoryBuffer.cc
/build/ldas-tools-framecpp-2.7.0/src/Common/ROMemoryBuffer.cc

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ROMemoryStreamBuf() [1/4]

◆ ROMemoryStreamBuf() [2/4]

◆ ROMemoryStreamBuf() [3/4]

◆ ROMemoryStreamBuf() [4/4]

Member Function Documentation

◆ seekoff() [1/4]

◆ seekoff() [2/4]

◆ seekoff() [3/4]

◆ seekoff() [4/4]

◆ seekpos() [1/4]

◆ seekpos() [2/4]

◆ seekpos() [3/4]

◆ seekpos() [4/4]

◆ setbuf() [1/4]

◆ setbuf() [2/4]

◆ setbuf() [3/4]

◆ setbuf() [4/4]