Main Page   Class Hierarchy   Compound List   Compound Members  

ArAMPTUPacket Class Reference

A class for for making commands to send to the AMPTU. More...

#include <ArAMPTU.h>

Inheritance diagram for ArAMPTUPacket::

ArBasePacket List of all members.

Public Methods

 ArAMPTUPacket (ArTypes::UByte2 bufferSize=30)
 Constructor.

virtual ~ArAMPTUPacket (void)
 Destructor.

unsigned char getUnitNumber (void)
 Gets the unit number this packet is for. More...

bool setUnitNumber (unsigned char unitNumber)
 Sets the unit number htis packet is for. More...

virtual void byteToBuf (ArTypes::Byte val)
 Puts ArTypes::Byte into packets buffer.

virtual void byte2ToBuf (ArTypes::Byte2 val)
 Puts ArTypes::Byte2 into packets buffer.

virtual void finalize (void)
 Finalizes the packet in preparation for sending, must be done.


Detailed Description

A class for for making commands to send to the AMPTU.

There are only a few functioning ways to put things into this packet, you MUST use thse, if you use anything else your commands won't work. You must use byteToBuf and byte2ToBuf.

See also:
getUnitNumber , setUnitNumber


Member Function Documentation

unsigned char ArAMPTUPacket::getUnitNumber void   
 

Gets the unit number this packet is for.

Each AMPTU has a unit number, so that you can daisy chain multiple ones together. This number is incorporated into the packet header, thus the packet has to know what the number is.

Returns:
the unit number this packet has

bool ArAMPTUPacket::setUnitNumber unsigned char    unitNumber
 

Sets the unit number htis packet is for.

Each AMPTU has a unit number, so that you can daisy chain multiple ones together. This number is incorporated into the packet header, thus the packet has to know what the number is.

Parameters:
unitNumber  the unit number for this packet, this needs to be 0-7
Returns:
true if the number is acceptable, false otherwise


The documentation for this class was generated from the following files:
Generated on Tue Nov 12 17:43:50 2002 for Aria by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001