Public Member Functions

zeus::IPair< T1, T2 > Class Template Reference

#include <IPair.hpp>

Inheritance diagram for zeus::IPair< T1, T2 >:
zeus::IValueType zeus::TPair< T1, T2 > zeus::TProperty

List of all members.

Public Member Functions

virtual void MQUALIFIER assign (const IPair< T1, T2 > &rPair)=0
virtual bool MQUALIFIER equals (const IPair< T1, T2 > &rPair) const =0
virtual bool MQUALIFIER equalsFirst (const T1 &rInPar) const =0
virtual bool MQUALIFIER equalsSecond (const T2 &rInPar) const =0
virtual T1 &MQUALIFIER getFirst ()=0
virtual const T1 &MQUALIFIER getFirstConst () const =0
virtual T2 &MQUALIFIER getSecond ()=0
virtual const T2 &MQUALIFIER getSecondConst () const =0
virtual void MQUALIFIER setFirst (const T1 &rInPar)=0
virtual void MQUALIFIER setSecond (const T2 &rInPar)=0
virtual void MQUALIFIER setPair (const T1 &rInPar1, const T2 &rInPar2)=0

Detailed Description

template<class T1, class T2>
class zeus::IPair< T1, T2 >

Defines a stack interface for pair types. A pair is an object containing a first argument and a second argument


Member Function Documentation

template<class T1, class T2>
virtual void MQUALIFIER zeus::IPair< T1, T2 >::assign ( const IPair< T1, T2 > &  rPair ) [pure virtual]

Assigns a new value object

Parameters:
rPair: Pair object to assign

Implemented in zeus::TPair< T1, T2 >.

template<class T1, class T2>
virtual bool MQUALIFIER zeus::IPair< T1, T2 >::equals ( const IPair< T1, T2 > &  rPair ) const [pure virtual]

checks if two pair objects are equal

Parameters:
rPair: Pair object to check
Return values:
true: Object content is equal
false,:Object content is different

Implemented in zeus::TPair< T1, T2 >.

template<class T1, class T2>
virtual bool MQUALIFIER zeus::IPair< T1, T2 >::equalsFirst ( const T1 &  rInPar ) const [pure virtual]

checks if the first value equals to the rInPar

Parameters:
rInPar: value to check
Return values:
true: first value is equal
false,:first value is different

Implemented in zeus::TPair< T1, T2 >.

template<class T1, class T2>
virtual bool MQUALIFIER zeus::IPair< T1, T2 >::equalsSecond ( const T2 &  rInPar ) const [pure virtual]

checks if the second value equals to the rInPar

Parameters:
rInPar: value to check
Return values:
true: second value is equal
false,:second value is different

Implemented in zeus::TPair< T1, T2 >.

template<class T1, class T2>
virtual T1& MQUALIFIER zeus::IPair< T1, T2 >::getFirst (  ) [pure virtual]

Returns the first value of the pair. This method is also needed to change the content of the first value, there fore this method is not const. Use getFirstConst() for reading access.

Implemented in zeus::TPair< T1, T2 >, and zeus::TProperty.

template<class T1, class T2>
virtual const T1& MQUALIFIER zeus::IPair< T1, T2 >::getFirstConst (  ) const [pure virtual]

Returns the first value of the pair.

Implemented in zeus::TPair< T1, T2 >, and zeus::TProperty.

template<class T1, class T2>
virtual T2& MQUALIFIER zeus::IPair< T1, T2 >::getSecond (  ) [pure virtual]

Returns the second value of the pair. This method is also needed to change the content of the second value, there fore this method is not const. Use getSecondConst() for reading access.

Implemented in zeus::TPair< T1, T2 >, and zeus::TProperty.

template<class T1, class T2>
virtual const T2& MQUALIFIER zeus::IPair< T1, T2 >::getSecondConst (  ) const [pure virtual]

Returns the second value of the pair.

Implemented in zeus::TPair< T1, T2 >, and zeus::TProperty.

template<class T1, class T2>
virtual void MQUALIFIER zeus::IPair< T1, T2 >::setFirst ( const T1 &  rInPar ) [pure virtual]

Sets the first value of the pair.

Parameters:
rInPar: value to set

Implemented in zeus::TPair< T1, T2 >.

template<class T1, class T2>
virtual void MQUALIFIER zeus::IPair< T1, T2 >::setPair ( const T1 &  rInPar1,
const T2 &  rInPar2 
) [pure virtual]

Sets a new pair of values to this pair object

Parameters:
rInPar1: first value
rInPar2: second value

Implemented in zeus::TPair< T1, T2 >.

template<class T1, class T2>
virtual void MQUALIFIER zeus::IPair< T1, T2 >::setSecond ( const T2 &  rInPar ) [pure virtual]

Sets the second value of the pair.

Parameters:
rInPar: value to set

Implemented in zeus::TPair< T1, T2 >.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Sun Jan 22 2012 15:28:35