Ignition Gazebo

API Reference

1.0.2
LevelEntityNames Class Reference

A component that holds a list of names of entities to be loaded in a level. More...

#include <LevelEntityNames.hh>

Public Member Functions

 LevelEntityNames ()
 
 LevelEntityNames (const std::set< std::string > &_data)
 
void Deserialize (std::istream &_in) override
 Fills a component based on a stream with a serialized data. By default, it will do nothing. Derived classes should override this function to support deserialization. More...
 
void Serialize (std::ostream &_out) const override
 Fills a stream with a serialized version of the component. By default, it will leave the stream empty. Derived classes should override this function to support serialization. More...
 
- Public Member Functions inherited from Component< DataType, Identifier >
 Component ()
 Default constructor. More...
 
 Component (const DataType &_data)
 Constructor. More...
 
 Component (DataType &&_data)
 Constructor data to be moved. More...
 
 Component (const Component &_component)
 Copy Constructor. More...
 
 Component (Component &&_component) noexcept=default
 Move Constructor. More...
 
 ~Component () override=default
 Destructor. More...
 
DataType & Data ()
 Get the mutable component data. More...
 
const DataType & Data () const
 Get the immutable component data. More...
 
bool operator!= (const Component &_component) const
 Inequality operator. More...
 
Componentoperator= (Component &&_component) noexcept=default
 Move assignment operator. More...
 
Componentoperator= (const Component &_component)
 Copy assignment operator. More...
 
bool operator== (const Component &_component) const
 Equality operator. More...
 
ComponentTypeId TypeId () const override
 Returns the unique ID for the component's type. The ID is derived from the name that is manually chosen during the Factory registration and is guaranteed to be the same across compilers and runs. More...
 
- Public Member Functions inherited from BaseComponent
 BaseComponent ()=default
 Default constructor. More...
 
virtual ~BaseComponent ()=default
 Default destructor. More...
 

Additional Inherited Members

- Static Public Attributes inherited from Component< DataType, Identifier >
static ComponentTypeId typeId {0}
 Unique ID for this component type. This is set through the Factory registration. More...
 

Detailed Description

A component that holds a list of names of entities to be loaded in a level.

Constructor & Destructor Documentation

◆ LevelEntityNames() [1/2]

LevelEntityNames ( )
inline

◆ LevelEntityNames() [2/2]

LevelEntityNames ( const std::set< std::string > &  _data)
inlineexplicit

Member Function Documentation

◆ Deserialize()

void Deserialize ( std::istream &  )
inlineoverridevirtual

Fills a component based on a stream with a serialized data. By default, it will do nothing. Derived classes should override this function to support deserialization.

Reimplemented from Component< DataType, Identifier >.

References Component< DataType, Identifier >::Data(), and ignition::gazebo::components::IGN_GAZEBO_REGISTER_COMPONENT().

◆ Serialize()

void Serialize ( std::ostream &  ) const
inlineoverridevirtual

Fills a stream with a serialized version of the component. By default, it will leave the stream empty. Derived classes should override this function to support serialization.

Reimplemented from Component< DataType, Identifier >.

References Component< DataType, Identifier >::Data().


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