JTOOLS::JSelector< JKey_t, JBase_t > Class Template Reference

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.
template<class JDerived_t >
void	insert (argument_type key, JType< JDerived_t > type)
	Insert data type at given key.
template<class JDerived_t >
void	insert (argument_type key)
	Insert data type at given key.
template<class JDerived_t >
void	insert (argument_type key, JDerived_t *p)
	Insert data type at given key.
JKey_t	getKey () const
	Get key.
bool	is_valid (argument_type key) const
	Check validy of given key.
bool	is_valid () const
	Check validy of selected key.
JBase_t &	get (argument_type key) const
	Get the object corresponding to the given key.
JBase_t &	get () const
	Get the object corresponding to the selected key.

Protected Attributes
JParameter< JKey_t >	key

Friends
std::istream &	operator>> (std::istream &in, JSelector< JKey_t, JBase_t > &selector)
	Read selector from input stream.
std::ostream &	operator<< (std::ostream &out, const JSelector< JKey_t, JBase_t > &selector)
	Write selector to output stream.

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 268 of file JTools/JSelector.hh.

Member Typedef Documentation

map_type

template<class JKey_t , class JBase_t >

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

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

const_iterator

template<class JKey_t , class JBase_t >

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

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

iterator

template<class JKey_t , class JBase_t >

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

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

argument_type

template<class JKey_t , class JBase_t >

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

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

value_type

template<class JKey_t , class JBase_t >

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

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

Constructor & Destructor Documentation

JSelector()

template<class JKey_t , class JBase_t >

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

inline

Default constructor.

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

                :
      map_type()
    {}

Member Function Documentation

insert() [1/3]

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 295 of file JTools/JSelector.hh.

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

insert() [2/3]

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 307 of file JTools/JSelector.hh.

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

insert() [3/3]

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 321 of file JTools/JSelector.hh.

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

getKey()

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 334 of file JTools/JSelector.hh.

    {
      return this->key;
    }

is_valid() [1/2]

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 346 of file JTools/JSelector.hh.

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

is_valid() [2/2]

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 359 of file JTools/JSelector.hh.

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

get() [1/2]

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 371 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.");
    }

get() [2/2]

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 387 of file JTools/JSelector.hh.

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

Friends And Related Symbol Documentation

operator>>

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 403 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;
    }

operator<<

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 426 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;
    }

Member Data Documentation

key

template<class JKey_t , class JBase_t >

JParameter<JKey_t> JTOOLS::JSelector< JKey_t, JBase_t >::key

protected

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

---

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

• JTools/JSelector.hh