UOListStreamAllocator Class Reference

An stream/stream-buffer allocator for external buffers. More...

Inheritance diagram for UOListStreamAllocator:

Collaboration diagram for UOListStreamAllocator:

Public Member Functions
const UList< char >	list () const
	Const UList access to the characters written (shallow copy). More...
UList< char >	list ()
	Non-const UList access to the characters written (shallow copy). More...
label	capacity () const
	The current list output capacity. More...
label	size () const
void	rewind ()
	Move to buffer start, clear errors. More...

Protected Types
typedef std::ostream	stream_type

Protected Member Functions
	UOListStreamAllocator (char *buffer, size_t nbytes)
	Construct for character array and number of bytes. More...
void	printBufInfo (Ostream &os) const

Protected Attributes
memorybuf::out	buf_
	The stream buffer. More...
stream_type	stream_
	The stream. More...

Detailed Description

An stream/stream-buffer allocator for external buffers.

Definition at line 102 of file UOListStream.H.

Member Typedef Documentation

stream_type

typedef std::ostream stream_type

protected

Definition at line 108 of file UOListStream.H.

Constructor & Destructor Documentation

UOListStreamAllocator()

UOListStreamAllocator ( char *  buffer, size_t  nbytes  )

inlineprotected

Construct for character array and number of bytes.

Definition at line 120 of file UOListStream.H.

Member Function Documentation

printBufInfo()

void printBufInfo ( Ostream &  os ) const

inlineprotected

Definition at line 126 of file UOListStream.H.

References UOListStreamAllocator::buf_, os(), and memorybuf::out::printBufInfo().

Here is the call graph for this function:

list() [1/2]

const UList< char > list ( ) const

inline

Const UList access to the characters written (shallow copy).

Definition at line 136 of file UOListStream.H.

References UOListStreamAllocator::buf_, and memorybuf::out::list().

Here is the call graph for this function:

list() [2/2]

UList< char > list ( )

inline

Non-const UList access to the characters written (shallow copy).

Definition at line 142 of file UOListStream.H.

References UOListStreamAllocator::buf_, and memorybuf::out::list().

Here is the call graph for this function:

capacity()

label capacity ( ) const

inline

The current list output capacity.

Definition at line 148 of file UOListStream.H.

References UOListStreamAllocator::buf_, and memorybuf::out::capacity().

Here is the call graph for this function:

size()

label size ( ) const

inline

The current output position in the buffer, which is also the addressed list size

Definition at line 155 of file UOListStream.H.

References UOListStreamAllocator::buf_, and memorybuf::out::tellp().

Here is the call graph for this function:

rewind()

void rewind ( )

inline

Move to buffer start, clear errors.

Definition at line 161 of file UOListStream.H.

References UOListStreamAllocator::buf_, and UOListStreamAllocator::stream_.

Referenced by UOListStream::rewind().

Here is the caller graph for this function:

Member Data Documentation

buf_

memorybuf::out buf_

protected

The stream buffer.

Definition at line 111 of file UOListStream.H.

Referenced by UOListStreamAllocator::capacity(), UOListStreamAllocator::list(), UOListStreamAllocator::printBufInfo(), UOListStreamAllocator::rewind(), and UOListStreamAllocator::size().

stream_

stream_type stream_

protected

The stream.

Definition at line 114 of file UOListStream.H.

Referenced by UOListStreamAllocator::rewind().

---

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

• src/OpenFOAM/db/IOstreams/memory/UOListStream.H