Template selector class. More...

#include <JSelector.hh>

Inheritance diagram for JTOOLS::JSelector< JKey_t, JBase_t >:

Public Types
typedef std::map< JKey_t, JAutoElement< JBase_t > >	map_type

typedef map_type::const_iterator	const_iterator

typedef map_type::iterator	iterator

typedef JLANG::JClass< JKey_t > ::argument_type	argument_type

typedef map_type::value_type	value_type

Public Member Functions
	JSelector ()
	Default constructor. More...

template<class JDerived_t >
void	insert (argument_type key, JType< JDerived_t > type)
	Insert data type at given key. More...

template<class JDerived_t >
void	insert (argument_type key)
	Insert data type at given key. More...

template<class JDerived_t >
void	insert (argument_type key, JDerived_t *p)
	Insert data type at given key. More...

JKey_t	getKey () const
	Get key. More...

bool	is_valid (argument_type key) const
	Check validy of given key. More...

bool	is_valid () const
	Check validy of selected key. More...

JBase_t &	get (argument_type key) const
	Get the object corresponding to the given key. More...

JBase_t &	get () const
	Get the object corresponding to the selected key. More...

Protected Attributes
JLANG::JParameter< JKey_t >	key

Friends
std::istream &	operator>> (std::istream &in, JSelector< JKey_t, JBase_t > &selector)
	Read selector from input stream. More...

std::ostream &	operator<< (std::ostream &out, const JSelector< JKey_t, JBase_t > &selector)
	Write selector to output stream. More...

Detailed Description

template<class JKey_t, class JBase_t>
class JTOOLS::JSelector< JKey_t, JBase_t >

Template selector class.

This class can be used to set up a list of keys that are mapped to handlers which create new objects by stream input operations.

Definition at line 275 of file JTools/JSelector.hh.

Member Typedef Documentation

template<class JKey_t, class JBase_t>

typedef std::map<JKey_t, JAutoElement<JBase_t> > JTOOLS::JSelector< JKey_t, JBase_t >::map_type

Definition at line 280 of file JTools/JSelector.hh.

template<class JKey_t, class JBase_t>

typedef map_type::const_iterator JTOOLS::JSelector< JKey_t, JBase_t >::const_iterator

Definition at line 281 of file JTools/JSelector.hh.

template<class JKey_t, class JBase_t>

typedef map_type::iterator JTOOLS::JSelector< JKey_t, JBase_t >::iterator

Definition at line 282 of file JTools/JSelector.hh.

template<class JKey_t, class JBase_t>

typedef JLANG::JClass<JKey_t>::argument_type JTOOLS::JSelector< JKey_t, JBase_t >::argument_type

Definition at line 283 of file JTools/JSelector.hh.

template<class JKey_t, class JBase_t>

typedef map_type::value_type JTOOLS::JSelector< JKey_t, JBase_t >::value_type

Definition at line 284 of file JTools/JSelector.hh.

Constructor & Destructor Documentation

template<class JKey_t, class JBase_t>

JTOOLS::JSelector< JKey_t, JBase_t >::JSelector ( )

inline

Default constructor.

Definition at line 290 of file JTools/JSelector.hh.

                 :
       map_type()
     {}

Member Function Documentation

template<class JKey_t, class JBase_t>

template<class JDerived_t >

void JTOOLS::JSelector< JKey_t, JBase_t >::insert	(	argument_type	key,
		JType< JDerived_t >	type
	)

inline

Insert data type at given key.

Parameters

key	key
type	data type

Definition at line 302 of file JTools/JSelector.hh.

     {
       map_type::insert(value_type(key, JAutoElement<JBase_t>(type)));
     }

template<class JKey_t, class JBase_t>

template<class JDerived_t >

void JTOOLS::JSelector< JKey_t, JBase_t >::insert ( argument_type key )

inline

Insert data type at given key.

Parameters

key key

