Parma_Polyhedra_Library::Threshold_Watcher< Traits > Class Template Reference

A class of watchdogs controlling the exceeding of a threshold. More...

#include <Threshold_Watcher_defs.hh>

Collaboration diagram for Parma_Polyhedra_Library::Threshold_Watcher< Traits >:

Classes
struct	Initialize

Public Member Functions
template<typename Flag_Base , typename Flag >
	Threshold_Watcher (const typename Traits::Delta &delta, const Flag_Base *volatile &holder, Flag &flag)
	Threshold_Watcher (const typename Traits::Delta &delta, void(*function)())
	~Threshold_Watcher ()

Private Types
typedef Implementation::Watchdog::Pending_List< Traits >	TW_Pending_List
typedef Implementation::Watchdog::Handler	TW_Handler

Private Member Functions
	Threshold_Watcher (const Threshold_Watcher &)
Threshold_Watcher &	operator= (const Threshold_Watcher &)

Static Private Member Functions
static TW_Pending_List::iterator	add_threshold (typename Traits::Threshold threshold, const TW_Handler &handler, bool &expired_flag)
static TW_Pending_List::iterator	remove_threshold (typename TW_Pending_List::iterator position)
static void	check ()
	Check threshold reaching. More...

Private Attributes
bool	expired
const TW_Handler &	handler
TW_Pending_List::iterator	pending_position

Static Private Attributes
static Initialize	init

Detailed Description

template<typename Traits>
class Parma_Polyhedra_Library::Threshold_Watcher< Traits >

A class of watchdogs controlling the exceeding of a threshold.

Template Parameters

Traits

A class to set data types and functions for the threshold handling. See Parma_Polyhedra_Library::Weightwatch_Traits for an example.

Definition at line 40 of file Threshold_Watcher_defs.hh.

Member Typedef Documentation

template<typename Traits >

typedef Implementation::Watchdog::Handler Parma_Polyhedra_Library::Threshold_Watcher< Traits >::TW_Handler

private

Definition at line 54 of file Threshold_Watcher_defs.hh.

template<typename Traits >

typedef Implementation::Watchdog::Pending_List<Traits> Parma_Polyhedra_Library::Threshold_Watcher< Traits >::TW_Pending_List

private

Definition at line 53 of file Threshold_Watcher_defs.hh.

Constructor & Destructor Documentation

template<typename Traits >

template<typename Flag_Base , typename Flag >

Parma_Polyhedra_Library::Threshold_Watcher< Traits >::Threshold_Watcher	(	const typename Traits::Delta &	delta,
		const Flag_Base *volatile &	holder,
		Flag &	flag
	)

Definition at line 35 of file Threshold_Watcher_inlines.hh.

  : expired(false),
    handler(*new
            Implementation::Watchdog::Handler_Flag<Flag_Base, Flag>(holder,
                                                                    flag)) {
  typename Traits::Threshold threshold;
  Traits::from_delta(threshold, delta);
  if (!Traits::less_than(Traits::get(), threshold)) {
    throw std::invalid_argument("Threshold_Watcher constructor called with a"
                                " threshold already reached");
  }
  pending_position = add_threshold(threshold, handler, expired);
}

template<typename Traits >

Parma_Polyhedra_Library::Threshold_Watcher< Traits >::Threshold_Watcher ( const typename Traits::Delta &  delta, void(*)()  function  )

inline

Definition at line 54 of file Threshold_Watcher_inlines.hh.

  : expired(false),
    handler(*new Implementation::Watchdog::Handler_Function(function)) {
  typename Traits::Threshold threshold;
  Traits::from_delta(threshold, delta);
  if (!Traits::less_than(Traits::get(), threshold)) {
    throw std::invalid_argument("Threshold_Watcher constructor called with a"
                                " threshold already reached");
  }
  pending_position = add_threshold(threshold, handler, expired);
}

template<typename Traits >

Parma_Polyhedra_Library::Threshold_Watcher< Traits >::~Threshold_Watcher

(

)

Definition at line 50 of file Threshold_Watcher_templates.hh.

                                              {
  if (!expired) {
    remove_threshold(pending_position);
  }
  delete &handler;
}

template<typename Traits >

Parma_Polyhedra_Library::Threshold_Watcher< Traits >::Threshold_Watcher ( const Threshold_Watcher< Traits > &  )

private

Member Function Documentation

template<typename Traits >

Threshold_Watcher< Traits >::TW_Pending_List::iterator Parma_Polyhedra_Library::Threshold_Watcher< Traits >::add_threshold ( typename Traits::Threshold  threshold, const TW_Handler &  handler, bool &  expired_flag  )

staticprivate

Definition at line 31 of file Threshold_Watcher_templates.hh.

References Parma_Polyhedra_Library::Threshold_Watcher< Traits >::check().

                                                             {
  Traits::check_function = Threshold_Watcher::check;
  return init.pending.insert(threshold, handler, expired_flag);
}

template<typename Traits >

void Parma_Polyhedra_Library::Threshold_Watcher< Traits >::check ( )

staticprivate

Check threshold reaching.

Definition at line 59 of file Threshold_Watcher_templates.hh.

Referenced by Parma_Polyhedra_Library::Threshold_Watcher< Traits >::add_threshold().

                                 {
  typename TW_Pending_List::iterator i = init.pending.begin();
  assert(i != init.pending.end());
  const typename Traits::Threshold& current = Traits::get();
  while (!Traits::less_than(current, i->deadline())) {
    i->handler().act();
    i->expired_flag() = true;
    i = remove_threshold(i);
    if (i == init.pending.end()) {
      break;
    }
  }
}

template<typename Traits >

Threshold_Watcher& Parma_Polyhedra_Library::Threshold_Watcher< Traits >::operator= ( const Threshold_Watcher< Traits > &  )

private

template<typename Traits >

Threshold_Watcher< Traits >::TW_Pending_List::iterator Parma_Polyhedra_Library::Threshold_Watcher< Traits >::remove_threshold ( typename TW_Pending_List::iterator  position )

staticprivate

Definition at line 41 of file Threshold_Watcher_templates.hh.

                                                            {
  typename TW_Pending_List::iterator i = init.pending.erase(position);
  if (init.pending.empty()) {
    Traits::check_function = 0;
  }
  return i;
}

Member Data Documentation

template<typename Traits >

bool Parma_Polyhedra_Library::Threshold_Watcher< Traits >::expired

private

Definition at line 56 of file Threshold_Watcher_defs.hh.

template<typename Traits >

const TW_Handler& Parma_Polyhedra_Library::Threshold_Watcher< Traits >::handler

private

Definition at line 57 of file Threshold_Watcher_defs.hh.

template<typename Traits >

Parma_Polyhedra_Library::Threshold_Watcher< Traits >::Initialize Parma_Polyhedra_Library::Threshold_Watcher< Traits >::init

staticprivate

Definition at line 68 of file Threshold_Watcher_defs.hh.

template<typename Traits >

TW_Pending_List::iterator Parma_Polyhedra_Library::Threshold_Watcher< Traits >::pending_position

private

Definition at line 58 of file Threshold_Watcher_defs.hh.

---

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

• Threshold_Watcher_defs.hh
• Threshold_Watcher_inlines.hh
• Threshold_Watcher_templates.hh