winss::ControlItem Class Reference

Base class for inbound and outbound control item. More...

#include <control.hpp>

Inheritance diagram for winss::ControlItem:

Public Member Functions
virtual const std::string &	GetName () const
	Gets the name of the control item. More...
virtual void	Init ()
	Initializes the control item. More...
virtual void	Start ()
	Signals the start of either sending events or listening to events. More...
virtual bool	Completed () const =0
	Signals that the events have been sent or all have been received. More...
virtual	~ControlItem ()
	Default destructor. More...

Protected Member Functions
	ControlItem (std::string name)
	Constructs a control item with the given name. More...

Protected Attributes
const std::string	name
	The name of the control item. More...

Detailed Description

Base class for inbound and outbound control item.

Constructor & Destructor Documentation

winss::ControlItem::ControlItem ( std::string  name )

explicitprotected

Constructs a control item with the given name.

Parameters

name	The name of the control item.

virtual winss::ControlItem::~ControlItem ( )

inlinevirtual

Default destructor.

Member Function Documentation

virtual bool winss::ControlItem::Completed ( ) const

pure virtual

Signals that the events have been sent or all have been received.

Implemented in winss::InboundControlItem, and winss::OutboundControlItem.

Referenced by Start().

const std::string & winss::ControlItem::GetName ( ) const

virtual

Gets the name of the control item.

Returns

The name of the control item.

References name.

Referenced by winss::Control::Add().

virtual void winss::ControlItem::Init ( )

inlinevirtual

Initializes the control item.

Reimplemented in winss::InboundControlItem, and winss::OutboundControlItem.

Referenced by winss::Control::Add().

virtual void winss::ControlItem::Start ( )

inlinevirtual

Signals the start of either sending events or listening to events.

Reimplemented in winss::InboundControlItem, and winss::OutboundControlItem.

References Completed().

Member Data Documentation

const std::string winss::ControlItem::name

protected

The name of the control item.

Referenced by winss::OutboundControlItem::Connected(), winss::InboundControlItem::Connected(), winss::OutboundControlItem::Disconnected(), winss::InboundControlItem::Disconnected(), and GetName().

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/winss/checkouts/stable/lib/winss/control.hpp
• /home/docs/checkouts/readthedocs.org/user_builds/winss/checkouts/stable/lib/winss/control.cpp