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

EnumCameraParameter Class Reference

#include <EnumCameraParameter.h>

Inheritance diagram for EnumCameraParameter:
Collaboration diagram for EnumCameraParameter:

List of all members.

Public Member Functions

 EnumCameraParameter (const char *setString, const char *getString, bool requiresRestart, const char *const *choices, int numChoices)
virtual bool CheckChanged (bool &changed, char *param)
virtual void GetParamFromString (const char *string, int stringLength)

Detailed Description

Enumerated camera parameter. This class represents a camera parameter that takes an enumerated type for a value.

Definition at line 16 of file EnumCameraParameter.h.


Constructor & Destructor Documentation

EnumCameraParameter::EnumCameraParameter ( const char *  setString,
const char *  getString,
bool  requiresRestart,
const char *const *  choices,
int  numChoices 
)

Constructor for an enumeration camera parameter. Enumeration camera parameters have lists of value choices and strings that go with them. There are also C++ enumerations to go along with them.

Parameters:
setString The string for an HTTP request to set the value.
getString The string for an HTTP request to get the value.
choices An array of strings of the parameter choices set in the http strings.
numChoices The number of choices in the enumeration set.

Definition at line 20 of file EnumCameraParameter.cpp.


Member Function Documentation

bool EnumCameraParameter::CheckChanged ( bool &  changed,
char *  param 
) [virtual]

Check if a parameter has changed and update. Check if a parameter has changed and send the update string if it has changed. This is called from the loop in the parameter task loop.

Returns:
true if the camera needs to restart

Reimplemented from IntCameraParameter.

Definition at line 34 of file EnumCameraParameter.cpp.

void EnumCameraParameter::GetParamFromString ( const char *  string,
int  stringLength 
) [virtual]

Extract the parameter value from a string. Extract the parameter value from the camera status message.

Parameters:
string The string returned from the camera.
length The length of the string from the camera.

Reimplemented from IntCameraParameter.

Definition at line 52 of file EnumCameraParameter.cpp.


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

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