cornelluniversity::vetserial::mp3_stop_request Class Reference

base_command Implements a request to to stop the playing of a track that is currently in playback on the remote device. More...

#include <vetprot.h>

Inheritance diagram for cornelluniversity::vetserial::mp3_stop_request:

List of all members.

Public Member Functions
	mp3_stop_request (void)
	Default constructor Zeroes out device, track.
	mp3_stop_request (const uint8_ dev, const uint8_ trk)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Overloaded constructor Accepts values for initializing the device and track numbers.
virtual	~mp3_stop_request (void)
const uint8_	track (void) const
	Track number private member accessor.
void	track (const uint8_ track_number)
	Track number private member mutator.
const uint8_	device (void) const
	Device number private member accessor.
void	device (const uint8_ device_number)
	Device number private member mutator.
virtual void	execute (void)
	Overridden virtual function.

---

Detailed Description

base_command Implements a request to to stop the playing of a track that is currently in playback on the remote device.

Definition at line 510 of file vetprot.h.

---

Constructor & Destructor Documentation

cornelluniversity::vetserial::mp3_stop_request::mp3_stop_request

(

void

)

[inline]

Default constructor Zeroes out device, track.

See also:

mp3_stop_request(const uint8_ dev, const uint8_ trk)

Definition at line 517 of file vetprot.h.

cornelluniversity::vetserial::mp3_stop_request::mp3_stop_request	(	const uint8_	dev,
		const uint8_	trk
	)			[inline]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Overloaded constructor Accepts values for initializing the device and track numbers.

Todo:

Determine the domain of device IDs (do they start at zero or one)?

Determine the range of acceptble track numbers (255, but starting at zero or one)?

See also:

mp3_stop_request(void)

Definition at line 526 of file vetprot.h.

---

Member Function Documentation

void cornelluniversity::vetserial::mp3_stop_request::device

(

const uint8_

device_number

)

[inline]

Device number private member mutator.

Parameters:

device_number

- unsigned char based device number to be addressed

Todo:

Once we determine the valid range of device numbers, we should validate

Definition at line 549 of file vetprot.h.

const uint8_ cornelluniversity::vetserial::mp3_stop_request::device

(

void

)

const [inline]

Device number private member accessor.

Returns:

unsigned char - device number currently set to be addressed

Definition at line 543 of file vetprot.h.

virtual void cornelluniversity::vetserial::mp3_stop_request::execute

(

void

)

[virtual]

Overridden virtual function.

Builds a stop request packet by instantiating a header, adding the payload, and capping it off with a trailer. The full packet is left in buffer for you to access via this->packet().

Exceptions:

std::bad_alloc

standard memory allocation failure

Implements cornelluniversity::vetserial::base_command.

void cornelluniversity::vetserial::mp3_stop_request::track

(

const uint8_

track_number

)

[inline]

Track number private member mutator.

Parameters:

track_number

- unsigned char based track number to be stopped

Todo:

Once we determine the valid range of track numbers, we should validate

Definition at line 538 of file vetprot.h.

const uint8_ cornelluniversity::vetserial::mp3_stop_request::track

(

void

)

const [inline]

Track number private member accessor.

Returns:

unsigned char - track number currently set to be stopped

Definition at line 532 of file vetprot.h.

---

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

• /users/dtb26/GITROOT/VetSim-Core/src/vetserial/vetprot.h

---