carma::clock::System Interface Reference

Carma Master Clock system access interface. More...

import "carma/clock/clockSystem.idl";

Public Member Functions
carma::clock::ClockControl	Clock () raises (carma::util::UserException)
	Retrieve control object for individual clock CAN devices. More...
carma::clock::ClockControl	GlobalClock () raises (carma::util::UserException)
	Retrieve control object for all clock objects (which is just the one. More...
void	quit () raises (carma::util::UserException)
	Quit. More...
void	reset () raises (carma::util::UserException)
	Reset all modules. More...
void	softReset () raises (carma::util::UserException)
	Reset all modules. More...

Detailed Description

Carma Master Clock system access interface.

This interface declares the access and control interface for the Master Clock Subsystem. It serves as a single entry point from which to access CAN device control object references. In addition it provides methods which act on the CANbus as a whole such as the reset method.

Definition at line 38 of file clockSystem.idl.

Member Function Documentation

carma::clock::ClockControl carma::clock::System::Clock	(		)
raises	(	carma::util::UserException
	)

Retrieve control object for individual clock CAN devices.

This will do the same as GlobalClock for now since there is only one device

Exceptions

carma::util::UserException

on failure.

carma::clock::ClockControl carma::clock::System::GlobalClock	(		)
raises	(	carma::util::UserException
	)

Retrieve control object for all clock objects (which is just the one.

Exceptions

carma::util::UserException

on failure.

void carma::clock::System::quit	(		)
raises	(	carma::util::UserException
	)

Quit.

Exits host application. FOR DEBUGGING ONLY - It is very likely this will be removed on the producation system (we don't want people accidently terminating our applications).

void carma::clock::System::reset	(		)
raises	(	carma::util::UserException
	)

Reset all modules.

Resets all modules on all controlled busses via Dio reset lines.

Exceptions

carma::util::UserException

on failure.

void carma::clock::System::softReset	(		)
raises	(	carma::util::UserException
	)

Reset all modules.

Resets all modules on all controlled busses via CAN reset message.

Exceptions

carma::util::UserException

on failure.

---

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

• carma/clock/clockSystem.idl