openjaus::system::Event Class Reference

#include <Event.h>

Inherits openjaus::system::Accessable.

Inherited by openjaus::system::Exception.

Public Member Functions
	Event ()
virtual	~Event ()
	Event (std::string description)
std::string	getDescription () const
	Accessor to get the value of description. More...
bool	setDescription (std::string description)
	Accessor to set value of description. More...
float	getMaxLoggingHz () const
	Accessor to get the value of maxLoggingHz. More...
bool	setMaxLoggingHz (float maxLoggingHz)
	Accessor to set value of maxLoggingHz. More...
bool	isSave () const
	Accessor to get the value of save. More...
bool	setSave (bool save)
	Accessor to set value of save. More...
std::string	getNameSpace () const
	Accessor to get the value of nameSpace. More...
bool	setNameSpace (std::string nameSpace)
	Accessor to set value of nameSpace. More...
const Time &	getTime () const
	Accessor to get the value of time. More...
bool	setTime (const Time &time)
	Accessor to set value of time. More...
virtual std::string	toString () const
Public Member Functions inherited from openjaus::system::Accessable
	Accessable ()
virtual	~Accessable ()
bool	isGlobalRead () const
	Accessor to get the value of globalRead. More...
bool	setGlobalRead (bool globalRead)
	Accessor to set value of globalRead. More...
bool	isControllerRead () const
	Accessor to get the value of controllerRead. More...
bool	setControllerRead (bool controllerRead)
	Accessor to set value of controllerRead. More...
bool	isControllerWrite () const
	Accessor to get the value of controllerWrite. More...
bool	setControllerWrite (bool controllerWrite)
	Accessor to set value of controllerWrite. More...
std::vector< std::string >	getOwnerUri () const
	Accessor to get the value of ownerUri. More...
bool	setOwnerUri (std::string ownerUri)
	Accessor to set value of ownerUri. More...

Protected Attributes
std::string	description
float	maxLoggingHz
bool	save
std::string	nameSpace
Time	time
Protected Attributes inherited from openjaus::system::Accessable
bool	globalRead
bool	controllerRead
bool	controllerWrite
std::vector< std::string >	ownerUri

Friends
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const Event &object)
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const Event *object)

Constructor & Destructor Documentation

Event() [1/2]

openjaus::system::Event::Event

(

)

~Event()

openjaus::system::Event::~Event ( )

virtual

Event() [2/2]

openjaus::system::Event::Event

(

std::string

description

)

Member Function Documentation

getDescription()

std::string openjaus::system::Event::getDescription

(

)

const

getMaxLoggingHz()

float openjaus::system::Event::getMaxLoggingHz

(

)

const

getNameSpace()

std::string openjaus::system::Event::getNameSpace

(

)

const

getTime()

const Time & openjaus::system::Event::getTime

(

void

)

const

isSave()

bool openjaus::system::Event::isSave

(

)

const

setDescription()

bool openjaus::system::Event::setDescription

(

std::string

description

)

Parameters

description

The value of the new description.

setMaxLoggingHz()

bool openjaus::system::Event::setMaxLoggingHz

(

float

maxLoggingHz

)

Parameters

maxLoggingHz

The value of the new maxLoggingHz.

setNameSpace()

bool openjaus::system::Event::setNameSpace

(

std::string

nameSpace

)

Parameters

nameSpace

The value of the new nameSpace.

setSave()

bool openjaus::system::Event::setSave

(

bool

save

)

Parameters

save	The value of the new save.

setTime()

bool openjaus::system::Event::setTime

(

const Time &

time

)

Parameters

time	The value of the new time.

toString()

std::string openjaus::system::Event::toString ( ) const

virtual

Reimplemented from openjaus::system::Accessable.

Reimplemented in openjaus::system::Exception.

Friends And Related Function Documentation

operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const Event &  object  )

friend

operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const Event *  object  )

friend

Member Data Documentation

description

std::string openjaus::system::Event::description

protected

maxLoggingHz

float openjaus::system::Event::maxLoggingHz

protected

nameSpace

std::string openjaus::system::Event::nameSpace

protected

save

bool openjaus::system::Event::save

protected

time

Time openjaus::system::Event::time

protected

---

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

• include/openjaus/system/Event.h
• src/openjaus/system/Event.cpp