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:

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)
 
- Public Member Functions inherited from IntCameraParameter
 IntCameraParameter (const char *setString, const char *getString, bool requiresRestart)
 
int GetValue ()
 
void SetValue (int value)
 

Additional Inherited Members

- Protected Member Functions inherited from IntCameraParameter
int SearchForParam (const char *pattern, const char *searchString, int searchStringLen, char *result)
 
- Protected Attributes inherited from IntCameraParameter
const char * m_setString
 
const char * m_getString
 
bool m_changed
 
bool m_requiresRestart
 
int m_value
 

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
setStringThe string for an HTTP request to set the value.
getStringThe string for an HTTP request to get the value.
choicesAn array of strings of the parameter choices set in the http strings.
numChoicesThe 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
stringThe string returned from the camera.
lengthThe 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 Sat Apr 26 2014 12:26:46 for WPILibC++ by doxygen 1.8.6