carma::canbus::devices::DeviceControl Interface Reference

Carma CANbus base Device control interface. More...

import "carma/canbus/devices/DeviceControl.idl";

Inheritance diagram for carma::canbus::devices::DeviceControl:

Public Member Functions
boolean	isOnline () raises (carma::util::UserException)
	Is device ONLINE? A device is considered ONLINE if it is actively sending monitor packets on the frame timescale. More...
void	reset () raises (carma::util::UserException)
	Reset the module via CAN reset message. More...
void	startChannelOneFastSampling (in unsigned short fastItem) raises (carma::util::UserException)
	Start fast sampling data from this node on channel 1. More...
void	startChannelTwoFastSampling (in unsigned short fastItem) raises (carma::util::UserException)
	Start fast sampling data from this node on channel 2. More...
void	stopChannelOneFastSampling () raises (carma::util::UserException)
	Stop fast sampling on channel 1 for any device. More...
void	stopChannelTwoFastSampling () raises (carma::util::UserException)
	Stop fast sampling on channel 2 for any device. More...

Detailed Description

Carma CANbus base Device control interface.

This interface defines the base control methods that should be available to all Carma CANbus devices. It is intended for use by any carma::canbus::Device class derivatives which wish to directly use Corba for control functionality. A particular user may also be interested in the XAC variant implementations if the CAN node in question is based on the XAC microprocessor.

Definition at line 27 of file DeviceControl.idl.

Member Function Documentation

boolean carma::canbus::devices::DeviceControl::isOnline	(		)
raises	(	carma::util::UserException
	)

Is device ONLINE? A device is considered ONLINE if it is actively sending monitor packets on the frame timescale.

Returns

true if device is ONLINE.

void carma::canbus::devices::DeviceControl::reset	(		)
raises	(	carma::util::UserException
	)

Reset the module via CAN reset message.

void carma::canbus::devices::DeviceControl::startChannelOneFastSampling	(	in unsigned short	fastItem	)
raises	(	carma::util::UserException
	)

Start fast sampling data from this node on channel 1.

Parameters

fastItem

id as described in module API

void carma::canbus::devices::DeviceControl::startChannelTwoFastSampling	(	in unsigned short	fastItem	)
raises	(	carma::util::UserException
	)

Start fast sampling data from this node on channel 2.

Parameters

fastItem

id as described in module API

void carma::canbus::devices::DeviceControl::stopChannelOneFastSampling	(		)
raises	(	carma::util::UserException
	)

Stop fast sampling on channel 1 for any device.

This command is global in that it applies to all devices on the bus

void carma::canbus::devices::DeviceControl::stopChannelTwoFastSampling	(		)
raises	(	carma::util::UserException
	)

Stop fast sampling on channel 2 for any device.

This command is global in that it applies to all devices on the bus

---

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

• carma/canbus/devices/DeviceControl.idl