cartobase  4.5.0
carto::DictionaryIteratorInterface Class Referenceabstract

Specialized IteratorInterface for dictionaries. More...

#include <cartobase/object/object.h>

Inheritance diagram for carto::DictionaryIteratorInterface:
Collaboration diagram for carto::DictionaryIteratorInterface:

Public Member Functions

virtual ~DictionaryIteratorInterface ()
 
virtual bool isDictionaryIterator () const
 Returns false if the stored object doesn't actually implement the DictionaryIteratorInterface API (needed since all GenericObject inherit this interface whatever they actually contain) More...
 
virtual std::string key () const =0
 Access the key of the current dictionary element. More...
 
- Public Member Functions inherited from carto::IteratorInterface
virtual ~IteratorInterface ()
 
virtual bool isIterator () const
 Returns false if the stored object doesn't actually implement the IteratorInterface API (needed since all GenericObject inherit this interface whatever they actually contain) More...
 
virtual bool isValid () const =0
 true if the iterator points to a valid value, false when the end of the iterable container has been reached More...
 
virtual Object currentValue () const =0
 Access the value of the element pointed to by the iterator. More...
 
virtual void next ()=0
 Point to the next element of the iterable container. More...
 
- Public Member Functions inherited from carto::Interface
virtual ~Interface ()
 

Detailed Description

Specialized IteratorInterface for dictionaries.

A dictionary element stores both a key (string) and a value (generic Object) (see DictionaryInterface)

Definition at line 263 of file object.h.

Constructor & Destructor Documentation

virtual carto::DictionaryIteratorInterface::~DictionaryIteratorInterface ( )
virtual

Member Function Documentation

virtual bool carto::DictionaryIteratorInterface::isDictionaryIterator ( ) const
virtual

Returns false if the stored object doesn't actually implement the DictionaryIteratorInterface API (needed since all GenericObject inherit this interface whatever they actually contain)

Reimplemented in carto::TypedObject< T >, and carto::TypedObject< SyntaxedInterfaceType< T > >.

virtual std::string carto::DictionaryIteratorInterface::key ( ) const
pure virtual

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