Pointer Class¶
- class PointerClass : public EntityClass¶
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()¶
Constructor.
- ~PointerClass()¶
Destructor.
- !PointerClass ()
Finalizer.
- void init (BrainStem2CLI::ModuleClass^ module, const unsigned char index)
Initializes the class. Should only be called when manually creating classes.
- Parameters:
pModule – The module.
index – The cmdPOINTER index to be addressed.
- aErr getOffset(unsigned short %offset)¶
Get the offset of the pointer
- Parameters:
offset – The value of the offset.
- Returns:
All possible standard UEI return values.
- aErr setOffset(unsigned short offset)¶
Set the offset of the pointer
- Parameters:
offset – The value of the offset.
- Returns:
All possible standard UEI return values.
- aErr getMode(unsigned char %mode)¶
Get the mode of the pointer
- Parameters:
mode – The mode: aPOINTER_MODE_STATIC or aPOINTER_MODE_AUTO_INCREMENT.
- Returns:
All possible standard UEI return values.
- aErr setMode(unsigned char mode)¶
Set the mode of the pointer
- Parameters:
mode – The mode: aPOINTER_MODE_STATIC or aPOINTER_MODE_AUTO_INCREMENT.
- Returns:
All possible standard UEI return values.
- aErr getTransferStore(unsigned char %handle)¶
Get the handle to the store.
- Parameters:
handle – The handle of the store.
- Returns:
All possible standard UEI return handles.
- aErr setTransferStore(unsigned char handle)¶
Set the handle to the store.
- Parameters:
handle – The handle of the store.
- Returns:
All possible standard UEI return handles.
- aErr initiateTransferToStore(unsigned char length)¶
Transfer data to the store.
- Parameters:
length – The length of the data transfer.
- Returns:
All possible standard UEI return values.
- aErr initiateTransferFromStore(unsigned char length)¶
Transfer data from the store.
- Parameters:
length – The length of the data transfer.
- Returns:
All possible standard UEI return values.
- 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.
- Parameters:
value – The value of a single character (1 unsigned char) stored in the pointer.
- Returns:
All possible standard UEI return values.
- 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.
- Parameters:
value – The single char (1 unsigned char) value to be stored in the pointer.
- Returns:
All possible standard UEI return values.
- 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
- Parameters:
value – The value of a single short (2 unsigned char) stored in the pointer.
- Returns:
All possible standard UEI return values.
- 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.
- Parameters:
value – The single short (2 unsigned char) value to be set in the pointer.
- Returns:
All possible standard UEI return values.