JTOOLS::JPair< JKey_t, JValue_t > Class Template Reference

Template specialisation for a pair of values. More...

#include <JPair.hh>

Inheritance diagram for JTOOLS::JPair< JKey_t, JValue_t >:

Public Types
typedef JKey_t	key_type
typedef JValue_t	mapped_type

Public Member Functions
	JPair ()
	Default constructor. More...
	JPair (typename JLANG::JClass< key_type >::argument_type key, typename JLANG::JClass< mapped_type >::argument_type value)
	Constructor. More...
const key_type &	getKey () const
const mapped_type &	getValue () const
mapped_type &	getValue ()

Public Attributes
JKey_t	first
JValue_t	second

Friends
std::istream &	operator>> (std::istream &in, JPair< JKey_t, JValue_t > &pair)
	Read pair from input. More...
std::ostream &	operator<< (std::ostream &out, const JPair< JKey_t, JValue_t > &pair)
	Write pair to output. More...
JReader &	operator>> (JReader &in, JPair< JKey_t, JValue_t > &pair)
	Read pair from input. More...
JWriter &	operator<< (JWriter &out, const JPair< JKey_t, JValue_t > &pair)
	Write pair to output. More...

Detailed Description

template<class JKey_t, class JValue_t>
class JTOOLS::JPair< JKey_t, JValue_t >

Template specialisation for a pair of values.

Definition at line 28 of file JPair.hh.

Member Typedef Documentation

template<class JKey_t, class JValue_t>

typedef JKey_t JTOOLS::JPair< JKey_t, JValue_t >::key_type

Definition at line 32 of file JPair.hh.

template<class JKey_t, class JValue_t>

typedef JValue_t JTOOLS::JPair< JKey_t, JValue_t >::mapped_type

Definition at line 33 of file JPair.hh.

Constructor & Destructor Documentation

template<class JKey_t, class JValue_t>

JTOOLS::JPair< JKey_t, JValue_t >::JPair ( )

inline

Default constructor.

Definition at line 39 of file JPair.hh.

            :
      first (),
      second()
    {}

template<class JKey_t, class JValue_t>

JTOOLS::JPair< JKey_t, JValue_t >::JPair ( typename JLANG::JClass< key_type >::argument_type  key, typename JLANG::JClass< mapped_type >::argument_type  value  )

inline

Constructor.

Parameters

key	JKey_t
value	JValue_t

Definition at line 51 of file JPair.hh.

                                                                :
      first (key),
      second(value)
    {}

Member Function Documentation

template<class JKey_t, class JValue_t>

const key_type& JTOOLS::JPair< JKey_t, JValue_t >::getKey ( ) const

inline

Definition at line 123 of file JPair.hh.

{ return this->first; }

template<class JKey_t, class JValue_t>

const mapped_type& JTOOLS::JPair< JKey_t, JValue_t >::getValue ( ) const

inline

Definition at line 124 of file JPair.hh.

{ return this->second; }

template<class JKey_t, class JValue_t>

mapped_type& JTOOLS::JPair< JKey_t, JValue_t >::getValue ( )

inline

Definition at line 126 of file JPair.hh.

{ return this->second; }

Friends And Related Function Documentation

template<class JKey_t, class JValue_t>

std::istream& operator>> ( std::istream &  in, JPair< JKey_t, JValue_t > &  pair  )

friend

Read pair from input.

Parameters

in	input stream
pair	pair

Returns

input stream

Definition at line 65 of file JPair.hh.

    {
      in >> pair.first;
      in >> pair.second;

      return in;
    }

template<class JKey_t, class JValue_t>

std::ostream& operator<< ( std::ostream &  out, const JPair< JKey_t, JValue_t > &  pair  )

friend

Write pair to output.

Parameters

out	output stream
pair	pair

Returns

output stream

Definition at line 81 of file JPair.hh.

    {
      out << pair.first;
      out << ' ';
      out << pair.second;

      return out;
    }

template<class JKey_t, class JValue_t>

JReader& operator>> ( JReader &  in, JPair< JKey_t, JValue_t > &  pair  )

friend

Read pair from input.

Parameters

in	reader
pair	pair

Returns

reader

Definition at line 98 of file JPair.hh.

    {
      in >> pair.first;
      in >> pair.second;

      return in;
    }

template<class JKey_t, class JValue_t>

JWriter& operator<< ( JWriter &  out, const JPair< JKey_t, JValue_t > &  pair  )

friend

Write pair to output.

Parameters

out	writer
pair	pair

Returns

writer

Definition at line 114 of file JPair.hh.

    {
      out << pair.first;
      out << pair.second;

      return out;
    }

Member Data Documentation

template<class JKey_t, class JValue_t>

JKey_t JTOOLS::JPair< JKey_t, JValue_t >::first

Definition at line 128 of file JPair.hh.

template<class JKey_t, class JValue_t>

JValue_t JTOOLS::JPair< JKey_t, JValue_t >::second

Definition at line 129 of file JPair.hh.

---

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

• JPair.hh