Signal Class Reference

#include <Signal.hpp>

Inherits noncopyable.

Public Types
typedef boost::signals2::signal< void(XML::SignalFrame &) >	signal_type
	Signal underlying type. More...
typedef boost::signals2::connection	connection_type
	Signal connection type. More...
typedef signal_type::slot_type	slot_type
	Signal slot type. More...

Public Member Functions
	Signal (const std::string &name)
	constuctor initializes signal with its name More...
virtual	~Signal ()
	destructor More...
MUTATORS
Signal &	description (const std::string &desc)
	sets the description of this signal More...
Signal &	pretty_name (const std::string &name)
	sets the pretty name of this signal More...
Signal &	read_only (bool is)
	sets if it is read only signal More...
Signal &	hidden (bool is)
	sets if it is read only signal More...
Signal &	signature (const Signal::slot_type &subscriber)
	connects to a subscribing signature More...
Signal &	connect (const Signal::slot_type &subscriber)
	connects to a subscribing slot More...
Signal &	connect (const Signal::slot_type &subscriber, ConnectionManager *mng)
ACCESSORS
signal_type *	signal ()
	access the signal More...
signal_type *	signature ()
	access the signature More...
std::string	name () const
	gets the name of this signal More...
std::string	description () const
	gets the description of this signal More...
std::string	pretty_name () const
	gets the pretty name of this signal More...
bool	is_read_only () const
	gets if it is read only signal More...
bool	is_hidden () const
	gets if it is read only signal More...

Private Attributes
boost::scoped_ptr< signal_type >	m_signal
	the boost signal object More...
boost::scoped_ptr< signal_type >	m_signature
	pointer to another signal that returns the signature of this signal More...
std::string	m_name
	signal name More...
std::string	m_description
	signal description More...
std::string	m_pretty_name
bool	m_is_read_only
bool	m_is_hidden
	if true, the signal is hidden from the user's view, but still callable More...

Detailed Description

Class that harbours the types handled by the SignalHandler

Author

Tiago Quintino

Definition at line 45 of file Signal.hpp.

Member Typedef Documentation

typedef boost::signals2::connection connection_type

Signal connection type.

Definition at line 52 of file Signal.hpp.

typedef boost::signals2::signal< void ( XML::SignalFrame& ) > signal_type

Signal underlying type.

Definition at line 50 of file Signal.hpp.

typedef signal_type::slot_type slot_type

Signal slot type.

Definition at line 54 of file Signal.hpp.

Constructor & Destructor Documentation

Signal

(

const std::string &

name

)

constuctor initializes signal with its name

Definition at line 27 of file Signal.cpp.

~Signal ( )

virtual

destructor

Definition at line 38 of file Signal.cpp.

Member Function Documentation

Signal & connect

(

const Signal::slot_type &

subscriber

)

connects to a subscribing slot

Definition at line 92 of file Signal.cpp.

Signal & connect	(	const Signal::slot_type &	subscriber,
		ConnectionManager *	mng
	)

connects to a subscribing slot and saves the connection on a ConnectionManager

Definition at line 98 of file Signal.cpp.

Signal & description

(

const std::string &

desc

)

sets the description of this signal

Definition at line 42 of file Signal.cpp.

std::string description

(

)

const

gets the description of this signal

Definition at line 72 of file Signal.cpp.

Signal & hidden

(

bool

is

)

sets if it is read only signal

Definition at line 61 of file Signal.cpp.

bool is_hidden

(

)

const

gets if it is read only signal

Definition at line 90 of file Signal.cpp.

bool is_read_only

(

)

const

gets if it is read only signal

Definition at line 88 of file Signal.cpp.

std::string name

(

)

const

gets the name of this signal

Definition at line 67 of file Signal.cpp.

Signal & pretty_name

(

const std::string &

name

)

sets the pretty name of this signal

Definition at line 48 of file Signal.cpp.

std::string pretty_name

(

)

const

gets the pretty name of this signal

Definition at line 80 of file Signal.cpp.

Signal & read_only

(

bool

is

)

sets if it is read only signal

Definition at line 55 of file Signal.cpp.

signal_type* signal ( )

inline

access the signal

Definition at line 93 of file Signal.hpp.

Signal & signature

(

const Signal::slot_type &

subscriber

)

connects to a subscribing signature

Definition at line 107 of file Signal.cpp.

signal_type* signature ( )

inline

access the signature

Definition at line 95 of file Signal.hpp.

Member Data Documentation

std::string m_description

private

signal description

Definition at line 120 of file Signal.hpp.

bool m_is_hidden

private

if true, the signal is hidden from the user's view, but still callable

Definition at line 128 of file Signal.hpp.

bool m_is_read_only

private

if true, the signal is considered as read-only and might be called during another signal execution. Default value is false.

Definition at line 126 of file Signal.hpp.

std::string m_name

private

signal name

Definition at line 118 of file Signal.hpp.

std::string m_pretty_name

private

signal readable name (used by the GUI). For exemple, if key is "set_options", readable should be "Set options".

Definition at line 123 of file Signal.hpp.

boost::scoped_ptr< signal_type > m_signal

private

the boost signal object

Definition at line 114 of file Signal.hpp.

boost::scoped_ptr< signal_type > m_signature

private

pointer to another signal that returns the signature of this signal

Definition at line 116 of file Signal.hpp.

---

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

• cf3/common/Signal.hpp
• cf3/common/Signal.cpp