Gazebo Rendering

API Reference

8.2.1
BaseVisualStore< T > Class Template Reference

#include <BaseStorage.hh>

Additional Inherited Members

- Public Member Functions inherited from BaseStore< Visual, T >
 BaseStore ()
 
virtual ~BaseStore ()
 
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 AddDerived (UPtr _object)
 
virtual UIter Begin ()
 Return an iterator to the beginning. 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 UPtr DerivedById (unsigned int _id) const
 
virtual UPtr DerivedByIndex (unsigned int _index) const
 
virtual UPtr DerivedByName (const std::string &_name) const
 
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 UIter End ()
 Return an iterator to the end. 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 UPtr RemoveDerived (UPtr _object)
 
virtual UPtr RemoveDerivedById (unsigned int _id)
 
virtual UPtr RemoveDerivedByIndex (unsigned int _index)
 
virtual UPtr RemoveDerivedByName (const std::string &_name)
 
virtual unsigned int Size () const
 Get number of elements in this store. More...
 
- Public Member Functions inherited from Store< T >
virtual ~Store ()=default
 Destructor. More...
 
- Protected Member Functions inherited from BaseStore< Visual, T >
virtual bool AddImpl (UPtr _object)
 
virtual ConstUIter ConstIter (ConstTPtr _object) const
 Get a const iterator to the object by pointer. Note that the iterator may change or become invalid when objects are added to / removed from the store. More...
 
virtual ConstUIter ConstIterById (unsigned int _id) const
 Get a const iterator to the object by id. Note that the iterator may change or become invalid when objects are added to / removed from the store. More...
 
virtual ConstUIter ConstIterByIndex (unsigned int _index) const
 Get a const iterator to the object by index. Note that the iterator may change or become invalid when objects are added to / removed from the store. More...
 
virtual ConstUIter ConstIterByName (const std::string &_name) const
 Get a const iterator to the object by name. Note that the iterator may change or become invalid when objects are added to / removed from the store. More...
 
virtual void DestroyImpl (UIter _iter)
 
virtual bool IsValidIter (ConstUIter _iter) const
 
virtual UIter Iter (ConstTPtr _object)
 Get an iterator to the object by pointer. Note that the iterator may change or become invalid when objects are added to / removed from the store. More...
 
virtual UIter IterById (unsigned int _id)
 Get an iterator to the object by id. Note that the iterator may change or become invalid when objects are added to / removed from the store. More...
 
virtual UIter IterByIndex (unsigned int _index)
 Get an iterator to the object by index. Note that the iterator may change or become invalid when objects are added to / removed from the store. More...
 
virtual UIter IterByName (const std::string &_name)
 Get an iterator to the object by name. Note that the iterator may change or become invalid when objects are added to / removed from the store. More...
 
virtual UIter RemoveConstness (ConstUIter _iter)
 
virtual UPtr RemoveImpl (UIter _iter)
 
- Protected Attributes inherited from BaseStore< Visual, T >
UStore store
 
UStoreMap storeMap
 

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