ROSE  0.9.9.149
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Sawyer::Container::AllocatingBuffer< A, T > Class Template Reference

Description

template<class A, class T>
class Sawyer::Container::AllocatingBuffer< A, T >

Allocates memory as needed.

Allocates as many elements as requested and manages the storage. There is no requirement that the elements be contiguous in memory, although this implementation does it that way.

Definition at line 30 of file AllocatingBuffer.h.

#include <AllocatingBuffer.h>

Inheritance diagram for Sawyer::Container::AllocatingBuffer< A, T >:
Inheritance graph
[legend]
Collaboration diagram for Sawyer::Container::AllocatingBuffer< A, T >:
Collaboration graph
[legend]

Public Types

typedef A Address
 Type of addresses used to index the stored data. More...
 
typedef T Value
 Type of data that is stored. More...
 
typedef Buffer< A, T > Super
 Type of base class. More...
 
- Public Types inherited from Sawyer::Container::Buffer< A, T >
typedef SharedPointer< BufferPtr
 Reference counting smart pointer. More...
 
typedef A Address
 Key type for addressing data. More...
 
typedef T Value
 Type of values stored in the buffer. More...
 

Public Member Functions

Buffer< A, T >::Ptr copy () const
 Create a new copy of buffer data. More...
 
Address available (Address start) const
 Distance to end of buffer. More...
 
void resize (Address newSize)
 Change the size of the buffer. More...
 
Address read (Value *buf, Address address, Address n) const
 Reads data from a buffer. More...
 
Address write (const Value *buf, Address address, Address n)
 Writes data to a buffer. More...
 
const Valuedata () const
 Data for the buffer. More...
 
- Public Member Functions inherited from Sawyer::Container::Buffer< A, T >
virtual Address size () const
 Size of buffer. More...
 
virtual void sync ()
 Synchronize buffer with persistent storage. More...
 
const std::string & name () const
 Property: Name. More...
 
void name (const std::string &s)
 Property: Name. More...
 
bool copyOnWrite () const
 Property: Copy on write. More...
 
void copyOnWrite (bool b)
 Property: Copy on write. More...
 
- Public Member Functions inherited from Sawyer::SharedObject
 SharedObject ()
 Default constructor. More...
 
 SharedObject (const SharedObject &)
 Copy constructor. More...
 
virtual ~SharedObject ()
 Virtual destructor. More...
 
SharedObjectoperator= (const SharedObject &)
 Assignment. More...
 

Static Public Member Functions

static Buffer< A, T >::Ptr instance (Address size)
 Allocating constructor. More...
 
static Buffer< A, T >::Ptr instance (const std::string &s)
 Allocating constructor. More...
 

Protected Member Functions

 AllocatingBuffer (Address size=0)
 
- Protected Member Functions inherited from Sawyer::Container::Buffer< A, T >
 Buffer (const std::string &name="")
 

Member Typedef Documentation

template<class A , class T >
typedef A Sawyer::Container::AllocatingBuffer< A, T >::Address

Type of addresses used to index the stored data.

Definition at line 32 of file AllocatingBuffer.h.

template<class A , class T >
typedef T Sawyer::Container::AllocatingBuffer< A, T >::Value

Type of data that is stored.

Definition at line 33 of file AllocatingBuffer.h.

template<class A , class T >
typedef Buffer<A, T> Sawyer::Container::AllocatingBuffer< A, T >::Super

Type of base class.

Definition at line 34 of file AllocatingBuffer.h.

Member Function Documentation

template<class A , class T >
static Buffer<A, T>::Ptr Sawyer::Container::AllocatingBuffer< A, T >::instance ( Address  size)
inlinestatic

Allocating constructor.

Allocates a new buffer of the specified size. The values in the buffer are default-constructed, and deleted when this buffer is deleted.

Definition at line 60 of file AllocatingBuffer.h.

