JTOOLS::JRouter< JAddress_t, true > Class Template Reference

Template specialisation of JRouter with default address comparison. More...

#include <JRouter.hh>

Inheritance diagram for JTOOLS::JRouter< JAddress_t, true >:

Classes
class	JAddress
	Simple data structure for validation of address. More...

Public Member Functions
	JRouter ()
	Default constructor. More...
	JRouter (argument_type address)
	Constructor. More...
bool	hasDefaultAddress () const
	Check availability of default address. More...
virtual const JAddress_t &	getDefaultAddress () const
	Get default address. More...
void	setDefaultAddress (argument_type address)
	Set default address. More...
bool	has (const int id) const
	Test whether given identifier has valid address (i.e identifier is in range and corresponding address is not equal to default address). More...
void	clear ()
	Clear. More...
void	copy (const JRouter &router, const bool option=true)
	Copy router. More...
void	put (const int id, argument_type address)
	Store address for given identifier. More...
bool	in_range (const int id) const
	Check whether given identifier is in range of this router. More...
const JAddress_t &	get (const int id) const
	Get address of given identifier. More...

Protected Attributes
int	first

Private Types
typedef JLANG::JClass < JAddress_t >::argument_type	argument_type

Private Attributes
JAddress	defaultAddress

Detailed Description

template<class JAddress_t>
class JTOOLS::JRouter< JAddress_t, true >

Template specialisation of JRouter with default address comparison.

Definition at line 166 of file JRouter.hh.

Member Typedef Documentation

template<class JAddress_t >

typedef JLANG::JClass<JAddress_t>::argument_type JTOOLS::JRouter< JAddress_t, true >::argument_type

private

Definition at line 170 of file JRouter.hh.

Constructor & Destructor Documentation

template<class JAddress_t >

JTOOLS::JRouter< JAddress_t, true >::JRouter ( )

inline

Default constructor.

Definition at line 243 of file JRouter.hh.

              :
      JRouter<JAddress_t, false>(),
      defaultAddress()
    {}

template<class JAddress_t >

JTOOLS::JRouter< JAddress_t, true >::JRouter ( argument_type  address )

inline

Constructor.

Parameters

address

default address

Definition at line 254 of file JRouter.hh.

                                   :
      JRouter<JAddress_t, false>(),
      defaultAddress(address)
    {}

Member Function Documentation

template<class JAddress_t >

bool JTOOLS::JRouter< JAddress_t, true >::hasDefaultAddress ( ) const

inline

Check availability of default address.

Returns

true if available; else false

Definition at line 265 of file JRouter.hh.

    {
      return defaultAddress.is_valid();
    }

template<class JAddress_t >

virtual const JAddress_t& JTOOLS::JRouter< JAddress_t, true >::getDefaultAddress ( ) const

inlinevirtual

Get default address.

Returns

default address

Reimplemented from JTOOLS::JRouter< JAddress_t, false >.

Definition at line 276 of file JRouter.hh.

    {
      return defaultAddress.getAddress();
    }

template<class JAddress_t >

void JTOOLS::JRouter< JAddress_t, true >::setDefaultAddress ( argument_type  address )

inline

Set default address.

Parameters

address

default address

Definition at line 287 of file JRouter.hh.

    {
      defaultAddress = JAddress(address);
    }

template<class JAddress_t >

bool JTOOLS::JRouter< JAddress_t, true >::has ( const int  id ) const

inline

Test whether given identifier has valid address (i.e identifier is in range and corresponding address is not equal to default address).

Parameters

id	identifier

Returns

true if identifier in range and address not equal to default; else false

Definition at line 299 of file JRouter.hh.

    {
      return (this->in_range(id) && !this->defaultAddress.equals(this->get(id)));
    }

template<class JAddress_t >

void JTOOLS::JRouter< JAddress_t, false >::clear ( )

inlineinherited

Clear.

Definition at line 71 of file JRouter.hh.

    {
      static_cast<std::deque<JAddress_t>&>(*this).clear();

      this->first = 0;
    }

template<class JAddress_t >

void JTOOLS::JRouter< JAddress_t, false >::copy ( const JRouter< JAddress_t, false > &  router, const bool  option = true  )

inlineinherited

Copy router.

Parameters

router	router
option	copy addresses

Definition at line 85 of file JRouter.hh.

    {
      if (option) {

        *this = router;

      } else {

        this->resize(router.size());
        this->first = router.first;
      }
    }

template<class JAddress_t >

void JTOOLS::JRouter< JAddress_t, false >::put ( const int  id, argument_type  address  )

inlineinherited

Store address for given identifier.

Parameters

id	identifier
address	address

Definition at line 105 of file JRouter.hh.

    {
      if (this->empty()) {

        this->push_back(address);
        
        this->first = id;
        
      } else if (id < this->first) {

        this->insert(this->begin(), this->first - id, getDefaultAddress());

        this->first = id;

        this->at(0) = address;

      } else {

        const size_t index = (size_t) (id - this->first);

        if (index >= this->size()) {
          this->resize(index + 1, getDefaultAddress());
        }

        this->at(index) = address;
      }
    }

template<class JAddress_t >

bool JTOOLS::JRouter< JAddress_t, false >::in_range ( const int  id ) const

inlineinherited

Check whether given identifier is in range of this router.

Parameters

id	identifier

Returns

true if in range; else false

Definition at line 140 of file JRouter.hh.

    {
      return (id >= this->first && id < this->first + (int) this->size());
    }

template<class JAddress_t >

const JAddress_t& JTOOLS::JRouter< JAddress_t, false >::get ( const int  id ) const

inlineinherited

Get address of given identifier.

Parameters

id	identifier

Returns

address

Definition at line 152 of file JRouter.hh.

    {
      return this->at(id - this->first);
    }

Member Data Documentation

template<class JAddress_t >

JAddress JTOOLS::JRouter< JAddress_t, true >::defaultAddress

private

Definition at line 306 of file JRouter.hh.

template<class JAddress_t >

int JTOOLS::JRouter< JAddress_t, false >::first

protectedinherited

Definition at line 158 of file JRouter.hh.

---

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

• JRouter.hh