Developer Documentation
Centre for Vision, Speech & Signal Processing
USER IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
BufferAccessC::BufferAccessC(DataC *)
BufferAccessC::BufferAccessC(const BufferAccessC &)
BufferAccessC::operator=(DataC *)
BufferAccessC::operator=(const BufferAccessC &)
BufferAccessC::operator[](const IndexT) const
BufferAccessC::operator[](const IndexT)
BufferAccessC::ReferenceElm(void) const
BufferAccessC::ReferenceVoid(void) const
BufferAccessC::Access(void) const
BufferAccessC::IsValid(void) const
BufferAccessC::Swap(BufferAccessC &)
BufferAccessC::operator++(void)
BufferAccessC::operator++(int)
BufferAccessC::operator--(void)
BufferAccessC::operator--(int)
BufferAccessC::operator+=(const IndexT)
BufferAccessC::operator-=(const IndexT)
BufferAccessC::operator+(const IndexT) const
BufferAccessC::operator-(const IndexT) const
BufferAccessC::NCAccess(void)
BufferAccessC<class DataC>
 
Basic access to buffer
 
include "amma/BfAccess.hh"
User Level:Default
Library:Mbuff
Example:exBRefC.cc
Section:Containers.Arrays.Buffer
In Scope:std

Comments:
The class BufferAccessC enables to random indexed access to a sequentially organised continous part of memory called buffer. The access functions do not perform any checks if an accessed element is valid.

Derived Classes: Variables:
DataC * buff;
The pointer to the reference element of the buffer.

Methods:
BufferAccessC(DataC * bp = 0)
Creates an access to a buffer pointed by the pointer 'bp'. If 'bp' is 0, the access is not valid.

BufferAccessC(const BufferAccessC<DataC> & ba)
Creates a physical copy of the access 'ba'.

const BufferAccessC<DataC> & operator=(DataC * bp)
Changes the reference element to the element pointed by 'bp'.

const BufferAccessC<DataC> & operator=(const BufferAccessC<DataC> & bp)
Changes the reference element to the element pointed by 'bp'. Access methods --------------

const DataC & operator[](const IndexT i) const
Read-only access to the ('i'+1)-th element of the buffer.

DataC & operator[](const IndexT i)
Read-write access to the ('i'+1)-th element of the buffer.

DataC * ReferenceElm(void) const
Returns the pointer to the reference element of the attached buffer. The reference element need not to be the valid element of the buffer.

void * ReferenceVoid(void) const
Returns the pointer to the reference element of the attached buffer. The reference element need not to be the valid element of the buffer. The function is intended to be used in printing.

const BufferAccessC<DataC> & Access(void) const
Returns this object. Logical functions -----------------

BooleanT IsValid() const
Returns TRUE if this buffer access is not a default access object. Object modifications --------------------

const BufferAccessC<DataC> & Swap(BufferAccessC<DataC> & a)
Reference elements of both buffer accesses are mutually exchanged. The return value is this object.

BufferAccessC<DataC> & operator++()
Shifts the reference element one position to the right (towards the next element) - post-fix notation.

BufferAccessC<DataC> & operator++(int)
Shifts the reference element one position to the right (towards the next element) - pre-fix notation.

BufferAccessC<DataC> & operator--()
Shifts the reference element one position to the left (towards the previous element) - post-fix notation.

BufferAccessC<DataC> & operator--(int)
Shifts the reference element one position to the left (towards the previous element) - pre-fix notation.

const BufferAccessC<DataC> & operator+=(const IndexT i)
Shifts the reference element 'i' positions to the right (towards next elements).

const BufferAccessC<DataC> & operator-=(const IndexT i)
Shifts the reference element 'i' positions to the left (towards previous elements).

BufferAccessC<DataC> operator+(const IndexT i) const
Creates the new access object with the reference element shifted 'i' positions to the right (towards next elements).

BufferAccessC<DataC> operator-(const IndexT i) const
Creates the new access object with the reference element shifted 'i' positions to the left (towards previous elements).

BufferAccessC<DataC> & NCAccess()
Returns this access.


Programmer:Radek Marik, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001