M_Device::IService Class Reference

Public Member Functions
virtual	~IService ()
virtual void	CmdIsDeviceAlive ()
virtual void	CmdEnableDevice (bool IsEnabled)
virtual void	CmdShutdownDevice ()
	Shut down the device, i.e. power off and disconnect. More...
virtual void	CmdRestartDevice ()
	Restart the device. More...
virtual void	CmdSetDeviceMode (M_Common::OperationModeType const &Mode)
virtual void	CmdSetValue (std::string const &Id, M_Common::PropertyType const &Value)
virtual void	CmdSetValueIncrementally (std::string const &Id, M_Common::PropertyType const &Value)
virtual void	RequestValue (std::string const &Id)

Detailed Description

Device service interface. Contains operations that a client can command the device service to perform.

Constructor & Destructor Documentation

~IService()

M_Device::IService::~IService ( )

virtual

Member Function Documentation

CmdEnableDevice()

void M_Device::IService::CmdEnableDevice ( bool  IsEnabled )

virtual

Enable or disable the device, i.e. power on and establish connection.

Parameters

IsEnabled

Indicates if device should be enabled (true) or disabled (false).

CmdIsDeviceAlive()

void M_Device::IService::CmdIsDeviceAlive ( )

virtual

Command to check if device service is alive. Note: If the service is not available, then an exception will be thrown.

CmdRestartDevice()

void M_Device::IService::CmdRestartDevice ( )

virtual

Restart the device.

CmdSetDeviceMode()

void M_Device::IService::CmdSetDeviceMode ( M_Common::OperationModeType const &  Mode )

virtual

Set the mode of the device. This instructs the device (software) to assume a specific state/mode beyond powering on.

Parameters

Mode	The mode to which the device should switch.

CmdSetValue()

void M_Device::IService::CmdSetValue ( std::string const &  Id, M_Common::PropertyType const &  Value  )

virtual

Set a specified value.

Parameters

Id	Identifies the component/location.
Value	Value to set.

CmdSetValueIncrementally()

void M_Device::IService::CmdSetValueIncrementally ( std::string const &  Id, M_Common::PropertyType const &  Value  )

virtual

Incrementally change a specified value.

Parameters

Id	Identifies the component/location.
Value	Value to change.

CmdShutdownDevice()

void M_Device::IService::CmdShutdownDevice ( )

virtual

Shut down the device, i.e. power off and disconnect.

RequestValue()

void M_Device::IService::RequestValue ( std::string const &  Id )

virtual

Instruct the service to provide the requesting client with a specified value.

Parameters

Id	Identifies the component/location.