Gazebo Rendering

API Reference

9.0.0
List of all members | Public Member Functions
CompositeStore< T > Class Template Referenceabstract

Represents a collection of Store objects, collectively working as a single composite store. More...

#include <gz/rendering/Storage.hh>

Public Member Functions

virtual ~CompositeStore ()=default
 Destructor.
 
virtual bool AddStore (TStorePtr _store)=0
 Add the given store. If the given store already exists, then no work will be done.
 
virtual bool ContainsStore (ConstTStorePtr _store) const =0
 Determine if given store exists.
 
virtual TStorePtr GetStore (unsigned int _index) const =0
 Get store at the given index. If no such store exists NULL will be returned.
 
virtual unsigned int GetStoreCount () const =0
 Get number of Stores.
 
virtual TStorePtr RemoveStore (TStorePtr _store)=0
 Remove given store. If no such store exists no work will be done and NULL will be returned.
 
virtual TStorePtr RemoveStore (unsigned int _index)=0
 Remove store at the given index. If no such store exists no work will be done and NULL will be returned.
 
- Public Member Functions inherited from Store< T >
virtual ~Store ()=default
 Destructor.
 
virtual bool Add (TPtr _object)=0
 Add given element. If the element has already been added or its name or ID conflict with other existing elements, then no work will be done.
 
virtual bool Contains (ConstTPtr _object) const =0
 Determine if store contains the given element.
 
virtual bool ContainsId (unsigned int _id) const =0
 Determine if store contains the element with the given ID.
 
virtual bool ContainsName (const std::string &_name) const =0
 Determine if store contains the element with the given name.
 
virtual void Destroy (TPtr _object)=0
 Remove and destroy given element. If the given element does not exists, in this store, then no work will be done.
 
virtual void DestroyAll ()=0
 Remove and destroy all elements in store.
 
virtual void DestroyById (unsigned int _id)=0
 Remove and destroy element with the given ID. If the specified element does not exists in this store, then no work will be done.
 
virtual void DestroyByIndex (unsigned int _index)=0
 Remove and destroy element at the given index. If the specified element does not exists in this store, then no work will be done.
 
virtual void DestroyByName (const std::string &_name)=0
 Remove and destroy element with the given name. If the specified element does not exists in this store, then no work will be done.
 
virtual TPtr GetById (unsigned int _id) const =0
 Get element with the given ID.
 
virtual TPtr GetByIndex (unsigned int _index) const =0
 Get element at the given index.
 
virtual TPtr GetByName (const std::string &_name) const =0
 Get element with the given name.
 
virtual TPtr Remove (TPtr _object)=0
 Remove given element. If the given element does not exists in this store, then no work will be done.
 
virtual void RemoveAll ()=0
 Remove all elements from store.
 
virtual TPtr RemoveById (unsigned int _id)=0
 Remove element with the given ID. If the specified element does not exists in this store, then no work will be done.
 
virtual TPtr RemoveByIndex (unsigned int _index)=0
 Remove element at the given index. If the specified element does not exists in this store, then no work will be done.
 
virtual TPtr RemoveByName (const std::string &_name)=0
 Remove element with the given name. If the specified element does not exists in this store, then no work will be done.
 
virtual unsigned int Size () const =0
 Get number of elements in this store.
 

Detailed Description

template<class T>
class gz::rendering::CompositeStore< T >

Represents a collection of Store objects, collectively working as a single composite store.

gz/rendering/CompositeStore.hh

Template Parameters
TThe storage element type

Constructor & Destructor Documentation

◆ ~CompositeStore()

template<class T >
virtual ~CompositeStore ( )
virtualdefault

Destructor.

Member Function Documentation

◆ AddStore()

template<class T >
virtual bool AddStore ( TStorePtr  _store)
pure virtual

Add the given store. If the given store already exists, then no work will be done.

Parameters
[in]_storeStore to be added
Returns
True if successful

Implemented in BaseCompositeStore< T >, and BaseCompositeStore< Node >.

◆ ContainsStore()

template<class T >
virtual bool ContainsStore ( ConstTStorePtr  _store) const
pure virtual

Determine if given store exists.

Parameters
[in]_storeStore in question
Returns
True if given store exists

Implemented in BaseCompositeStore< T >, and BaseCompositeStore< Node >.

◆ GetStore()

template<class T >
virtual TStorePtr GetStore ( unsigned int  _index) const
pure virtual

Get store at the given index. If no such store exists NULL will be returned.

Parameters
[in]_indexIndex of the desired store
Returns
The specified store

Implemented in BaseCompositeStore< T >, and BaseCompositeStore< Node >.

◆ GetStoreCount()

template<class T >
virtual unsigned int GetStoreCount ( ) const
pure virtual

Get number of Stores.

Returns
The number of Stores

Implemented in BaseCompositeStore< T >, and BaseCompositeStore< Node >.

◆ RemoveStore() [1/2]

template<class T >
virtual TStorePtr RemoveStore ( TStorePtr  _store)
pure virtual

Remove given store. If no such store exists no work will be done and NULL will be returned.

Parameters
[in]_storeStore to be removed
Returns
The removed store

Implemented in BaseCompositeStore< T >, and BaseCompositeStore< Node >.

◆ RemoveStore() [2/2]

template<class T >
virtual TStorePtr RemoveStore ( unsigned int  _index)
pure virtual

Remove store at the given index. If no such store exists no work will be done and NULL will be returned.

Parameters
[in]_indexIndex of the store to be removed
Returns
The removed store

Implemented in BaseCompositeStore< T >, and BaseCompositeStore< Node >.

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