Definition at line 314 of file JTools/JSelector.hh.

     {
       insert(key, JType<JDerived_t>());
     }

template<class JKey_t, class JBase_t>

template<class JDerived_t >

void JTOOLS::JSelector< JKey_t, JBase_t >::insert	(	argument_type	key,
		JDerived_t *	p
	)

inline

Insert data type at given key.

This object pointed to will become the default value.

Parameters

key	key
p	pointer to object

Definition at line 328 of file JTools/JSelector.hh.

     {
       this->key = key;
 
       map_type::insert(value_type(key, JAutoElement<JBase_t>(p)));
     }

template<class JKey_t, class JBase_t>

JKey_t JTOOLS::JSelector< JKey_t, JBase_t >::getKey ( ) const

inline

Get key.

Returns: key

Definition at line 341 of file JTools/JSelector.hh.

     {
       return this->key;
     }

template<class JKey_t, class JBase_t>

bool JTOOLS::JSelector< JKey_t, JBase_t >::is_valid ( argument_type key ) const

inline

Check validy of given key.

Parameters

key key

Returns: true if given key maps to a non-NULL value; else false

Definition at line 353 of file JTools/JSelector.hh.

     {
       const_iterator i = this->find(key);
 
       return i != this->end() && i->second.is_valid() && i->second.get()->is_valid();
     }

template<class JKey_t, class JBase_t>

bool JTOOLS::JSelector< JKey_t, JBase_t >::is_valid ( ) const

inline

Check validy of selected key.

Returns: true if selected key maps to a valid object; else false

Definition at line 366 of file JTools/JSelector.hh.

     {
       return key.isDefined() && is_valid(key);
     }

template<class JKey_t, class JBase_t>

JBase_t& JTOOLS::JSelector< JKey_t, JBase_t >::get ( argument_type key ) const

inline

Get the object corresponding to the given key.

Parameters

key key

Returns: object

Definition at line 378 of file JTools/JSelector.hh.

     {
       const_iterator i = this->find(key);
 
       if (i != this->end() && i->second.is_valid() && i->second.get()->is_valid())
         return *(i->second.get()->get());
       else
         throw JNullPointerException("JSelecor<>: no object.");
     }

template<class JKey_t, class JBase_t>

JBase_t& JTOOLS::JSelector< JKey_t, JBase_t >::get ( ) const

inline

Get the object corresponding to the selected key.

Returns: selected object

Definition at line 394 of file JTools/JSelector.hh.

     {
       if (key.isDefined())
         return this->get(key);
       else
         throw JNullPointerException("JSelecor<>: no selection.");
     }

Friends And Related Function Documentation

template<class JKey_t, class JBase_t>

std::istream& operator>>	(	std::istream &	in,
		JSelector< JKey_t, JBase_t > &	selector
	)

friend

Read selector from input stream.

Parameters

in	input stream
selector	selector

Returns: input stream

Definition at line 410 of file JTools/JSelector.hh.

     {
       if (in >> selector.key) {
 
         typename JSelector<JKey_t, JBase_t>::iterator i = selector.find(selector.key);
 
         if (i != selector.end() && i->second.is_valid())
           in >> i->second;
         else
           in.setstate(std::ios_base::failbit);
       }
       
       return in;
     }

template<class JKey_t, class JBase_t>

std::ostream& operator<<	(	std::ostream &	out,
		const JSelector< JKey_t, JBase_t > &	selector
	)

friend

Write selector to output stream.

Parameters

out	output stream
selector	selector

Returns: output stream

Definition at line 433 of file JTools/JSelector.hh.

     {
       if (selector.key.isDefined()) {
 
         typename JSelector<JKey_t, JBase_t>::const_iterator i = selector.find(selector.key);
         
         if (i != selector.end() && i->second.is_valid()) {
           return out << selector.key << ' ' << *(i->second);
         }
       }
 
       return out;
     }