Represents a relay. More...

#include <Relay.h>

Inheritance diagram for rec::robotino::api2::Relay:

Public Member Functions
void	setComId (const ComId &id)

void	setRelayNumber (unsigned int n)

void	setValue (bool on)

Public Member Functions inherited from rec::robotino::api2::ComObject
	ComObject ()

virtual	~ComObject ()

ComId	comId () const

Static Public Member Functions
static unsigned int	numRelays ()

Additional Inherited Members
Protected Attributes inherited from rec::robotino::api2::ComObject
ComId	_comID

Detailed Description

Represents a relay.

Member Function Documentation

static unsigned int rec::robotino::api2::Relay::numRelays ( )

static

void rec::robotino::api2::Relay::setComId ( const ComId & id )

Sets the associated communication object.

Parameters

id	The id of the associated communication object.

Exceptions

nothing

void rec::robotino::api2::Relay::setRelayNumber ( unsigned int n )

Sets the relay number.

Parameters

n	The relay number. Range: [0; Robotstate::numRelays-1]

Exceptions

RobotinoException if n is out of range

void rec::robotino::api2::Relay::setValue ( bool on )

Sets the relay to the given value.

Parameters

on	The value the relay will be set to.

Exceptions

RobotinoException if the underlying communication object is invalid

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