Buffer3dBodyC<class DataT>

Developer Documentation

RAVL, Recognition And Vision Library

USER

Ravl - Core - Arrays - Buffer - Buffer3dBodyC<class DataT>

Buffer3dBodyC<class DataT>

Buffer2D

include	"Ravl/Buffer3d.hh"
Source file:	Ravl/Core/Container/Buffer/Buffer3d.hh
User Level:	Develop
Library:	RavlCore
In Scope:	RavlN

Comments:
This holds a handle to data used in various 3d arrays.

Parent Classes:

BufferBodyC

BufferAccessC

Variables:

BufferC> dataIndex;
BufferC data;
SizeT size2;
SizeT size3;

Methods:

Buffer3dBodyC(): Default constructor.
Buffer3dBodyC(SizeT nsize1,SizeT nsize2,SizeT nsize3): Sized constructor.
Buffer3dBodyC(const BufferC<DataT> & dat,const BufferC<BufferAccess2dC<DataT>> & buf,IndexRangeC nrng2,IndexRangeC nrng3): Buffer constructor.
Buffer3dBodyC(const BufferC<DataT> & dat,SizeT nrng1,SizeT nrng2,SizeT nrng3): Buffer constructor.
BufferC<DataT> & Data(): Access data buffer.
const BufferC<DataT> & Data() const: Access data buffer.
BufferC<BufferAccessC<DataT>> & DataIndex(): Access data buffer.
const BufferC<BufferAccessC<DataT>> & DataIndex() const: Access data buffer.
SizeT Size1() const: Get size of dimention 1
SizeT Size2() const: Get size of dimention 2
SizeT Size3() const: Get size of dimention 3

#include "Ravl/RCHandleV.hh"

bool Save(ostream & out) const: Save to stream 'out'.
bool Save(BinOStreamC & out) const: Save to binary stream 'out'.
RCBodyVC & Copy() const: Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.
RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const: Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

#include "Ravl/SBfAcc.hh"

const SizeBufferAccessC<BufferAccessC<BufferAccessC<DataT>>> & operator =(BufferAccessC<BufferAccessC<DataT>> * bp): Changes the reference element to the element pointed by 'bp'. Access to the object --------------------
BufferAccessC<BufferAccessC<DataT>> * DataStart() const: Returns the address of the first element of the buffer.
SizeT Size() const: Returns the number of elements of the array.
IndexRangeC Limits() const: Returns the usable range of indeces expressed by this object.
IndexRangeC Range() const: Returns the usable range of indeces expressed by this object.
IndexC IMin() const: Returns the minimum index of the range of this access.
IndexC IMax() const: Returns the maximum index of the range of this access.
const BufferAccessC<BufferAccessC<DataT>> & operator [](const IndexC i) const: Read-only access to the ('i'+1)-th element of the buffer.
BufferAccessC<BufferAccessC<DataT>> & operator [](const IndexC i): Read-write access to the ('i'+1)-th element of the buffer.
const SizeBufferAccessC<BufferAccessC<BufferAccessC<DataT>>> & SAccess(void) const: Returns this object. Logical functions -----------------
bool IsEmpty() const: Returns TRUE if the size of the array is zero.
bool Contains(IndexC i) const: Returns TRUE if the array contains an item with the index 'i'. Modifications of the access ---------------------------
SizeT ShrinkHigh(SizeT k): Changes the number of elements by subtracting the last 'k' elements.
const SizeBufferAccessC<BufferAccessC<BufferAccessC<DataT>>> & Swap(SizeBufferAccessC<BufferAccessC<BufferAccessC<DataT>>> & a): Exchanges the contents of this buffer with buffer 'a'.
void Attach(const SizeBufferAccessC<BufferAccessC<BufferAccessC<DataT>>> & b): Changes this buffer access to have the same access rights as 'b'.
void Attach(const BufferAccessC<BufferAccessC<BufferAccessC<DataT>>> & b,SizeT size): Changes this buffer access to have the access rights as 'b' limited for 'size' elements.
SizeBufferAccessC<BufferAccessC<BufferAccessC<DataT>>> operator +(SizeT i) const: Creates the new access object shifted 'i' elements to the right (towards next elements). The size is descreased to fit the the original range of this access. Modifications of the buffer contents ------------------------------------
void Fill(const BufferAccessC<BufferAccessC<DataT>> & d): 'd' value is assigned to all elements of the buffer.
void CopyFrom(const SizeBufferAccessC<BufferAccessC<BufferAccessC<DataT>>> & oth): Copy contents of another buffer into this one.
NB. Buffers MUST be the same length.
void Reverse(): Reverse the order of elements in this array in place.
SizeBufferAccessC<BufferAccessC<BufferAccessC<DataT>>> BufferFrom(UIntT first): Get an access for this buffer starting from the 'first' element to the end of the buffer.
SizeBufferAccessC<BufferAccessC<BufferAccessC<DataT>>> BufferFrom(UIntT first,UIntT len): Get an access for this buffer starting from the 'first' element for 'len' elements.
An error will be generated if the requested buffer isn't contains within this one.
bool operator ==(const SizeBufferAccessC<BufferAccessC<BufferAccessC<DataT>>> & ba) const: Are two accesses the same ?
SizeBufferAccessC<BufferAccessC<BufferAccessC<DataT>>> Copy(void) const: Returns a physical copy of this access pointing to the physical copy of the accessed buffer in the range accessible by this access. The new copy is necessary to attach to reference counted buffer or to delete at the end of the life of this object.

#include "Ravl/RefCounter.hh"

UIntT References() const: Access count of handles open to this object.
RCBodyC & Copy() const: Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.
RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const: Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.
void IncRefCounter(): Increment reference counter.
bool DecRefCounter(): Decrement reference counter.

#include "Ravl/BufferAccess.hh"

BufferAccessC<BufferAccessC<DataT>> * ReferenceElm() 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() 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.
bool IsValid() const: Returns TRUE if this buffer access is not a default access object.
const BufferAccessC<BufferAccessC<DataT>> & operator [](const IndexC i) const: Read-only access to the ('i'+1)-th element of the buffer.
BufferAccessC<BufferAccessC<DataT>> & operator [](const IndexC i): Read-write access to the ('i'+1)-th element of the buffer.
const BufferAccessC<BufferAccessC<BufferAccessC<DataT>>> & operator +=(IndexC ind): Inplace Add index to start position.
const BufferAccessC<BufferAccessC<BufferAccessC<DataT>>> & operator -=(IndexC ind): Inplace Subtract index from start position.
BufferAccessC<BufferAccessC<BufferAccessC<DataT>>> operator -(IndexC ind) const: Substract value from position, and return it as a new value.
BufferAccessC<BufferAccessC<BufferAccessC<DataT>>> operator +(IndexC ind) const: Substract value from position, and return it as a new value.
bool operator ==(const BufferAccessC<BufferAccessC<BufferAccessC<DataT>>> & ba) const: Are two accesses the same ?
bool operator !=(const BufferAccessC<BufferAccessC<BufferAccessC<DataT>>> & ba) const: Are two accesses the same ?

Maintainer:Charles Galambos, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002