WPILibC++  trunk
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
LiveWindow Class Reference

#include <LiveWindow.h>

Public Member Functions

void Run ()
 
void AddSensor (const char *subsystem, const char *name, LiveWindowSendable *component)
 
void AddActuator (const char *subsystem, const char *name, LiveWindowSendable *component)
 
void AddSensor (std::string type, int module, int channel, LiveWindowSendable *component)
 
void AddActuator (std::string type, int module, int channel, LiveWindowSendable *component)
 
bool IsEnabled ()
 
void SetEnabled (bool enabled)
 

Static Public Member Functions

static LiveWindowGetInstance ()
 

Protected Member Functions

 LiveWindow ()
 

Detailed Description

The LiveWindow class is the public interface for putting sensors and actuators on the LiveWindow.

Author
Brad Miller

Definition at line 32 of file LiveWindow.h.

Constructor & Destructor Documentation

LiveWindow::LiveWindow ( )
protected

LiveWindow constructor. Allocate the necessary tables.

Definition at line 26 of file LiveWindow.cpp.

Member Function Documentation

void LiveWindow::AddActuator ( const char *  subsystem,
const char *  name,
LiveWindowSendable component 
)

Add an Actuator associated with the subsystem and with call it by the given name.

Parameters
subsystemThe subsystem this component is part of.
nameThe name of this component.
componentA LiveWindowSendable component that represents a actuator.

Definition at line 96 of file LiveWindow.cpp.

void LiveWindow::AddActuator ( std::string  type,
int  module,
int  channel,
LiveWindowSendable component 
)

INTERNAL

Definition at line 123 of file LiveWindow.cpp.

void LiveWindow::AddSensor ( const char *  subsystem,
const char *  name,
LiveWindowSendable component 
)

Add a Sensor associated with the subsystem and with call it by the given name.

Parameters
subsystemThe subsystem this component is part of.
nameThe name of this component.
componentA LiveWindowSendable component that represents a sensor.

Definition at line 82 of file LiveWindow.cpp.

void LiveWindow::AddSensor ( std::string  type,
int  module,
int  channel,
LiveWindowSendable component 
)

INTERNAL

Definition at line 107 of file LiveWindow.cpp.

LiveWindow * LiveWindow::GetInstance ( )
static

Get an instance of the LiveWindow main class This is a singleton to guarantee that there is only a single instance regardless of how many times GetInstance is called.

Definition at line 13 of file LiveWindow.cpp.

void LiveWindow::Run ( )

This method is called periodically to cause the sensors to send new values to the SmartDashboard.

Definition at line 151 of file LiveWindow.cpp.

void LiveWindow::SetEnabled ( bool  enabled)

Change the enabled status of LiveWindow If it changes to enabled, start livewindow running otherwise stop it

Definition at line 38 of file LiveWindow.cpp.


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