Maintainer Class Reference

Component responsible for handling periodic logging of variable values to the syslog and the console, etc. More...

#include <Maintainer.h>

Collaboration diagram for Maintainer:

Classes
class	MaintainItem
	Keeps track of which how we have to maintain each DataElement. More...

Public Member Functions
	Maintainer ()
	Constructor for Maintainer. More...
void	addMaintain (unsigned short int uriCode, DataValue *dataValue, SyncComponent::CycleOrder cycleOrder, bool unavailable, bool invalid)
void	removeMaintain (unsigned short int uriCode)
void	removeAllMaintains ()
void	listMaintains ()

Private Member Functions
	Maintainer (const Maintainer &old)

Private Attributes
FlexArray< MaintainItem * >	maintainArray_
Mutex	mutex_

Detailed Description

Component responsible for handling periodic logging of variable values to the syslog and the console, etc.

Typically managed by console commands. Examples:

maintain add HorizontalControl.horizontalMode 2 enum // Sets HorizontalControl.horizontalMode to 2 every cycle maintain rem HorizontalControl.horizontalMode // stops HorizontalControl.horizontalMode from being maintained maintain clear // stops all items from being maintained maintain list // list all the items being maintained

Constructor & Destructor Documentation

Maintainer::Maintainer

(

)

Constructor for Maintainer.

Maintainer::Maintainer ( const Maintainer &  old )

private

Member Function Documentation

void Maintainer::addMaintain	(	unsigned short int	uriCode,
		DataValue *	dataValue,
		SyncComponent::CycleOrder	cycleOrder,
		bool	unavailable,
		bool	invalid
	)

References Maintainer::MaintainItem::getUriCode(), ComponentRegistry::Insert(), maintainArray_, mutex_, ElementURI::NO_CODE, Maintainer::MaintainItem::setDataValue(), Maintainer::MaintainItem::setInvalid(), and Maintainer::MaintainItem::setUnavailable().

Referenced by Supervisor::addMaintain().

void Maintainer::listMaintains

(

)

References maintainArray_, Maintainer::MaintainItem::maintainStatus(), and mutex_.

Referenced by Supervisor::listMaintains().

void Maintainer::removeAllMaintains

(

)

References ElementURI::NO_CODE, and removeMaintain().

Referenced by Supervisor::removeAllMaintains().

void Maintainer::removeMaintain

(

unsigned short int

uriCode

)

References Maintainer::MaintainItem::getUriCode(), maintainArray_, mutex_, ElementURI::NO_CODE, and ComponentRegistry::Remove().

Referenced by removeAllMaintains(), and Supervisor::removeMaintain().

Member Data Documentation

FlexArray<MaintainItem*> Maintainer::maintainArray_

private

Referenced by addMaintain(), listMaintains(), and removeMaintain().

Mutex Maintainer::mutex_

private

Referenced by addMaintain(), listMaintains(), and removeMaintain().

---

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

• /Volumes/ubuntu_share/lrauv-application/Source/supervisor/Maintainer.h
• /Volumes/ubuntu_share/lrauv-application/Source/supervisor/Maintainer.cpp