YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarpAudioPlayer_IDL_test_helper Class Reference
+ Inheritance diagram for yarpAudioPlayer_IDL_test_helper:

Classes

class  Command
 
class  Reply
 

Public Types

using funcptr_t = bool(*)(const std::string &, const double, const double, const std::int16_t, const std::int16_t, const std::int16_t)
 

Public Member Functions

 yarpAudioPlayer_IDL_test_helper ()=default
 
 yarpAudioPlayer_IDL_test_helper (const std::string &type, const double duration, const double frequency, const std::int16_t amplitude, const std::int16_t sampling_rate, const std::int16_t channels)
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection.
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
 
void call (yarpAudioPlayer_IDL *ptr)
 
- Public Member Functions inherited from yarp::os::Portable
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor.
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor.
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations.
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations.
 
virtual yarp::os::Type getWriteType () const
 

Public Attributes

Command cmd
 
Reply reply
 

Static Public Attributes

static constexpr const char * s_tag {"test"}
 
static constexpr size_t s_tag_len {1}
 
static constexpr size_t s_cmd_len {7}
 
static constexpr size_t s_reply_len {1}
 
static constexpr const char * s_prototype {"bool yarpAudioPlayer_IDL::test(const std::string& type, const double duration, const double frequency, const std::int16_t amplitude, const std::int16_t sampling_rate, const std::int16_t channels)"}
 
static constexpr const char * s_help
 

Additional Inherited Members

- Static Public Member Functions inherited from yarp::os::Portable
static bool copyPortable (const PortWriter &writer, PortReader &reader)
 Copy one portable to another, via writing and reading.
 

Detailed Description

Definition at line 175 of file yarpAudioPlayer_IDL.cpp.

Member Typedef Documentation

◆ funcptr_t

using yarpAudioPlayer_IDL_test_helper::funcptr_t = bool (*)(const std::string&, const double, const double, const std::int16_t, const std::int16_t, const std::int16_t)

Definition at line 228 of file yarpAudioPlayer_IDL.cpp.

Constructor & Destructor Documentation

◆ yarpAudioPlayer_IDL_test_helper() [1/2]

yarpAudioPlayer_IDL_test_helper::yarpAudioPlayer_IDL_test_helper ( )
default

◆ yarpAudioPlayer_IDL_test_helper() [2/2]

yarpAudioPlayer_IDL_test_helper::yarpAudioPlayer_IDL_test_helper ( const std::string &  type,
const double  duration,
const double  frequency,
const std::int16_t  amplitude,
const std::int16_t  sampling_rate,
const std::int16_t  channels 
)

Definition at line 406 of file yarpAudioPlayer_IDL.cpp.

Member Function Documentation

◆ call()

void yarpAudioPlayer_IDL_test_helper::call ( yarpAudioPlayer_IDL *  ptr)

Definition at line 584 of file yarpAudioPlayer_IDL.cpp.

◆ read()

bool yarpAudioPlayer_IDL_test_helper::read ( yarp::os::ConnectionReader &  reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 416 of file yarpAudioPlayer_IDL.cpp.

◆ write()

bool yarpAudioPlayer_IDL_test_helper::write ( yarp::os::ConnectionWriter &  writer) const
overridevirtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 411 of file yarpAudioPlayer_IDL.cpp.

Member Data Documentation

◆ cmd

Command yarpAudioPlayer_IDL_test_helper::cmd

Definition at line 231 of file yarpAudioPlayer_IDL.cpp.

◆ reply

Reply yarpAudioPlayer_IDL_test_helper::reply

Definition at line 232 of file yarpAudioPlayer_IDL.cpp.

◆ s_cmd_len

constexpr size_t yarpAudioPlayer_IDL_test_helper::s_cmd_len {7}
staticconstexpr

Definition at line 236 of file yarpAudioPlayer_IDL.cpp.

◆ s_help

constexpr const char* yarpAudioPlayer_IDL_test_helper::s_help
staticconstexpr
Initial value:
{
"Generate and send a test sound\n"
"@param type can be \"sine\" , \"sawtooth\" , \"squarewave\"\n"
"@param duration the duration of the sound in seconds\n"
"@param frequency the signal in hertz\n"
"@param amplitude the amplitude of the signal (16 bit)\n"
"@param channels number of channels\n"
"@param sampling_rate signal sampling rate (samples/s)\n"
"@return true/false on success/failure"
}

Definition at line 239 of file yarpAudioPlayer_IDL.cpp.

◆ s_prototype

constexpr const char* yarpAudioPlayer_IDL_test_helper::s_prototype {"bool yarpAudioPlayer_IDL::test(const std::string& type, const double duration, const double frequency, const std::int16_t amplitude, const std::int16_t sampling_rate, const std::int16_t channels)"}
staticconstexpr

Definition at line 238 of file yarpAudioPlayer_IDL.cpp.

◆ s_reply_len

constexpr size_t yarpAudioPlayer_IDL_test_helper::s_reply_len {1}
staticconstexpr

Definition at line 237 of file yarpAudioPlayer_IDL.cpp.

◆ s_tag

constexpr const char* yarpAudioPlayer_IDL_test_helper::s_tag {"test"}
staticconstexpr

Definition at line 234 of file yarpAudioPlayer_IDL.cpp.

◆ s_tag_len

constexpr size_t yarpAudioPlayer_IDL_test_helper::s_tag_len {1}
staticconstexpr

Definition at line 235 of file yarpAudioPlayer_IDL.cpp.


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