Bool Class Reference

#include <Bool.h>

List of all members.

---

Detailed Description

A watchable boolean.

Definition at line 64 of file Bool.h.

Public Member Functions
	Bool (char const *name)
	Construct a Bool with debug name name.
	Bool (Bool const &b)
	Copy constructor.
	~Bool ()
	Destructor.
void	print_name (std::ostream &os) const
	For debugging purposes. Write the (debug) name of this object to os.
void	add_event_server (boost::shared_ptr< ExpressionEventServer > const &event_server)
	Add event server to notification list.
void	sub_event_server (ExpressionEventServer *event_server)
	Remove event server from notification list.
Bool &	operator= (bool b)
	Assign bool value.
Bool &	operator= (Bool const &b)
	Assign Bool value.
BoolExpression< false >	operator* (void)
	Dereference operator. Returns this object as expression.
bool	value (void) const
	Returns underlying bool value.
Private Member Functions
void	changed_to (bool b)
	Called when the underlying boolean changes value to b.
Private Attributes
bool	M_value
	Underlaying bool value.
bool	M_being_destructed
	True when this object is being destructed.
std::set< boost::shared_ptr < ExpressionEventServer > >	M_event_servers
	List of Expression event servers that are watching this Bool.
char const *	M_name
	For debugging purposes; a human readable name for this object.
Friends
std::ostream &	operator<< (std::ostream &os, Bool const &b)
	Write Bool b to os.

---

Constructor & Destructor Documentation

Bool::Bool

(

char const *

name

)

[inline]

Construct a Bool with debug name name.

Definition at line 76 of file Bool.h.

: M_value(false), M_being_destructed(false), M_name(name) { }

Bool::Bool

(

Bool const &

b

)

[inline]

Copy constructor.

Definition at line 82 of file Bool.h.

                        : M_value(b.M_value), M_being_destructed(false)
#ifdef CWDEBUG
    , M_name(b.M_name)
#endif
        {
#ifdef CWDEBUG
          if (!b.M_event_servers.empty())
            Dout(dc::warning, "Copy-constructing a Bool that is being used by one or more ExpressionEventServer's");
#endif
        }

Bool::~Bool

(

)

Destructor.

Definition at line 35 of file Bool.cc.

References M_being_destructed, and M_event_servers.

{
  M_being_destructed = true;
  for (std::set<boost::shared_ptr<ExpressionEventServer> >::iterator iter = M_event_servers.begin();
       iter != M_event_servers.end(); ++iter)
    (*iter)->bool_destructed();
}

---

Member Function Documentation

void Bool::print_name

(

std::ostream &

os

)

const [inline]

For debugging purposes. Write the (debug) name of this object to os.

Definition at line 97 of file Bool.h.

Referenced by BoolExpression< inverted >::print_on().

{ os << M_name; }

void Bool::add_event_server

(

boost::shared_ptr< ExpressionEventServer > const &

event_server

)

[inline]

Add event server to notification list.

Definition at line 101 of file Bool.h.

References M_event_servers.

Referenced by BoolExpression< inverted >::add_event_server().

    {
      // If this Bool appears multiple times in one expression, we come here more than once.
      // However, since M_event_servers is a set<>, only the first time the event_server is really added.
      M_event_servers.insert(event_server);
    }

void Bool::sub_event_server

(

ExpressionEventServer *

event_server

)

[inline]

Remove event server from notification list.

Definition at line 109 of file Bool.h.

References M_being_destructed, and M_event_servers.

Referenced by BoolExpression< inverted >::sub_event_server_impl().

    {
      if (M_being_destructed)
        return;
      std::set<boost::shared_ptr<ExpressionEventServer> >::iterator iter = M_event_servers.begin();
      while (iter != M_event_servers.end())
      {
        if ((*iter).get() == event_server)
          break;
        ++iter;
      }
      // If this Bool appears multiple times in one expression, we come here more than once.
      if (iter != M_event_servers.end())
        M_event_servers.erase(iter);
    }

Bool& Bool::operator=

(

bool

b

)

[inline]

Assign bool value.

Definition at line 126 of file Bool.h.

References changed_to(), and M_value.

    {
      if (M_value != b)
        changed_to(b);
      return *this;
    }

Bool& Bool::operator=

(

Bool const &

b

)

[inline]

Assign Bool value.

Definition at line 134 of file Bool.h.

References changed_to(), and M_value.

    {
      if (M_value != b.M_value)
        changed_to(b.M_value);
      return *this;
    }

BoolExpression<false> Bool::operator*

(

void

)

[inline]

Dereference operator. Returns this object as expression.

Definition at line 142 of file Bool.h.

{ return BoolExpression<false>(*this); }

bool Bool::value

(

void

)

const [inline]

Returns underlying bool value.

Definition at line 145 of file Bool.h.

References M_value.

Referenced by BoolExpression< inverted >::evaluate_impl().

{ return M_value; }

void Bool::changed_to

(

bool

b

)

[private]

Called when the underlying boolean changes value to b.

Definition at line 23 of file Bool.cc.

References M_event_servers, and M_value.

Referenced by operator=().

{
  // The call to bool_changed might cause the expression to trigger.
  // Once handled, the expression is released and therefore the ExpressionEventServer
  // is removed from the set<>. Therefore we need to advance iter before
  // calling bool_changed().
  M_value = b;
  std::set<boost::shared_ptr<ExpressionEventServer> >::iterator iter = M_event_servers.begin();
  while (iter != M_event_servers.end())
    (*iter++)->bool_changed();
}

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		Bool const &	b
	)			[friend]

Write Bool b to os.

Definition at line 513 of file debug_ostream_operators.cc.

{
  return os << "{value:" << b.M_value << "; name:\"" << b.M_name << "\"}";
}

---

Member Data Documentation

bool Bool::M_value [private]

Underlaying bool value.

Definition at line 66 of file Bool.h.

Referenced by changed_to(), operator<<(), operator=(), and value().

bool Bool::M_being_destructed [private]

True when this object is being destructed.

Definition at line 67 of file Bool.h.

Referenced by sub_event_server(), and ~Bool().

std::set<boost::shared_ptr<ExpressionEventServer> > Bool::M_event_servers [private]

List of Expression event servers that are watching this Bool.

Definition at line 68 of file Bool.h.

Referenced by add_event_server(), changed_to(), sub_event_server(), and ~Bool().

char const* Bool::M_name [private]

For debugging purposes; a human readable name for this object.

Definition at line 70 of file Bool.h.

Referenced by operator<<().

---

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

• Bool.h
• Bool.cc