VSM C++ SDK
Vehicle Specific Modules SDK
ugcs::vsm::Properties::Iterator Class Reference

Stored properties iterator. More...

#include <properties.h>

Public Member Functions

 Iterator (const Table_type::const_iterator &iterator, const Table_type::const_iterator &end_iterator, const std::string &prefix=std::string(), char separator= '.')
 Construct new iterator which iterates values starting from the given prefix. More...
 
std::string operator* () const
 Get the value. More...
 
const std::string * operator-> () const
 Get the value. More...
 
bool operator== (const Iterator &it) const
 Equality check method. More...
 
bool operator!= (const Iterator &it) const
 Non-equality check method. More...
 
void operator++ ()
 Prefix increment operator. More...
 
void operator++ (int)
 Postfix increment operator. More...
 
std::string operator[] (size_t comp_idx)
 Get component of name with the specified index. More...
 
int Get_count ()
 

Detailed Description

Stored properties iterator.

Constructor & Destructor Documentation

ugcs::vsm::Properties::Iterator::Iterator ( const Table_type::const_iterator &  iterator,
const Table_type::const_iterator &  end_iterator,
const std::string &  prefix = std::string(),
char  separator = '.' 
)
inline

Construct new iterator which iterates values starting from the given prefix.

Parameters
iteratorStart from.
end_iteratorEnd.
prefixPrefix for filtering.
separatorPath nodes separator.

Member Function Documentation

bool ugcs::vsm::Properties::Iterator::operator!= ( const Iterator it) const
inline

Non-equality check method.

std::string ugcs::vsm::Properties::Iterator::operator* ( ) const
inline

Get the value.

void ugcs::vsm::Properties::Iterator::operator++ ( )

Prefix increment operator.

void ugcs::vsm::Properties::Iterator::operator++ ( int  )
inline

Postfix increment operator.

const std::string* ugcs::vsm::Properties::Iterator::operator-> ( ) const
inline

Get the value.

bool ugcs::vsm::Properties::Iterator::operator== ( const Iterator it) const
inline

Equality check method.

std::string ugcs::vsm::Properties::Iterator::operator[] ( size_t  comp_idx)

Get component of name with the specified index.

Components are separated by separator character specified in Properties::begin() method.

Parameters
comp_idxComponent index.
Returns
String for component.
Exceptions
Invalid_param_exceptionif index is out of range.

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