TOOL_EVENT_LIST Class Reference

A list of TOOL_EVENTs, with overloaded || operators allowing for concatenating TOOL_EVENTs with little code. More...

#include <tool_event.h>

Public Types
typedef TOOL_EVENT	value_type
typedef std::deque< TOOL_EVENT >::iterator	iterator
typedef std::deque< TOOL_EVENT >::const_iterator	const_iterator
	Default constructor. Creates an empty list. More...

Public Member Functions
	TOOL_EVENT_LIST ()
	Constructor for a list containing only one TOOL_EVENT. More...
	TOOL_EVENT_LIST (const TOOL_EVENT &aSingleEvent)
	Copy an existing TOOL_EVENT_LIST. More...
	TOOL_EVENT_LIST (const TOOL_EVENT_LIST &aEventList)
const std::string	Format () const
	Function Format() Returns information about event in form of a human-readable string. More...
OPT< const TOOL_EVENT & >	Matches (const TOOL_EVENT &aEvent) const
void	Add (const TOOL_EVENT &aEvent)
	Add a tool event to the list. More...
iterator	begin ()
iterator	end ()
const_iterator	cbegin () const
const_iterator	cend () const
int	size () const
void	clear ()
TOOL_EVENT_LIST &	operator= (const TOOL_EVENT_LIST &aEventList)
TOOL_EVENT_LIST &	operator= (const TOOL_EVENT &aEvent)
TOOL_EVENT_LIST &	operator|| (const TOOL_EVENT &aEvent)
TOOL_EVENT_LIST &	operator|| (const TOOL_EVENT_LIST &aEvent)

Private Attributes
std::deque< TOOL_EVENT >	m_events

Detailed Description

A list of TOOL_EVENTs, with overloaded || operators allowing for concatenating TOOL_EVENTs with little code.

Definition at line 554 of file tool_event.h.

Member Typedef Documentation

const_iterator

typedef std::deque<TOOL_EVENT>::const_iterator TOOL_EVENT_LIST::const_iterator

Default constructor. Creates an empty list.

Definition at line 559 of file tool_event.h.

iterator

typedef std::deque<TOOL_EVENT>::iterator TOOL_EVENT_LIST::iterator

Definition at line 558 of file tool_event.h.

value_type

typedef TOOL_EVENT TOOL_EVENT_LIST::value_type

Definition at line 557 of file tool_event.h.

Constructor & Destructor Documentation

TOOL_EVENT_LIST() [1/3]

TOOL_EVENT_LIST::TOOL_EVENT_LIST ( )

inline

Constructor for a list containing only one TOOL_EVENT.

Definition at line 562 of file tool_event.h.

TOOL_EVENT_LIST() [2/3]

TOOL_EVENT_LIST::TOOL_EVENT_LIST ( const TOOL_EVENT &  aSingleEvent )

inline

Copy an existing TOOL_EVENT_LIST.

Definition at line 566 of file tool_event.h.

References m_events.

TOOL_EVENT_LIST() [3/3]

TOOL_EVENT_LIST::TOOL_EVENT_LIST ( const TOOL_EVENT_LIST &  aEventList )

inline

Definition at line 572 of file tool_event.h.

    {
        m_events.clear();

        for( const TOOL_EVENT& event : aEventList.m_events )
            m_events.push_back( event );
    }

References m_events.

Member Function Documentation

Add()

void TOOL_EVENT_LIST::Add ( const TOOL_EVENT &  aEvent )

inline

Add a tool event to the list.

Parameters

aEvent

is the tool event to be added.

Definition at line 604 of file tool_event.h.

    {
        m_events.push_back( aEvent );
    }

References m_events.

Referenced by operator||(), and operator||().

begin()

iterator TOOL_EVENT_LIST::begin ( )

inline

Definition at line 609 of file tool_event.h.

    {
        return m_events.begin();
    }

References m_events.

cbegin()

const_iterator TOOL_EVENT_LIST::cbegin ( ) const

inline

Definition at line 619 of file tool_event.h.

    {
        return m_events.begin();
    }

References m_events.

cend()

const_iterator TOOL_EVENT_LIST::cend ( ) const

inline

Definition at line 624 of file tool_event.h.

    {
        return m_events.end();
    }

References m_events.

clear()

void TOOL_EVENT_LIST::clear ( )

inline

Definition at line 634 of file tool_event.h.

    {
        m_events.clear();
    }

References m_events.

Referenced by TOOL_MANAGER::dispatchInternal().

end()

iterator TOOL_EVENT_LIST::end ( )

inline

Definition at line 614 of file tool_event.h.

    {
        return m_events.end();
    }

References m_events.

Format()

const std::string TOOL_EVENT_LIST::Format

(

)

const

Function Format() Returns information about event in form of a human-readable string.

Returns

Event information.

Definition at line 188 of file tool_event.cpp.

{
    std::string s;

    for( const TOOL_EVENT& e : m_events )
        s += e.Format() + " ";

    return s;
}

References m_events.

Matches()

OPT<const TOOL_EVENT&> TOOL_EVENT_LIST::Matches ( const TOOL_EVENT &  aEvent ) const

inline

Definition at line 588 of file tool_event.h.

    {
        for( const TOOL_EVENT& event : m_events )
        {
            if( event.Matches( aEvent ) )
                return event;
        }

        return OPT<const TOOL_EVENT&>();
    }

References m_events.

Referenced by TOOL_MANAGER::dispatchInternal().

operator=() [1/2]

TOOL_EVENT_LIST& TOOL_EVENT_LIST::operator= ( const TOOL_EVENT_LIST &  aEventList )

inline

Definition at line 639 of file tool_event.h.

    {
        m_events.clear();

        for( const TOOL_EVENT& event : aEventList.m_events )
            m_events.push_back( event );

        return *this;
    }

References m_events.

operator=() [2/2]

TOOL_EVENT_LIST& TOOL_EVENT_LIST::operator= ( const TOOL_EVENT &  aEvent )

inline

Definition at line 649 of file tool_event.h.

    {
        m_events.clear();
        m_events.push_back( aEvent );
        return *this;
    }

References m_events.

operator||() [1/2]

TOOL_EVENT_LIST& TOOL_EVENT_LIST::operator|| ( const TOOL_EVENT &  aEvent )

inline

Definition at line 656 of file tool_event.h.

    {
        Add( aEvent );
        return *this;
    }

References Add().

operator||() [2/2]

TOOL_EVENT_LIST& TOOL_EVENT_LIST::operator|| ( const TOOL_EVENT_LIST &  aEvent )

inline

Definition at line 662 of file tool_event.h.

    {
        std::copy( aEvent.m_events.begin(), aEvent.m_events.end(), std::back_inserter( m_events ) );
        return *this;
    }

References m_events.

size()

int TOOL_EVENT_LIST::size ( ) const

inline

Definition at line 629 of file tool_event.h.

    {
        return m_events.size();
    }

References m_events.

Member Data Documentation

m_events

std::deque<TOOL_EVENT> TOOL_EVENT_LIST::m_events

private

Definition at line 669 of file tool_event.h.

Referenced by Add(), begin(), cbegin(), cend(), clear(), end(), Format(), Matches(), operator=(), operator||(), size(), and TOOL_EVENT_LIST().

---

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

• tool_event.h
• tool_event.cpp