Gazebo Gazebo

API Reference

3.15.1
gz/sim/components/Component.hh File Reference
#include <cstdint>
#include <memory>
#include <string>
#include <sstream>
#include <utility>
#include <gz/common/Console.hh>
#include <gz/sim/config.hh>
#include <gz/sim/Export.hh>
#include <gz/sim/Types.hh>

Go to the source code of this file.

Classes

class  BaseComponent
 Base class for all components. More...
 
class  Component< DataType, Identifier, Serializer >
 A component type that wraps any data type. The intention is for this class to be used to create simple components while avoiding a lot of boilerplate code. The Identifier must be a unique type so that type aliases can be used to create new components. However the type does not need to be defined anywhere eg. More...
 
class  Component< NoData, Identifier, Serializer >
 Specialization for components that don't wrap any data. This class to be used to create simple components that represent just a "tag", while avoiding a lot of boilerplate code. The Identifier must be a unique type so that type aliases can be used to create new components. However the type does not need to be defined anywhere eg. More...
 
class  DefaultSerializer< DataType >
 Default serializer template to call stream operators only on types that support them. If the stream operator is not available, a warning message is printed. More...
 
class  DefaultSerializer< components::NoData >
 Specialization of DefaultSerializer for NoData. More...
 
class  IsInStreamable< Stream, DataType >
 Type trait that determines if a operator>> is defined on Stream and DataType, i.e, it checks if the function Stream& operator>>(Stream&, DataType&) exists. Example: More...
 
class  IsOutStreamable< Stream, DataType >
 Type trait that determines if a operator<< is defined on Stream and DataType, i.e, it checks if the function Stream& operator<<(Stream&, const DataType&) exists. Example: More...
 
struct  IsSharedPtr< T >
 Helper trait to determine if a type is shared_ptr or not. More...
 
struct  IsSharedPtr< std::shared_ptr< T > >
 Helper trait to determine if a type is shared_ptr or not. 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::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.
 
 ignition::gazebo::traits
 

Typedefs

using NoData = std::add_lvalue_reference< void >
 Convenient type to be used by components that don't wrap any data. I.e. they act as tags and their presence is enough to infer something about the entity. More...