ArAMPTUPacket Class Reference

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

#include <ArAMPTU.h>

Inheritance diagram for ArAMPTUPacket:

List of all members.

Public Member Functions
	ArAMPTUPacket (ArTypes::UByte2 bufferSize=30)
	Constructor.
virtual void	byte2ToBuf (ArTypes::Byte2 val)
	Puts ArTypes::Byte2 into packets buffer.
virtual void	byteToBuf (ArTypes::Byte val)
	Puts ArTypes::Byte into packets buffer.
virtual void	finalizePacket (void)
	MakeFinals the packet in preparation for sending, must be done.
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

---

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

Definition at line 71 of file ArAMPTU.h.

---

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 Definition at line 85 of file ArAMPTU.cpp.

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 Definition at line 97 of file ArAMPTU.cpp. Referenced by ArAMPTU::init().

---

The documentation for this class was generated from the following files:

• ArAMPTU.h
• ArAMPTU.cpp

---