Pointer Class

class PointerClass

PointerClass. Access the reflex scratchpad from a host computer.

The Pointers access the pad which is a shared memory area on a BrainStem module. The interface allows the use of the brainstem scratchpad from the host, and provides a mechanism for allowing the host application and brainstem relexes to communicate.

The Pointer allows access to the pad in a similar manner as a file pointer accesses the underlying file. The cursor position can be set via setOffset. A read of a character short or int can be made from that cursor position. In addition the mode of the pointer can be set so that the cursor position automatically increments or set so that it does not this allows for multiple reads of the same pad value, or reads of multi-record values, via and incrementing pointer.

Public Functions

PointerClass(Acroname::BrainStem::PointerClass &pointer)

Constructor.

~PointerClass()

Destructor.

Acroname::BrainStem2CLI::PointerClass::!PointerClass()

Finalizer.

aErr getOffset(unsigned char %offset)

Get the offset of the pointer

Return

All possible standard UEI return values.

Parameters
  • offset: The value of the offset.

aErr setOffset(unsigned char offset)

Set the offset of the pointer

Return

All possible standard UEI return values.

Parameters
  • offset: The value of the offset.

aErr getMode(unsigned char %mode)

Get the mode of the pointer

Return

All possible standard UEI return values.

Parameters
  • mode: The mode: aPOINTER_MODE_STATIC or aPOINTER_MODE_AUTO_INCREMENT.

aErr setMode(unsigned char mode)

Set the mode of the pointer

Return

All possible standard UEI return values.

Parameters
  • mode: The mode: aPOINTER_MODE_STATIC or aPOINTER_MODE_AUTO_INCREMENT.

aErr getTransferStore(unsigned char %handle)

Get the handle to the store.

Return

All possible standard UEI return handles.

Parameters
  • handle: The handle of the store.

aErr setTransferStore(unsigned char handle)

Set the handle to the store.

Return

All possible standard UEI return handles.

Parameters
  • handle: The handle of the store.

aErr initiateTransferToStore(unsigned char length)

Transfer data to the store.

Return

All possible standard UEI return values.

Parameters
  • length: The length of the data transfer.

aErr initiateTransferFromStore(unsigned char length)

Transfer data from the store.

Return

All possible standard UEI return values.

Parameters
  • length: The length of the data transfer.

aErr getChar(unsigned char %value)

Get a char (1 unsigned char) value from the pointer at this object’s index, where elements are 1 unsigned char long.

Return

All possible standard UEI return values.

Parameters
  • value: The value of a single character (1 unsigned char) stored in the pointer.

aErr setChar(const unsigned char value)

Set a char (1 unsigned char) value to the pointer at this object’s element index, where elements are 1 unsigned char long.

Return

All possible standard UEI return values.

Parameters
  • value: The single char (1 unsigned char) value to be stored in the pointer.

aErr getShort(unsigned short %value)

Get a short (2 unsigned char) value from the pointer at this objects index, where elements are 2 bytes long

Return

All possible standard UEI return values.

Parameters
  • value: The value of a single short (2 unsigned char) stored in the pointer.

aErr setShort(const unsigned short value)

Set a short (2 bytes) value to the pointer at this object’s element index, where elements are 2 bytes long.

Return

All possible standard UEI return values.

Parameters
  • value: The single short (2 unsigned char) value to be set in the pointer.

aErr getInt(unsigned int %value)

Get an int (4 bytes) value from the pointer at this objects index, where elements are 4 bytes long

Return

All possible standard UEI return values.

Parameters
  • value: The value of a single int (4 unsigned char) stored in the pointer.

aErr setInt(const unsigned int value)

Set an int (4 bytes) value from the pointer at this objects index, where elements are 4 bytes long

Return

All possible standard UEI return values.

Parameters
  • value: The single int (4 unsigned char) value to be stored in the pointer.