cphot 0.1
A C++ tool for computing photometry from spectra.
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
GenericMemoryBuffer< Allocator > Struct Template Reference

Represents an in-memory output byte stream. More...

#include <fwd.h>

Public Types

typedef char Ch
 

Public Member Functions

 GenericMemoryBuffer (Allocator *allocator=0, size_t capacity=kDefaultCapacity)
 
void Put (Ch c)
 
void Flush ()
 
void Clear ()
 
void ShrinkToFit ()
 
Ch * Push (size_t count)
 
void Pop (size_t count)
 
const Ch * GetBuffer () const
 
size_t GetSize () const
 

Public Attributes

internal::Stack< Allocator > stack_
 

Static Public Attributes

static const size_t kDefaultCapacity = 256
 

Detailed Description

template<typename Allocator = CrtAllocator>
struct GenericMemoryBuffer< Allocator >

Represents an in-memory output byte stream.

This class is mainly for being wrapped by EncodedOutputStream or AutoUTFOutputStream.

It is similar to FileWriteBuffer but the destination is an in-memory buffer instead of a file.

Differences between MemoryBuffer and StringBuffer:

  1. StringBuffer has Encoding but MemoryBuffer is only a byte buffer.
  2. StringBuffer::GetString() returns a null-terminated string. MemoryBuffer::GetBuffer() returns a buffer without terminator.
Template Parameters
Allocatortype for allocating memory buffer.
Note
implements Stream concept

Definition at line 74 of file fwd.h.

Member Typedef Documentation

◆ Ch

template<typename Allocator = CrtAllocator>
typedef char GenericMemoryBuffer< Allocator >::Ch

Definition at line 38 of file memorybuffer.h.

Constructor & Destructor Documentation

◆ GenericMemoryBuffer()

template<typename Allocator = CrtAllocator>
GenericMemoryBuffer< Allocator >::GenericMemoryBuffer ( Allocator *  allocator = 0,
size_t  capacity = kDefaultCapacity 
)
inline

Definition at line 40 of file memorybuffer.h.

Member Function Documentation

◆ Clear()

template<typename Allocator = CrtAllocator>
void GenericMemoryBuffer< Allocator >::Clear ( )
inline

Definition at line 45 of file memorybuffer.h.

◆ Flush()

template<typename Allocator = CrtAllocator>
void GenericMemoryBuffer< Allocator >::Flush ( )
inline

Definition at line 43 of file memorybuffer.h.

◆ GetBuffer()

template<typename Allocator = CrtAllocator>
const Ch* GenericMemoryBuffer< Allocator >::GetBuffer ( ) const
inline

Definition at line 50 of file memorybuffer.h.

◆ GetSize()

template<typename Allocator = CrtAllocator>
size_t GenericMemoryBuffer< Allocator >::GetSize ( ) const
inline

Definition at line 54 of file memorybuffer.h.

◆ Pop()

template<typename Allocator = CrtAllocator>
void GenericMemoryBuffer< Allocator >::Pop ( size_t  count)
inline

Definition at line 48 of file memorybuffer.h.

◆ Push()

template<typename Allocator = CrtAllocator>
Ch* GenericMemoryBuffer< Allocator >::Push ( size_t  count)
inline

Definition at line 47 of file memorybuffer.h.

◆ Put()

template<typename Allocator = CrtAllocator>
void GenericMemoryBuffer< Allocator >::Put ( Ch  c)
inline

Definition at line 42 of file memorybuffer.h.

◆ ShrinkToFit()

template<typename Allocator = CrtAllocator>
void GenericMemoryBuffer< Allocator >::ShrinkToFit ( )
inline

Definition at line 46 of file memorybuffer.h.

Member Data Documentation

◆ kDefaultCapacity

template<typename Allocator = CrtAllocator>
const size_t GenericMemoryBuffer< Allocator >::kDefaultCapacity = 256
static

Definition at line 56 of file memorybuffer.h.

◆ stack_

template<typename Allocator = CrtAllocator>
internal::Stack<Allocator> GenericMemoryBuffer< Allocator >::stack_
mutable

Definition at line 57 of file memorybuffer.h.

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