com::apama::engine::EngineStatus::StatusIterator Class Reference

A class used for the iterating through all status items. More...

#include <engine_client_cpp.hpp>

Inherits iterator< std::forward_iterator_tag, int >.

Public Types
typedef pair< std::string, std::string >	pair_t
	element type More...

Public Member Functions
	StatusIterator ()
	Default-constructed status iterator. More...
	~StatusIterator ()
	Destroy underling status iterator. More...
StatusIterator	operator++ (int dummy)
	(postfix) increment this iterator More...
StatusIterator &	operator++ ()
	(prefix) increment this iterator More...
bool	operator== (const StatusIterator &ref) const
	Returns true if two iterators point to the same item. More...
bool	operator!= (const StatusIterator &ref) const
	Returns false if two iterators point to the same item. More...
pair_t &	operator * ()
	Return a reference to the element pointed to. More...
pair_t *	operator-> ()
	Return a pointer to the element pointed to. More...
bool	valid ()
	Returns true if this is a valid iterator over status data. More...
	StatusIterator (const StatusIterator &ref)
	Copy constructor. More...
StatusIterator &	operator= (const StatusIterator &other)
	Copy assignment. More...

Detailed Description

A class used for the iterating through all status items.

Implements the ForwardIterator concept: http://en.cppreference.com/w/cpp/concept/ForwardIterator

Member Typedef Documentation

pair_t

typedef pair<std::string, std::string> com::apama::engine::EngineStatus::StatusIterator::pair_t

element type

Constructor & Destructor Documentation

StatusIterator() [1/2]

com::apama::engine::EngineStatus::StatusIterator::StatusIterator ( )

inline

Default-constructed status iterator.

Use EngineStatus::begin() to get a valid iterator

~StatusIterator()

com::apama::engine::EngineStatus::StatusIterator::~StatusIterator ( )

inline

Destroy underling status iterator.

StatusIterator() [2/2]

com::apama::engine::EngineStatus::StatusIterator::StatusIterator ( const StatusIterator &  ref )

inline

Copy constructor.

Member Function Documentation

operator *()

pair_t& com::apama::engine::EngineStatus::StatusIterator::operator * ( )

inline

Return a reference to the element pointed to.

operator!=()

bool com::apama::engine::EngineStatus::StatusIterator::operator!= ( const StatusIterator &  ref ) const

inline

Returns false if two iterators point to the same item.

operator++() [1/2]

StatusIterator com::apama::engine::EngineStatus::StatusIterator::operator++ ( int  dummy )

inline

(postfix) increment this iterator

operator++() [2/2]

EngineStatus::StatusIterator & com::apama::engine::EngineStatus::StatusIterator::operator++ ( )

inline

(prefix) increment this iterator

prefix ++

operator->()

pair_t* com::apama::engine::EngineStatus::StatusIterator::operator-> ( )

inline

Return a pointer to the element pointed to.

operator=()

StatusIterator& com::apama::engine::EngineStatus::StatusIterator::operator= ( const StatusIterator &  other )

inline

Copy assignment.

operator==()

bool com::apama::engine::EngineStatus::StatusIterator::operator== ( const StatusIterator &  ref ) const

inline

Returns true if two iterators point to the same item.

valid()

bool com::apama::engine::EngineStatus::StatusIterator::valid ( )

inline

Returns true if this is a valid iterator over status data.

---

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

• engine_client_cpp.hpp