sound_play::msg::_SoundRequest::SoundRequest Class Reference

List of all members.

Public Member Functions
def	__init__
def	deserialize
def	deserialize_numpy
def	serialize
def	serialize_numpy
Public Attributes
	arg
	command
	sound
Static Public Attributes
int	ALL = 1
int	BACKINGUP = 1
int	NEEDS_PLUGGING = 3
int	NEEDS_PLUGGING_BADLY = 5
int	NEEDS_UNPLUGGING = 2
int	NEEDS_UNPLUGGING_BADLY = 4
int	PLAY_FILE = 2
int	PLAY_ONCE = 1
int	PLAY_START = 2
int	PLAY_STOP = 0
int	SAY = 3
Private Member Functions
def	_get_types
Static Private Attributes
list	__slots__ = ['sound','command','arg']
string	_full_text
	_has_header = False
string	_md5sum = "9cfd61778f9f82824e2604bc63ee8104"
list	_slot_types = ['int8','int8','string']
string	_type = "sound_play/SoundRequest"

Detailed Description

Definition at line 6 of file _SoundRequest.py.

Member Function Documentation

def sound_play::msg::_SoundRequest::SoundRequest::__init__	(	self,
		args,
		kwds
	)

Constructor. Any message fields that are implicitly/explicitly
set to None will be assigned a default value. The recommend
use is keyword arguments as this is more robust to future message
changes.  You cannot mix in-order arguments and keyword arguments.

The available fields are:
   sound,command,arg

@param args: complete set of field values, in .msg order
@param kwds: use keyword arguments corresponding to message field names
to set specific fields.

Definition at line 54 of file _SoundRequest.py.

def sound_play::msg::_SoundRequest::SoundRequest::_get_types ( self ) [private]

internal API method

Definition at line 82 of file _SoundRequest.py.

def sound_play::msg::_SoundRequest::SoundRequest::deserialize	(	self,
		str
	)

unpack serialized message in str into this message instance
@param str: byte array of serialized message
@type  str: str

Definition at line 103 of file _SoundRequest.py.

def sound_play::msg::_SoundRequest::SoundRequest::deserialize_numpy	(	self,
		str,
		numpy
	)

unpack serialized message in str into this message instance using numpy for array types
@param str: byte array of serialized message
@type  str: str
@param numpy: numpy python module
@type  numpy: module

Definition at line 143 of file _SoundRequest.py.

def sound_play::msg::_SoundRequest::SoundRequest::serialize	(	self,
		buff
	)

serialize message into buffer
@param buff: buffer
@type  buff: StringIO

Definition at line 88 of file _SoundRequest.py.

def sound_play::msg::_SoundRequest::SoundRequest::serialize_numpy	(	self,
		buff,
		numpy
	)

serialize message with numpy array types into buffer
@param buff: buffer
@type  buff: StringIO
@param numpy: numpy python module
@type  numpy module

Definition at line 126 of file _SoundRequest.py.

Member Data Documentation

list sound_play::msg::_SoundRequest::SoundRequest::__slots__ = ['sound','command','arg'] [static, private]

Definition at line 51 of file _SoundRequest.py.

string sound_play::msg::_SoundRequest::SoundRequest::_full_text [static, private]

Initial value:

"""# IMPORTANT: You should never have to generate this message yourself.
# Use the sound_play::SoundClient C++ helper or the
# sound_play.libsoundplay.SoundClient Python helper.

# Sounds
int8 BACKINGUP = 1
int8 NEEDS_UNPLUGGING = 2
int8 NEEDS_PLUGGING = 3
int8 NEEDS_UNPLUGGING_BADLY = 4
int8 NEEDS_PLUGGING_BADLY = 5

# Sound identifiers that have special meaning
int8 ALL = -1 # Only legal with PLAY_STOP
int8 PLAY_FILE = -2
int8 SAY = -3

int8 sound # Selects which sound to play (see above)

# Commands
int8 PLAY_STOP = 0 # Stop this sound from playing
int8 PLAY_ONCE = 1 # Play the sound once
int8 PLAY_START = 2 # Play the sound in a loop until a stop request occurs

int8 command # Indicates what to do with the sound

string arg # file name or text to say

"""