gusimplewhiteboard
guWhiteboard::NXT_Sound_Control Class Reference

Class for controlling differential robots Defines whiteboard message. More...

#include <NXT_Sound_Control.hpp>

Inheritance diagram for guWhiteboard::NXT_Sound_Control:
Collaboration diagram for guWhiteboard::NXT_Sound_Control:

Public Member Functions

 NXT_Sound_Control ()
 Designated constructor. More...
 
 NXT_Sound_Control (const std::string &name)
 String constructor. More...
 
std::string description ()
 get message description More...
 
void from_string (std::string str)
 string conversion More...
 
bool operator== (const NXT_Sound_Control &s)
 override equality operator so we can compare instances More...
 
- Public Member Functions inherited from wb_sound
 PROPERTY (uint16_t, frequency) PROPERTY(uint16_t
 duraiton is milli-seconds More...
 
duration wb_sound ()
 Default constructor. More...
 
 wb_sound (const wb_sound &other)
 Copy Constructor. More...
 
wb_soundoperator= (const wb_sound &other)
 Assignment Operator. More...
 

Detailed Description

Class for controlling differential robots Defines whiteboard message.

Definition at line 17 of file NXT_Sound_Control.hpp.

Constructor & Destructor Documentation

◆ NXT_Sound_Control() [1/2]

guWhiteboard::NXT_Sound_Control::NXT_Sound_Control ( )
inline

Designated constructor.

Definition at line 20 of file NXT_Sound_Control.hpp.

◆ NXT_Sound_Control() [2/2]

guWhiteboard::NXT_Sound_Control::NXT_Sound_Control ( const std::string &  name)
inline

String constructor.

Definition at line 24 of file NXT_Sound_Control.hpp.

References from_string().

Member Function Documentation

◆ description()

std::string guWhiteboard::NXT_Sound_Control::description ( )
inline

get message description

Definition at line 29 of file NXT_Sound_Control.hpp.

◆ from_string()

void guWhiteboard::NXT_Sound_Control::from_string ( std::string  str)
inline

string conversion

Definition at line 37 of file NXT_Sound_Control.hpp.

Referenced by NXT_Sound_Control().

◆ operator==()

bool guWhiteboard::NXT_Sound_Control::operator== ( const NXT_Sound_Control s)
inline

override equality operator so we can compare instances

Definition at line 52 of file NXT_Sound_Control.hpp.


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