Public Member Functions

wosh::Fact Class Reference

Facts are the way any Event is broadcasted within WOSH system. They can be raised from Devices or Services, hardware or software. Usually it's Automation(manager) listening for Fact and generating effects, but also some GUI applications may listen them as notifiers. More...

#include <H:/WOSH/win32_vc2010/src/core/Fact.h>

List of all members.

Public Member Functions

 Fact ()
 Empty constructor.
 Fact (const std::string &eventname)
 Constructor with initializer(s), provided for convenience.
 Fact (const std::string &eventname, ISerializable *data)
 Constructor with initializer(s), provided for convenience.
 Fact (const Fact &m)
 Copy constructor.
virtual ~Fact ()
 Empty destructor.
Getters
const std::string & getEvent () const
 Get the event (string) associated with the event.
virtual MessageContent::TYPE getType () const
 Get MessageContent::TYPE of this implementation: a FACT.
Setters
void setEvent (const std::string &value)
 Set the event (string) associated with the event.
Operators Overloading
virtual Factoperator= (const Fact &m)
virtual bool operator== (const Fact &other) const
virtual bool operator!= (const Fact &other) const

Detailed Description

Facts are the way any Event is broadcasted within WOSH system. They can be raised from Devices or Services, hardware or software. Usually it's Automation(manager) listening for Fact and generating effects, but also some GUI applications may listen them as notifiers.

Some examples of facts:

Version:
0.8.384
Id:
Fact.h 3775 2011-01-01 16:38:17Z alex
Author:
Alessandro Polo

Definition at line 53 of file Fact.h.


Constructor & Destructor Documentation

wosh::Fact::Fact (  )

Empty constructor.

Definition at line 50 of file Fact.cpp.

wosh::Fact::Fact ( const std::string &  eventname ) [explicit]

Constructor with initializer(s), provided for convenience.

Parameters:
[in]eventnamethe event string to be assigned

Definition at line 53 of file Fact.cpp.

wosh::Fact::Fact ( const std::string &  eventname,
ISerializable data 
) [explicit]

Constructor with initializer(s), provided for convenience.

Parameters:
[in]eventnamethe event string to be assigned
[in]datathe data object (ISerializable abstraction) associated with the event. May be NULL.

Definition at line 56 of file Fact.cpp.

wosh::Fact::Fact ( const Fact m )

Copy constructor.

Parameters:
m[in] the source object to be copied

Definition at line 59 of file Fact.cpp.

virtual wosh::Fact::~Fact (  ) [inline, virtual]

Empty destructor.

Definition at line 83 of file Fact.h.


Member Function Documentation

const std::string& wosh::Fact::getEvent (  ) const [inline]

Get the event (string) associated with the event.

Returns:
constant STL string reference (to internal field)

Definition at line 94 of file Fact.h.

Referenced by wosh::application::Wosh3DWindow::busMessage(), wosh::rmi::IStub::busMessage(), and wosh::security::AlarmTriggerPerimetral::evaluateMessage().

virtual MessageContent::TYPE wosh::Fact::getType (  ) const [inline, virtual]

Get MessageContent::TYPE of this implementation: a FACT.

Returns:
MessageContent::FACT

Implements wosh::MessageContent.

Definition at line 100 of file Fact.h.

void wosh::Fact::setEvent ( const std::string &  value ) [inline]

Set the event (string) associated with the event.

Parameters:
[in]valuethe event string to be assigned
See also:
setContentContext()

Definition at line 112 of file Fact.h.


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

Generated on Tue Feb 8 2011 09:33:30 for WOSH system 0.8.888 [wolf] by Alessandro Polo, using DoxyGen 1.7.2 hosted by WOSH Framework