rec::robotino::api2 C++ interface
Public Member Functions | List of all members
rec::robotino::api2::Shutdown Class Reference

Represents a Shutdown. More...

#include <Shutdown.h>

Inheritance diagram for rec::robotino::api2::Shutdown:
rec::robotino::api2::ComObject

Public Member Functions

 Shutdown (const ComId &id)
 
void setComId (const ComId &id)
 
void shutdown ()
 
- Public Member Functions inherited from rec::robotino::api2::ComObject
 ComObject ()
 
virtual ~ComObject ()
 
ComId comId () const
 

Additional Inherited Members

- Protected Attributes inherited from rec::robotino::api2::ComObject
ComId _comID
 

Detailed Description

Represents a Shutdown.

Member Function Documentation

void rec::robotino::api2::Shutdown::setComId ( const ComId id)

Sets the associated communication object.

Parameters
idThe id of the associated communication object.
Exceptions
RobotinoExceptionif given id is invalid.
Remarks
This function is thread save
void rec::robotino::api2::Shutdown::shutdown ( )

Call this function to shutdown Robotino (results in a call to /sbin/poweroff)

Exceptions
RobotinoExceptionif the underlying communication object is invalid
See also
ComObject::setComId

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