Now you can download a copy of these docs so you can use them offline! Download now
SmartDashboard Class Reference
Inheritance diagram for SmartDashboard:
Collaboration diagram for SmartDashboard:

Static Public Member Functions

static void init ()
 
static void PutData (std::string key, Sendable *data)
 
static void PutData (NamedSendable *value)
 
static void PutBoolean (std::string keyName, bool value)
 
static bool GetBoolean (std::string keyName)
 
static void PutNumber (std::string keyName, double value)
 
static double GetNumber (std::string keyName)
 
static void PutString (std::string keyName, std::string value)
 
static int GetString (std::string keyName, char *value, unsigned int valueLen)
 
static std::string GetString (std::string keyName)
 
static void PutValue (std::string keyName, ComplexData &value)
 
static void RetrieveValue (std::string keyName, ComplexData &value)
 
- Static Public Member Functions inherited from SensorBase
static void DeleteSingletons ()
 
static uint32_t GetDefaultAnalogModule ()
 
static uint32_t GetDefaultDigitalModule ()
 
static uint32_t GetDefaultSolenoidModule ()
 
static bool CheckAnalogModule (uint8_t moduleNumber)
 
static bool CheckDigitalModule (uint8_t moduleNumber)
 
static bool CheckPWMModule (uint8_t moduleNumber)
 
static bool CheckRelayModule (uint8_t moduleNumber)
 
static bool CheckSolenoidModule (uint8_t moduleNumber)
 
static bool CheckDigitalChannel (uint32_t channel)
 
static bool CheckRelayChannel (uint32_t channel)
 
static bool CheckPWMChannel (uint32_t channel)
 
static bool CheckAnalogChannel (uint32_t channel)
 
static bool CheckSolenoidChannel (uint32_t channel)
 
- Static Public Member Functions inherited from ErrorBase
static void SetGlobalError (Error::Code code, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber)
 
static void SetGlobalWPIError (const char *errorMessage, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber)
 
static ErrorGetGlobalError ()
 

Additional Inherited Members

- Public Member Functions inherited from SensorBase
 SensorBase ()
 
virtual ~SensorBase ()
 
- Public Member Functions inherited from ErrorBase
virtual ErrorGetError ()
 Retrieve the current error. Get the current error information associated with this sensor.
 
virtual const ErrorGetError () const
 
virtual void SetErrnoError (const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
 Set error information associated with a C library call that set an error to the "errno" global variable. More...
 
virtual void SetImaqError (int success, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
 Set the current error information associated from the nivision Imaq API. More...
 
virtual void SetError (Error::Code code, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (const char *errorMessage, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void CloneError (ErrorBase *rhs) const
 
virtual void ClearError () const
 Clear the current error information associated with this sensor.
 
virtual bool StatusIsFatal () const
 Check if the current error code represents a fatal error. More...
 
- Static Public Attributes inherited from SensorBase
static const uint32_t kSystemClockTicksPerMicrosecond = 40
 
static const uint32_t kDigitalChannels = 14
 
static const uint32_t kAnalogChannels = 8
 
static const uint32_t kAnalogModules = 2
 
static const uint32_t kDigitalModules = 2
 
static const uint32_t kSolenoidChannels = 8
 
static const uint32_t kSolenoidModules = 2
 
static const uint32_t kPwmChannels = 10
 
static const uint32_t kRelayChannels = 8
 
static const uint32_t kChassisSlots = 8
 
- Protected Member Functions inherited from SensorBase
void AddToSingletonList ()
 
- Protected Member Functions inherited from ErrorBase
 ErrorBase ()
 Initialize the instance status to 0 for now.
 
- Protected Attributes inherited from ErrorBase
Error m_error
 
- Static Protected Attributes inherited from ErrorBase
static SEM_ID _globalErrorMutex = semMCreate(SEM_Q_PRIORITY | SEM_DELETE_SAFE | SEM_INVERSION_SAFE)
 
static Error _globalError
 

Detailed Description

Definition at line 18 of file SmartDashboard.h.

Member Function Documentation

bool SmartDashboard::GetBoolean ( std::string  keyName)
static

Returns the value at the specified key.

Parameters
keyNamethe key
Returns
the value

Definition at line 116 of file SmartDashboard.cpp.

double SmartDashboard::GetNumber ( std::string  keyName)
static

Returns the value at the specified key.

Parameters
keyNamethe key
Returns
the value

Definition at line 137 of file SmartDashboard.cpp.

int SmartDashboard::GetString ( std::string  keyName,
char *  outBuffer,
unsigned int  bufferLen 
)
static

Returns the value at the specified key.

Parameters
keyNamethe key
valuethe buffer to fill with the value
valueLenthe size of the buffer pointed to by value
Returns
the length of the string

Definition at line 161 of file SmartDashboard.cpp.

std::string SmartDashboard::GetString ( std::string  keyName)
static

Returns the value at the specified key.

Parameters
keyNamethe key
Returns
the value

Definition at line 176 of file SmartDashboard.cpp.

void SmartDashboard::PutBoolean ( std::string  keyName,
bool  value 
)
static

Maps the specified key to the specified value in this table. The key can not be NULL. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters
keyNamethe key
valuethe value

Definition at line 106 of file SmartDashboard.cpp.

void SmartDashboard::PutData ( std::string  key,
Sendable data 
)
static

Maps the specified key to the specified value in this table. The key can not be NULL. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters
keyNamethe key
valuethe value

Definition at line 30 of file SmartDashboard.cpp.

void SmartDashboard::PutData ( NamedSendable value)
static

Maps the specified key (where the key is the name of the SmartDashboardNamedData to the specified value in this table. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters
valuethe value

Definition at line 49 of file SmartDashboard.cpp.

void SmartDashboard::PutNumber ( std::string  keyName,
double  value 
)
static

Maps the specified key to the specified value in this table. The key can not be NULL. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters
keyNamethe key
valuethe value

Definition at line 128 of file SmartDashboard.cpp.

void SmartDashboard::PutString ( std::string  keyName,
std::string  value 
)
static

Maps the specified key to the specified value in this table. Neither the key nor the value can be NULL. The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters
keyNamethe key
valuethe value

Definition at line 149 of file SmartDashboard.cpp.

void SmartDashboard::PutValue ( std::string  keyName,
ComplexData value 
)
static

Returns the value at the specified key.

Parameters
keyNamethe key
Returns
the value Maps the specified key to the specified complex value (such as an array) in this table. The key can not be NULL. The value can be retrieved by calling the RetrieveValue method with a key that is equal to the original key.
Parameters
keyNamethe key
valuethe value

Definition at line 83 of file SmartDashboard.cpp.

void SmartDashboard::RetrieveValue ( std::string  keyName,
ComplexData value 
)
static

Retrieves the complex value (such as an array) in this table into the complex data object The key can not be NULL.

Parameters
keyNamethe key
valuethe object to retrieve the value into

Definition at line 94 of file SmartDashboard.cpp.


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

Generated on Sat Apr 26 2014 12:26:47 for WPILibC++ by doxygen 1.8.6