include/gz/sim/components/LogicalAudio.hh
Go to the documentation of this file.
bool operator!=(const SourcePlayInfo &_sourcePlayInfo) const
Definition: include/gz/sim/components/LogicalAudio.hh:110
logical_audio::AttenuationFunction attFunc
The source's attenuation function.
Definition: include/gz/sim/components/LogicalAudio.hh:57
This library is part of the Ignition Robotics project.
#define IGN_GAZEBO_REGISTER_COMPONENT(_compType, _classname)
Static component registration macro.
Definition: gz/sim/components/Factory.hh:331
std::istream & operator>>(std::istream &_in, logical_audio::AttenuationFunction &_func)
Input stream overload for logical_audio::AttenuationFunction.
Definition: include/gz/sim/components/LogicalAudio.hh:152
std::chrono::seconds playDuration
How long the source should play for, in seconds. Setting this to 0 means the source has a play durati...
Definition: include/gz/sim/components/LogicalAudio.hh:98
Properties of a logical audio source. A source also has a pose, which can be stored as a component of...
Definition: include/gz/sim/components/LogicalAudio.hh:51
static std::ostream & Serialize(std::ostream &_out, const logical_audio::Source &_source)
Serialization for logical_audio::Source.
Definition: include/gz/sim/components/LogicalAudio.hh:206
logical_audio::AttenuationShape attShape
The source's attenuation shape.
Definition: include/gz/sim/components/LogicalAudio.hh:60
double innerRadius
The source's inner radius, which should be >= 0.
Definition: include/gz/sim/components/LogicalAudio.hh:63
IGN_GAZEBO_REGISTER_COMPONENT("ign_gazebo_components.AngularAcceleration", AngularAcceleration) using WorldAngularAcceleration
A component type that contains angular acceleration of an entity in the world frame represented by gz...
std::chrono::steady_clock::duration startTime
The time at which the source most recently started playing.
Definition: include/gz/sim/components/LogicalAudio.hh:101
std::istream & operator>>(std::istream &_in, std::chrono::steady_clock::duration &_dur)
Input stream overload for std::chrono::steady_clock::duration.
Definition: include/gz/sim/components/LogicalAudio.hh:190
bool operator==(const Microphone &_microphone) const
Definition: include/gz/sim/components/LogicalAudio.hh:128
static std::ostream & Serialize(std::ostream &_out, const logical_audio::SourcePlayInfo &_playInfo)
Serialization for logical_audio::SourcePlayInfo.
Definition: include/gz/sim/components/LogicalAudio.hh:236
static std::istream & Deserialize(std::istream &_in, logical_audio::Source &_source)
Deserialization for logical_audio::Source.
Definition: include/gz/sim/components/LogicalAudio.hh:219
static std::ostream & Serialize(std::ostream &_out, const logical_audio::Microphone &_mic)
Serialization for logical_audio::Microphone.
Definition: include/gz/sim/components/LogicalAudio.hh:265
Serializer for components::LogicalAudioSourcePlayInfo object.
Definition: include/gz/sim/components/LogicalAudio.hh:230
STL class.
static std::istream & Deserialize(std::istream &_in, logical_audio::SourcePlayInfo &_playInfo)
Deserialization for logical_audio::SourcePlayInfo.
Definition: include/gz/sim/components/LogicalAudio.hh:248
bool operator==(const SourcePlayInfo &_sourcePlayInfo) const
Definition: include/gz/sim/components/LogicalAudio.hh:103
std::ostream & operator<<(std::ostream &_out, const logical_audio::AttenuationFunction &_func)
Output stream overload for logical_audio::AttenuationFunction.
Definition: include/gz/sim/components/LogicalAudio.hh:143
unsigned int id
The microphone's id.
Definition: include/gz/sim/components/LogicalAudio.hh:122
AttenuationShape
Audio source attenuation shapes. AttenuationShape::Undefined is used to indicate that an attenuation ...
Definition: include/gz/sim/components/LogicalAudio.hh:46
AttenuationFunction
Audio source attenuation functions. AttenuationFunction::Undefined is used to indicate that an attenu...
Definition: include/gz/sim/components/LogicalAudio.hh:41
Serializer for components::LogicalAudioSource object.
Definition: include/gz/sim/components/LogicalAudio.hh:200
bool operator!=(const Microphone &_microphone) const
Definition: include/gz/sim/components/LogicalAudio.hh:133
A component type that wraps any data type. The intention is for this class to be used to create simpl...
Definition: gz/sim/components/Component.hh:320
SourcePlayInfo()
Constructor.
Definition: include/gz/sim/components/LogicalAudio.hh:89
double volumeDetectionThreshold
The minimum volume this microphone can detect. This should be a value between 0.0 (0% volume) and 1....
Definition: include/gz/sim/components/LogicalAudio.hh:126
std::ostream & operator<<(std::ostream &_out, const std::chrono::steady_clock::duration &_dur)
Output stream overload for std::chrono::steady_clock::duration.
Definition: include/gz/sim/components/LogicalAudio.hh:181
A source's playing information. Useful for keeping track of when to start/stop playing a source.
Definition: include/gz/sim/components/LogicalAudio.hh:86
bool operator!=(const Source &_source) const
Definition: include/gz/sim/components/LogicalAudio.hh:78
static std::istream & Deserialize(std::istream &_in, logical_audio::Microphone &_mic)
Deserialization for logical_audio::Microphone.
Definition: include/gz/sim/components/LogicalAudio.hh:275
T count(T... args)
double falloffDistance
The source's falloff distance, which should be greater than Source::innerRadius.
Definition: include/gz/sim/components/LogicalAudio.hh:67
double emissionVolume
The source's emission volume, which should be between 0.0 (0% volume) and 1.0 (100% volume)
Definition: include/gz/sim/components/LogicalAudio.hh:71
bool playing
Whether the source is currently playing or not.
Definition: include/gz/sim/components/LogicalAudio.hh:94
bool operator==(const Source &_source) const
Definition: include/gz/sim/components/LogicalAudio.hh:73
STL class.
Component< logical_audio::Source, class LogicalAudioSourceTag, serializers::LogicalAudioSourceSerializer > LogicalAudioSource
A component that contains a logical audio source, which is represented by logical_audio::Source.
Definition: include/gz/sim/components/LogicalAudio.hh:294
Properties of a logical audio microphone. A microphone also has a pose, which can be stored as a comp...
Definition: include/gz/sim/components/LogicalAudio.hh:119
Serializer for components::LogicalMicrophone object.
Definition: include/gz/sim/components/LogicalAudio.hh:259
unsigned int id
The source's id.
Definition: include/gz/sim/components/LogicalAudio.hh:54