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

Public Member Functions

 Command ()=default
 
 Command (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)
 
 ~Command () override=default
 
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.
 
bool write (const yarp::os::idl::WireWriter &writer) const override
 
bool writeTag (const yarp::os::idl::WireWriter &writer) const
 
bool writeArgs (const yarp::os::idl::WireWriter &writer) const
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool readTag (yarp::os::idl::WireReader &reader)
 
bool readArgs (yarp::os::idl::WireReader &reader)
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool readBare (yarp::os::ConnectionReader &reader)
 
virtual bool writeBare (yarp::os::ConnectionWriter &writer) const
 
virtual bool readBottle (yarp::os::ConnectionReader &reader)
 
virtual bool writeBottle (yarp::os::ConnectionWriter &writer) const
 
- 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

std::string type {"sine"}
 
double duration {0.000000}
 
double frequency {0.000000}
 
std::int16_t amplitude {30000}
 
std::int16_t sampling_rate {16000}
 
std::int16_t channels {1}
 

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 185 of file yarpAudioPlayer_IDL.cpp.

Constructor & Destructor Documentation

◆ Command() [1/2]

yarpAudioPlayer_IDL_test_helper::Command::Command ( )
default

◆ Command() [2/2]

yarpAudioPlayer_IDL_test_helper::Command::Command ( 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 422 of file yarpAudioPlayer_IDL.cpp.

◆ ~Command()

yarpAudioPlayer_IDL_test_helper::Command::~Command ( )
overridedefault

Member Function Documentation

◆ read() [1/2]

bool yarpAudioPlayer_IDL_test_helper::Command::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 441 of file yarpAudioPlayer_IDL.cpp.

◆ read() [2/2]

bool yarpAudioPlayer_IDL_test_helper::Command::read ( yarp::os::idl::WireReader &  reader)
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 493 of file yarpAudioPlayer_IDL.cpp.

◆ readArgs()

bool yarpAudioPlayer_IDL_test_helper::Command::readArgs ( yarp::os::idl::WireReader &  reader)

Definition at line 517 of file yarpAudioPlayer_IDL.cpp.

◆ readTag()

bool yarpAudioPlayer_IDL_test_helper::Command::readTag ( yarp::os::idl::WireReader &  reader)

Definition at line 504 of file yarpAudioPlayer_IDL.cpp.

◆ write() [1/2]

bool yarpAudioPlayer_IDL_test_helper::Command::write ( const yarp::os::idl::WireWriter &  writer) const
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 451 of file yarpAudioPlayer_IDL.cpp.

◆ write() [2/2]

bool yarpAudioPlayer_IDL_test_helper::Command::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 432 of file yarpAudioPlayer_IDL.cpp.

◆ writeArgs()

bool yarpAudioPlayer_IDL_test_helper::Command::writeArgs ( const yarp::os::idl::WireWriter &  writer) const

Definition at line 470 of file yarpAudioPlayer_IDL.cpp.

◆ writeTag()

bool yarpAudioPlayer_IDL_test_helper::Command::writeTag ( const yarp::os::idl::WireWriter &  writer) const

Definition at line 462 of file yarpAudioPlayer_IDL.cpp.

Member Data Documentation

◆ amplitude

std::int16_t yarpAudioPlayer_IDL_test_helper::Command::amplitude {30000}

Definition at line 208 of file yarpAudioPlayer_IDL.cpp.

◆ channels

std::int16_t yarpAudioPlayer_IDL_test_helper::Command::channels {1}

Definition at line 210 of file yarpAudioPlayer_IDL.cpp.

◆ duration

double yarpAudioPlayer_IDL_test_helper::Command::duration {0.000000}

Definition at line 206 of file yarpAudioPlayer_IDL.cpp.

◆ frequency

double yarpAudioPlayer_IDL_test_helper::Command::frequency {0.000000}

Definition at line 207 of file yarpAudioPlayer_IDL.cpp.

◆ sampling_rate

std::int16_t yarpAudioPlayer_IDL_test_helper::Command::sampling_rate {16000}

Definition at line 209 of file yarpAudioPlayer_IDL.cpp.

◆ type

std::string yarpAudioPlayer_IDL_test_helper::Command::type {"sine"}

Definition at line 205 of file yarpAudioPlayer_IDL.cpp.


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