Ignition Gazebo

API Reference

7.0.0~pre1
include/ignition/gazebo/components/LogicalAudio.hh File Reference
#include <chrono>
#include <cstdint>
#include <istream>
#include <ostream>
#include <ratio>
#include <ignition/gazebo/components/Factory.hh>
#include <ignition/gazebo/components/Component.hh>
#include <ignition/gazebo/config.hh>

Go to the source code of this file.

Classes

class  LogicalAudioSourcePlayInfoSerializer
 Serializer for components::LogicalAudioSourcePlayInfo object. More...
 
class  LogicalAudioSourceSerializer
 Serializer for components::LogicalAudioSource object. More...
 
class  LogicalMicrophoneSerializer
 Serializer for components::LogicalMicrophone object. More...
 
struct  Microphone
 Properties of a logical audio microphone. A microphone also has a pose, which can be stored as a component of a microphone entity via components::Pose. More...
 
struct  Source
 Properties of a logical audio source. A source also has a pose, which can be stored as a component of a source entity via components::Pose. More...
 
struct  SourcePlayInfo
 A source's playing information. Useful for keeping track of when to start/stop playing a source. More...
 

Namespaces

 ignition
 This library is part of the Ignition Robotics project.
 
 ignition::gazebo
 Gazebo is a leading open source robotics simulator, that provides high fidelity physics, rendering, and sensor simulation.
 
 ignition::gazebo::components
 Components represent data, such as position information. An Entity usually has one or more associated components.
 
 ignition::gazebo::logical_audio
 
 ignition::gazebo::serializers
 A Serializer class is used to serialize and deserialize a component. It is passed in as the third template parameter to components::Component. Eg.
 

Typedefs

using LogicalAudioSource = Component< logical_audio::Source, class LogicalAudioSourceTag, serializers::LogicalAudioSourceSerializer >
 A component that contains a logical audio source, which is represented by logical_audio::Source. More...
 
using LogicalAudioSourcePlayInfo = Component< logical_audio::SourcePlayInfo, class LogicalAudioSourcePlayInfoTag, serializers::LogicalAudioSourcePlayInfoSerializer >
 A component that contains a logical audio source's playing information, which is represented by logical_audio::SourcePlayInfo. More...
 
using LogicalMicrophone = Component< logical_audio::Microphone, class LogicalMicrophoneTag, serializers::LogicalMicrophoneSerializer >
 A component that contains a logical microphone, which is represented by logical_audio::Microphone. More...
 

Enumerations

enum  AttenuationFunction { LINEAR, UNDEFINED }
 Audio source attenuation functions. AttenuationFunction::Undefined is used to indicate that an attenuation function has not been defined yet. More...
 
enum  AttenuationShape { SPHERE, UNDEFINED }
 Audio source attenuation shapes. AttenuationShape::Undefined is used to indicate that an attenuation shape has not been defined yet. More...
 

Functions

std::ostreamoperator<< (std::ostream &_out, const logical_audio::AttenuationFunction &_func)
 Output stream overload for logical_audio::AttenuationFunction. More...
 
std::ostreamoperator<< (std::ostream &_out, const logical_audio::AttenuationShape &_shape)
 Output stream overload for logical_audio::AttenuationShape. More...
 
std::ostreamoperator<< (std::ostream &_out, const std::chrono::steady_clock::duration &_dur)
 Output stream overload for std::chrono::steady_clock::duration. More...
 
std::istreamoperator>> (std::istream &_in, logical_audio::AttenuationFunction &_func)
 Input stream overload for logical_audio::AttenuationFunction. More...
 
std::istreamoperator>> (std::istream &_in, logical_audio::AttenuationShape &_shape)
 Input stream overload for logical_audio::AttenuationShape. More...
 
std::istreamoperator>> (std::istream &_in, std::chrono::steady_clock::duration &_dur)
 Input stream overload for std::chrono::steady_clock::duration. More...