Now you can download a copy of these docs so you can use them offline! Download now
Public Member Functions | Static Public Member Functions

SmartDashboard Class Reference

Inheritance diagram for SmartDashboard:
Inheritance graph
[legend]
Collaboration diagram for SmartDashboard:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void PutData (const char *keyName, SmartDashboardData *value)
void PutData (SmartDashboardNamedData *value)
SmartDashboardData * GetData (const char *keyName)
void PutBoolean (const char *keyName, bool value)
bool GetBoolean (const char *keyName)
void PutInt (const char *keyName, int value)
int GetInt (const char *keyName)
void PutDouble (const char *keyName, double value)
double GetDouble (const char *keyName)
void PutString (const char *keyName, const char *value)
int GetString (const char *keyName, char *value, int valueLen)
std::string GetString (std::string keyName)
void PutString (std::string keyName, std::string value)
void init ()

Static Public Member Functions

static SmartDashboard * GetInstance ()
static int LogChar (char value, const char *name)
static int LogChar (wchar_t value, const char *name)
static int Log (INT32 value, const char *name)
static int Log (INT64 value, const char *name)
static int Log (bool value, const char *name)
static int Log (float value, const char *name)
static int Log (double value, const char *name)
static int Log (const char *value, const char *name)

Detailed Description

Definition at line 18 of file SmartDashboard.h.

Member Function Documentation

bool SmartDashboard::GetBoolean ( const char *  keyName  ) 

Returns the value at the specified key.

Parameters:
keyName the key
Returns:
the value

Definition at line 128 of file SmartDashboard.cpp.

SmartDashboardData * SmartDashboard::GetData ( const char *  keyName  ) 

Returns the value at the specified key.

Parameters:
keyName the key
Returns:
the value

Definition at line 94 of file SmartDashboard.cpp.

double SmartDashboard::GetDouble ( const char *  keyName  ) 

Returns the value at the specified key.

Parameters:
keyName the key
Returns:
the value

Definition at line 172 of file SmartDashboard.cpp.

SmartDashboard * SmartDashboard::GetInstance (  )  [static]

Get the one and only SmartDashboard object

Returns:
pointer to the SmartDashboard

Definition at line 37 of file SmartDashboard.cpp.

int SmartDashboard::GetInt ( const char *  keyName  ) 

Returns the value at the specified key.

Parameters:
keyName the key
Returns:
the value

Definition at line 150 of file SmartDashboard.cpp.

int SmartDashboard::GetString ( const char *  keyName,
char *  value,
int  valueLen 
)

Returns the value at the specified key.

Parameters:
keyName the key
value the buffer to fill with the value
valueLen the size of the buffer pointed to by value
Returns:
the length of the string

Definition at line 196 of file SmartDashboard.cpp.

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

Returns the value at the specified key.

Parameters:
keyName the key
Returns:
the value

Definition at line 218 of file SmartDashboard.cpp.

void SmartDashboard::init (  ) 
Deprecated:
no longer necessary

Definition at line 226 of file SmartDashboard.cpp.

int SmartDashboard::Log ( INT32  value,
const char *  name 
) [static]

Sends the given int value to the client as the field with the given name.

Parameters:
value The value to send.
name The name of the field.
Returns:
An integer status code.
Deprecated:
use SmartDashboard#PutInt(const char*, int)

Definition at line 263 of file SmartDashboard.cpp.

int SmartDashboard::Log ( INT64  value,
const char *  name 
) [static]

Sends the given long value to the client as the field with the given name.

Parameters:
value The value to send.
name The name of the field.
Returns:
An integer status code.
Deprecated:
use SmartDashboard#PutDouble(const char*, double)

Definition at line 276 of file SmartDashboard.cpp.

int SmartDashboard::Log ( bool  value,
const char *  name 
) [static]

Sends the given boolean value to the client as the field with the given name.

Parameters:
value The value to send.
name The name of the field.
Returns:
An integer status code.
Deprecated:
use SmartDashboard#PutBoolean(const char*, bool) instead

Definition at line 289 of file SmartDashboard.cpp.

int SmartDashboard::Log ( float  value,
const char *  name 
) [static]

Sends the given float value to the client as the field with the given name.

Parameters:
value The value to send.
name The name of the field.
Returns:
An integer status code.
Deprecated:
use SmartDashboard#PutDouble(const char*, double)

Definition at line 302 of file SmartDashboard.cpp.

int SmartDashboard::Log ( double  value,
const char *  name 
) [static]

Sends the given double value to the client as the field with the given name.

Parameters:
value The value to send.
name The name of the field.
Returns:
An integer status code.
Deprecated:
use SmartDashboard#PutDouble(const char*, double)

Definition at line 315 of file SmartDashboard.cpp.

int SmartDashboard::Log ( const char *  value,
const char *  name 
) [static]

Sends the given string value to the client as the field with the given name.

Parameters:
value The value to send. This may be at most 63 characters in length.
name The name of the field.
Returns:
An integer status code.
Deprecated:
use SmartDashboard#PutString(const char*, const char*)

Definition at line 328 of file SmartDashboard.cpp.

int SmartDashboard::LogChar ( char  value,
const char *  name 
) [static]

Send the given byte value to the client as the field with the given name.

Parameters:
value The value to be displayed on the client.
name The name of the field.
Returns:
An integer status code.
Deprecated:
use SmartDashboard#PutInt(const char*, int)

Definition at line 237 of file SmartDashboard.cpp.

int SmartDashboard::LogChar ( wchar_t  value,
const char *  name 
) [static]

Send the given UTF-16 char value to the client as the field with the given name.

Parameters:
value The value to be displayed on the client.
name The name of the field.
Returns:
An integer status code.
Deprecated:
use SmartDashboard#PutInt(const char*, int)

Definition at line 250 of file SmartDashboard.cpp.

void SmartDashboard::PutBoolean ( const char *  keyName,
bool  value 
)

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:
keyName the key
value the value

Definition at line 118 of file SmartDashboard.cpp.

void SmartDashboard::PutData ( const char *  keyName,
SmartDashboardData *  value 
)

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:
keyName the key
value the value

Definition at line 54 of file SmartDashboard.cpp.

void SmartDashboard::PutData ( SmartDashboardNamedData *  value  ) 

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:
value the value

Definition at line 79 of file SmartDashboard.cpp.

void SmartDashboard::PutDouble ( const char *  keyName,
double  value 
)

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:
keyName the key
value the value

Definition at line 162 of file SmartDashboard.cpp.

void SmartDashboard::PutInt ( const char *  keyName,
int  value 
)

Maps the specified key to the specified value in this table. The keyName 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:
keyName the key
value the value

Definition at line 140 of file SmartDashboard.cpp.

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

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:
keyName the key
value the value

Definition at line 208 of file SmartDashboard.cpp.

void SmartDashboard::PutString ( const char *  keyName,
const char *  value 
)

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:
keyName the key
value the value

Definition at line 184 of file SmartDashboard.cpp.

The documentation for this class was generated from the following files:
Generated on Thu Jan 12 2012 22:35:37 for WPILibC++ by doxygen 1.7.1