IBufferProxy Class Reference

#include <IBufferProxy.h>

Collaboration diagram for IBufferProxy:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 IBufferProxy (void)
 ~IBufferProxy (void)
unsigned long getAllocatedMemorySizeKBytes ()
void * getBuffer ()
void setBuffer (void *buffer)
unsigned int getId ()
void setId (unsigned int aId)
unsigned int getType ()
void setType (unsigned int t)
VisComponentgetOwner ()
void setOwner (VisComponent *component)

Detailed Description

This class is a proxy for the IBuffer class. It allows making abstract references to an i-buffer without knowing the actual buffer data type. It also associates a type identifier with the buffer instance, so that the buffers of the same type can be treated consistently. The ID of this proxy should be the same as the associated i-buffer's. The VisComponent object that defines this buffer as one of its active buffers is considered the owner of the buffer. The owner of the buffer should be used when converting global to buffer coordinates.

Author:
Fabricio Anastacio - fabriciocfa@yahoo.com
Since:
July 13, 2007


Constructor & Destructor Documentation

IBufferProxy::IBufferProxy ( void   ) 

Constructs a default empty i-buffer proxy object.

IBufferProxy::~IBufferProxy ( void   ) 

Destroys this object.


Member Function Documentation

unsigned long IBufferProxy::getAllocatedMemorySizeKBytes (  ) 

Returns the amount of memory allocated by this i-buffer in KyloBytes.

Returns:
the amount of memory allocated by this i-buffer in KyloBytes.

void* IBufferProxy::getBuffer (  )  [inline]

Returns the reference to the associated i-buffer.

Returns:
the reference to the associated i-buffer.

void IBufferProxy::setBuffer ( void *  buffer  )  [inline]

Sets the reference to the associated i-buffer.

Parameters:
buffer the reference to be set for the associated i-buffer.

unsigned int IBufferProxy::getId (  )  [inline]

Returns the identifier of this proxy and of the associated i-buffer.

Returns:
the identifier of this proxy and of the associated i-buffer.

void IBufferProxy::setId ( unsigned int  aId  )  [inline]

Sets the identifier of this proxy and of the associated i-buffer.

Parameters:
aId the identifier of this proxy and of the associated i-buffer.

unsigned int IBufferProxy::getType (  )  [inline]

Returns the type of the associated i-buffer.

Returns:
the type of the associated i-buffer.

void IBufferProxy::setType ( unsigned int  t  )  [inline]

Sets the type of the associated i-buffer.

Parameters:
t the type to be set to the associated i-buffer.

VisComponent* IBufferProxy::getOwner (  )  [inline]

Returns the component that owns (has as active) this buffer.

Returns:
the component that owns (has as active) this buffer.

void IBufferProxy::setOwner ( VisComponent component  )  [inline]

Sets the owner of the associated i-buffer.

Parameters:
component the component to be set as the owner of the associated i-buffer.


The documentation for this class was generated from the following files:
Generated on Fri Dec 21 17:43:50 2007 for LargeDisplayFramework by  doxygen 1.5.2