casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Types | Private Attributes
casa::OrderedPair< K, V > Class Template Reference

Ordered pair class. More...

#include <OrderedPair.h>

List of all members.

Public Member Functions

 OrderedPair ()
 Needed for "operator>>(AipsIO &ios, Slist<elem> &list)".
 OrderedPair (const K &k, const V &v)
 This is the "standard" constructor which takes a key and a value and constructs an ordered pair.
 OrderedPair (const OrderedPair< K, V > &that)
 Copy constructor (copy semantics).
OrderedPair< K, V > & operator= (const OrderedPair< K, V > &that)
 Assignment (copy semantics).
K & x ()
 Get access to the key or value.
const K & x () const
V & y ()
const V & y () const

Private Types

enum  { OrderedPairVersion }

Private Attributes

Key
 
     

Val

Detailed Description

template<class K, class V>
class casa::OrderedPair< K, V >

Ordered pair class.

Review Status

Reviewed By:
UNKNOWN
Date Reviewed:
before2004/08/25

Intended use:

Internal

Synopsis

This class is a simple class used in the Map<key,value> classes to manage key/value pairs for maps. The default constructor is needed for use in containers. This implies that ALL classes ever used in OrderedPair should have a default constructor!!!!


Note: This should probably be cleaned up in the future and made into a generally useful class;

Definition at line 57 of file OrderedPair.h.


Member Enumeration Documentation

template<class K, class V>
anonymous enum [private]
Enumerator:
OrderedPairVersion 

Definition at line 93 of file OrderedPair.h.


Constructor & Destructor Documentation

template<class K, class V>
casa::OrderedPair< K, V >::OrderedPair ( )

Needed for "operator>>(AipsIO &ios, Slist<elem> &list)".

template<class K, class V>
casa::OrderedPair< K, V >::OrderedPair ( const K &  k,
const V &  v 
)

This is the "standard" constructor which takes a key and a value and constructs an ordered pair.

template<class K, class V>
casa::OrderedPair< K, V >::OrderedPair ( const OrderedPair< K, V > &  that)

Copy constructor (copy semantics).


Member Function Documentation

template<class K, class V>
OrderedPair<K,V>& casa::OrderedPair< K, V >::operator= ( const OrderedPair< K, V > &  that)

Assignment (copy semantics).

template<class K, class V>
K& casa::OrderedPair< K, V >::x ( ) [inline]

Get access to the key or value.

Definition at line 83 of file OrderedPair.h.

template<class K, class V>
const K& casa::OrderedPair< K, V >::x ( ) const [inline]

Definition at line 84 of file OrderedPair.h.

template<class K, class V>
V& casa::OrderedPair< K, V >::y ( ) [inline]

Definition at line 85 of file OrderedPair.h.

template<class K, class V>
const V& casa::OrderedPair< K, V >::y ( ) const [inline]

Definition at line 86 of file OrderedPair.h.


Member Data Documentation

template<class K, class V>
K casa::OrderedPair< K, V >::Key [private]

     

Definition at line 90 of file OrderedPair.h.

Referenced by casa::OrderedPair< FunctionFactory< T > *, Bool >::x().

template<class K, class V>
V casa::OrderedPair< K, V >::Val [private]

Definition at line 91 of file OrderedPair.h.

Referenced by casa::OrderedPair< FunctionFactory< T > *, Bool >::y().


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