Referenced by Sawyer::Container::AllocatingBuffer< A, T >::copy(), Sawyer::Container::StaticBuffer< A, T >::copy(), and Sawyer::Container::MappedBuffer< A, T >::copy().

template<class A , class T >
static Buffer<A, T>::Ptr Sawyer::Container::AllocatingBuffer< A, T >::instance ( const std::string &  s)
inlinestatic

Allocating constructor.

Allocates a new buffer that points to a copy of the specified string.

Definition at line 67 of file AllocatingBuffer.h.

template<class A , class T >
Buffer<A, T>::Ptr Sawyer::Container::AllocatingBuffer< A, T >::copy ( ) const
inlinevirtual

Create a new copy of buffer data.

Returns a new buffer containing the same data as the old buffer. Some buffer types cannot make an exact copy, in which case they should return an AllocatingBuffer that holds a snapshot of the source buffer's data as it existed at the time of this operation.

Implements Sawyer::Container::Buffer< A, T >.

Definition at line 73 of file AllocatingBuffer.h.

References Sawyer::Container::AllocatingBuffer< A, T >::instance(), and Sawyer::Container::Buffer< A, T >::size().

template<class A , class T >
Address Sawyer::Container::AllocatingBuffer< A, T >::available ( Address  address) const
inlinevirtual

Distance to end of buffer.

The distance in units of the Value type from the specified address (inclusive) to the last element of the buffer (inclusive). If the address is beyond the end of the buffer then a distance of zero is returned rather than a negative distance. Note that the return value will overflow to zero if the buffer spans the entire address space.

Implements Sawyer::Container::Buffer< A, T >.

Definition at line 85 of file AllocatingBuffer.h.

Referenced by Sawyer::Container::AllocatingBuffer< A, T >::read(), and Sawyer::Container::AllocatingBuffer< A, T >::write().

template<class A , class T >
void Sawyer::Container::AllocatingBuffer< A, T >::resize ( Address  n)
inlinevirtual

Change the size of the buffer.

Truncates the buffer to a smaller size, or extends the buffer as necessary to make its size n values.

Implements Sawyer::Container::Buffer< A, T >.

Definition at line 89 of file AllocatingBuffer.h.

template<class A , class T >
Address Sawyer::Container::AllocatingBuffer< A, T >::read ( Value buf,
Address  address,
Address  n 
) const
inlinevirtual

Reads data from a buffer.

Reads up to n values from this buffer beginning at the specified address and copies them to the caller-supplied argument. Returns the number of values actually copied, which may be smaller than the number requested. The output buffer is not zero-padded for short reads. Also note that the return value may overflow to zero if the entire address space is read.

As a special case, if buf is a null pointer, then no data is copied and the return value indicates the number of values that would have been copied had buf been non-null.

Implements Sawyer::Container::Buffer< A, T >.

Definition at line 93 of file AllocatingBuffer.h.

References Sawyer::Container::AllocatingBuffer< A, T >::available().

template<class A , class T >
Address Sawyer::Container::AllocatingBuffer< A, T >::write ( const Value buf,
Address  address,
Address  n 
)
inlinevirtual

Writes data to a buffer.

Writes up to n values from buf into this buffer starting at the specified address. Returns the number of values actually written, which might be smaller than n. The return value will be less than n if an error occurs, but note that the return value may overflow to zero if the entire address space is written.

Implements Sawyer::Container::Buffer< A, T >.

Definition at line 100 of file AllocatingBuffer.h.

References Sawyer::Container::AllocatingBuffer< A, T >::available().

template<class A , class T >
const Value* Sawyer::Container::AllocatingBuffer< A, T >::data ( ) const
inlinevirtual

Data for the buffer.

Returns a pointer for the buffer data. Those subclasses that don't support this method will return the null pointer.

Implements Sawyer::Container::Buffer< A, T >.

Definition at line 107 of file AllocatingBuffer.h.


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