Now you can download a copy of these docs so you can use them offline! Download now

InterruptableSensorBase Class Reference

Inheritance diagram for InterruptableSensorBase:
Collaboration diagram for InterruptableSensorBase:

List of all members.

Public Member Functions

virtual void RequestInterrupts (tInterruptHandler handler, void *param)=0
 Asynchronus handler version.
virtual void RequestInterrupts ()=0
 Synchronus Wait version.
virtual void CancelInterrupts ()
 Free up the underlying chipobject functions.
virtual void WaitForInterrupt (float timeout)
 Synchronus version.
virtual void EnableInterrupts ()
 Enable interrupts - after finishing setup.
virtual void DisableInterrupts ()
 Disable, but don't deallocate.
virtual double ReadInterruptTimestamp ()
 Return the timestamp for the interrupt that occurred.

Protected Member Functions

void AllocateInterrupts (bool watcher)

Protected Attributes

tInterrupt * m_interrupt
tInterruptManager * m_manager
UINT32 m_interruptIndex

Detailed Description

Definition at line 13 of file InterruptableSensorBase.h.


Member Function Documentation

void InterruptableSensorBase::CancelInterrupts (  )  [virtual]

Free up the underlying chipobject functions.

Cancel interrupts on this device. This deallocates all the chipobject structures and disables any interrupts.

Definition at line 37 of file InterruptableSensorBase.cpp.

void InterruptableSensorBase::DisableInterrupts (  )  [virtual]

Disable, but don't deallocate.

Disable Interrupts without without deallocating structures.

Definition at line 77 of file InterruptableSensorBase.cpp.

void InterruptableSensorBase::EnableInterrupts (  )  [virtual]

Enable interrupts - after finishing setup.

Enable interrupts to occur on this input. Interrupts are disabled when the RequestInterrupt call is made. This gives time to do the setup of the other options before starting to field interrupts.

Definition at line 65 of file InterruptableSensorBase.cpp.

double InterruptableSensorBase::ReadInterruptTimestamp (  )  [virtual]

Return the timestamp for the interrupt that occurred.

Return the timestamp for the interrupt that occurred most recently. This is in the same time domain as GetClock().

Returns:
Timestamp in seconds since boot.

Definition at line 91 of file InterruptableSensorBase.cpp.

void InterruptableSensorBase::WaitForInterrupt ( float  timeout  )  [virtual]

Synchronus version.

In synchronous mode, wait for the defined interrupt to occur.

Parameters:
timeout Timeout in seconds

Definition at line 51 of file InterruptableSensorBase.cpp.


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

Generated on Thu Jan 12 2012 22:35:32 for WPILibC++ by doxygen 1.7.1