Interface for enumerating the Jacks an object provides. More...

#include <C:/Trend/Development/Trax3/Code/trax/Jack.h>

Inheritance diagram for trax::JackEnumerator:

[legend]

Public Types
Type information for iterator implementation
typedef JackEnumerator	collection_type
typedef Jack	value_type

Public Member Functions

virtual int CountJacks () const =0

GetJack

Get one of the object's Jacks.

Parameters

name	idx The zero based index of the Jack.

Exceptions

std::range_error if idx is not in [0,SizeJacks()(

Jack & GetJack (int idx)

const Jack & GetJack (int idx) const

Protected Member Functions
	JackEnumerator (const JackEnumerator &)=default
	JackEnumerator (JackEnumerator &&)=default
JackEnumerator &	operator= (const JackEnumerator &)=default
JackEnumerator &	operator= (JackEnumerator &&)=default
virtual const Jack &	_GetJack (int idx) const =0

Detailed Description

Interface for enumerating the Jacks an object provides.

The interface can be retrieved by dynamic_cast for every object that provides Jacks. There is a begin/end pair of functions defined, that can get used for iterating, e.g. in a range-for loop.

Member Function Documentation

◆ CountJacks()

virtual int trax::JackEnumerator::CountJacks ( ) const

pure virtual

Returns: The total number of jacks available through this interface.

Implemented in trax::Plug_Imp, and trax::Sensor_Imp.

◆ GetJack() [1/2]

Jack & trax::JackEnumerator::GetJack ( int idx )

inline

Use only for iterating over the jacks.

◆ GetJack() [2/2]

const Jack & trax::JackEnumerator::GetJack ( int idx ) const