Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages | Examples

ArAMPTUPacket Class Reference

#include <ArAMPTU.h>

Inheritance diagram for ArAMPTUPacket:

ArBasePacket List of all members.

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


Public Member Functions

 ArAMPTUPacket (ArTypes::UByte2 bufferSize=30)
 Constructor.
virtual void byte2ToBuf (ArTypes::Byte2 val)
virtual void byteToBuf (ArTypes::Byte val)
virtual void finalizePacket (void)
unsigned char getUnitNumber (void)
 Gets the unit number this packet is for.
bool setUnitNumber (unsigned char unitNumber)
 Sets the unit number htis packet is for.
virtual ~ArAMPTUPacket ()
 Destructor.

Protected Attributes

unsigned char myUnitNumber


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 Thu Jan 7 10:34:40 2010 for Aria by  doxygen 1.4.2