Gazebo Rendering

API Reference

3.7.2
BaseStoreWrapper< T, U > Class Template Reference

#include <BaseStorage.hh>

Public Member Functions

 BaseStoreWrapper (UStorePtr _store)
 
virtual ~BaseStoreWrapper ()
 
virtual bool Add (TPtr _object)
 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. More...
 
virtual bool Contains (ConstTPtr _object) const
 Determine if store contains the given element. More...
 
virtual bool ContainsId (unsigned int _id) const
 Determine if store contains the element with the given ID. More...
 
virtual bool ContainsName (const std::string &_name) const
 Determine if store contains the element with the given name. More...
 
virtual void Destroy (TPtr _object)
 Remove and destroy given element. If the given element does not exists, in this store, then no work will be done. More...
 
virtual void DestroyAll ()
 Remove and destroy all elements in store. More...
 
virtual void DestroyById (unsigned int _id)
 Remove and destroy element with the given ID. If the specified element does not exists in this store, then no work will be done. More...
 
virtual void DestroyByIndex (unsigned int _index)
 Remove and destroy element at the given index. If the specified element does not exists in this store, then no work will be done. More...
 
virtual void DestroyByName (const std::string &_name)
 Remove and destroy element with the given name. If the specified element does not exists in this store, then no work will be done. More...
 
virtual TPtr GetById (unsigned int _id) const
 Get element with the given ID. More...
 
virtual TPtr GetByIndex (unsigned int _index) const
 Get element at the given index. More...
 
virtual TPtr GetByName (const std::string &_name) const
 Get element with the given name. More...
 
virtual TPtr Remove (TPtr _object)
 Remove given element. If the given element does not exists in this store, then no work will be done. More...
 
virtual void RemoveAll ()
 Remove all elements from store. More...
 
virtual TPtr RemoveById (unsigned int _id)
 Remove element with the given ID. If the specified element does not exists in this store, then no work will be done. More...
 
virtual TPtr RemoveByIndex (unsigned int _index)
 Remove element at the given index. If the specified element does not exists in this store, then no work will be done. More...
 
virtual TPtr RemoveByName (const std::string &_name)
 Remove element with the given name. If the specified element does not exists in this store, then no work will be done. More...
 
virtual unsigned int Size () const
 Get number of elements in this store. More...
 
- Public Member Functions inherited from StoreWrapper< T, U >
virtual ~StoreWrapper ()
 
- Public Member Functions inherited from Store< T >
virtual ~Store ()
 Deconstructor. More...
 

Protected Attributes

UStorePtr store
 

Constructor & Destructor Documentation

◆ BaseStoreWrapper()

BaseStoreWrapper ( UStorePtr  _store)
explicit

◆ ~BaseStoreWrapper()

~BaseStoreWrapper
virtual

Member Function Documentation

◆ Add()

bool Add ( TPtr  _object)
virtual

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.

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

Implements Store< T >.

◆ Contains()

bool Contains ( ConstTPtr  _object) const
virtual

Determine if store contains the given element.

Parameters
[in]_objectThe element in question
Returns
True if this store contains the given element

Implements Store< T >.

◆ ContainsId()

bool ContainsId ( unsigned int  _id) const
virtual

Determine if store contains the element with the given ID.

Parameters
[in]_idID of the element in question
Returns
True if this store contains the specified element

Implements Store< T >.

◆ ContainsName()

bool ContainsName ( const std::string _name) const
virtual

Determine if store contains the element with the given name.

Parameters
[in]_nameName of the element in question
Returns
True if this store contains the specified element

Implements Store< T >.

◆ Destroy()

void Destroy ( TPtr  _object)
virtual

Remove and destroy given element. If the given element does not exists, in this store, then no work will be done.

Parameters
[in]_objectElement to be removed

Implements Store< T >.

◆ DestroyAll()

void DestroyAll ( )
virtual

Remove and destroy all elements in store.

Implements Store< T >.

◆ DestroyById()

void DestroyById ( unsigned int  _id)
virtual

Remove and destroy element with the given ID. If the specified element does not exists in this store, then no work will be done.

Parameters
[in]_idID of the element to be removed

Implements Store< T >.

◆ DestroyByIndex()

void DestroyByIndex ( unsigned int  _index)
virtual

Remove and destroy element at the given index. If the specified element does not exists in this store, then no work will be done.

Parameters
[in]_indexIndex of the element to be removed

Implements Store< T >.

◆ DestroyByName()

void DestroyByName ( const std::string _name)
virtual

Remove and destroy element with the given name. If the specified element does not exists in this store, then no work will be done.

Parameters
[in]_nameName of the element to be removed

Implements Store< T >.

◆ GetById()

BaseStoreWrapper< T, U >::TPtr GetById ( unsigned int  _id) const
virtual

Get element with the given ID.

Parameters
[in]_idID of the desired element
Returns
The specified element

Implements Store< T >.

◆ GetByIndex()

BaseStoreWrapper< T, U >::TPtr GetByIndex ( unsigned int  _index) const
virtual

Get element at the given index.

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

Implements Store< T >.

◆ GetByName()

BaseStoreWrapper< T, U >::TPtr GetByName ( const std::string _name) const
virtual

Get element with the given name.

Parameters
[in]_nameName of the desired element
Returns
The specified element

Implements Store< T >.

◆ Remove()

BaseStoreWrapper< T, U >::TPtr Remove ( TPtr  _object)
virtual

Remove given element. If the given element does not exists in this store, then no work will be done.

Parameters
[in]_objectElement to be removed
Returns
The removed element

Implements Store< T >.

◆ RemoveAll()

void RemoveAll ( )
virtual

Remove all elements from store.

Implements Store< T >.

◆ RemoveById()

BaseStoreWrapper< T, U >::TPtr RemoveById ( unsigned int  _id)
virtual

Remove element with the given ID. If the specified element does not exists in this store, then no work will be done.

Parameters
[in]_idID of the element to be removed
Returns
The removed element

Implements Store< T >.

◆ RemoveByIndex()

BaseStoreWrapper< T, U >::TPtr RemoveByIndex ( unsigned int  _index)
virtual

Remove element at the given index. If the specified element does not exists in this store, then no work will be done.

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

Implements Store< T >.

◆ RemoveByName()

BaseStoreWrapper< T, U >::TPtr RemoveByName ( const std::string _name)
virtual

Remove element with the given name. If the specified element does not exists in this store, then no work will be done.

Parameters
[in]_nameName of the element to be removed
Returns
The removed element

Implements Store< T >.

◆ Size()

unsigned int Size ( ) const
virtual

Get number of elements in this store.

Returns
The number of elements in this store

Implements Store< T >.

Member Data Documentation

◆ store

UStorePtr store
protected

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