gusimplewhiteboard
guWhiteboard::VisionControlStatus Class Reference

Provides a C++ wrapper around wb_vision_control_status. More...

#include <VisionControlStatus.hpp>

Inheritance diagram for guWhiteboard::VisionControlStatus:
Collaboration diagram for guWhiteboard::VisionControlStatus:

Public Member Functions

 VisionControlStatus (enum Resolutions t_cameraResolution=VGA, bool t_pipelineRunning=true, enum VisionCamera t_selectedCamera=Top, enum SaveFileType t_saveImage=None, bool t_saveClassifiedImage=false, enum NamedPipeline t_pipeline=Soccer, int t_chooseCamera=0, float t_confidence=0.8f, enum NeuralNetworkType t_networkTop=v2, enum NeuralNetworkType t_networkBottom=v2, enum StreamingType t_streamingSource=Normal, bool t_imageInput=false, int t_jpegStreamQuality=30, int t_jpegStreamStride=4, int t_frameRate=0, bool t_runPipelineOnce=false, uint64_t t_frameNumber=0, std::string t_colourCalibration="class", struct timeval t_imageTime={})
 Create a new VisionControlStatus. More...
 
 VisionControlStatus (const VisionControlStatus &t_other)
 Copy Constructor. More...
 
 VisionControlStatus (const struct wb_vision_control_status &t_other)
 Copy Constructor. More...
 
VisionControlStatusoperator= (const VisionControlStatus &t_other)
 Copy Assignment Operator. More...
 
VisionControlStatusoperator= (const struct wb_vision_control_status &t_other)
 Copy Assignment Operator. More...
 
bool operator== (const VisionControlStatus &t_other) const
 
bool operator!= (const VisionControlStatus &t_other) const
 
bool operator== (const wb_vision_control_status &t_other) const
 
bool operator!= (const wb_vision_control_status &t_other) const
 
enum ResolutionscameraResolution ()
 
enum ResolutionscameraResolution () const
 
void set_cameraResolution (const enum Resolutions &t_newValue)
 
bool & pipelineRunning ()
 
const bool & pipelineRunning () const
 
void set_pipelineRunning (const bool &t_newValue)
 
enum VisionCameraselectedCamera ()
 
enum VisionCameraselectedCamera () const
 
void set_selectedCamera (const enum VisionCamera &t_newValue)
 
enum SaveFileTypesaveImage ()
 
enum SaveFileTypesaveImage () const
 
void set_saveImage (const enum SaveFileType &t_newValue)
 
bool & saveClassifiedImage ()
 
const bool & saveClassifiedImage () const
 
void set_saveClassifiedImage (const bool &t_newValue)
 
enum NamedPipelinepipeline ()
 
enum NamedPipelinepipeline () const
 
void set_pipeline (const enum NamedPipeline &t_newValue)
 
int & chooseCamera ()
 
const int & chooseCamera () const
 
void set_chooseCamera (const int &t_newValue)
 
float & confidence ()
 
const float & confidence () const
 
void set_confidence (const float &t_newValue)
 
enum NeuralNetworkTypenetworkTop ()
 
enum NeuralNetworkTypenetworkTop () const
 
void set_networkTop (const enum NeuralNetworkType &t_newValue)
 
enum NeuralNetworkTypenetworkBottom ()
 
enum NeuralNetworkTypenetworkBottom () const
 
void set_networkBottom (const enum NeuralNetworkType &t_newValue)
 
enum StreamingTypestreamingSource ()
 
enum StreamingTypestreamingSource () const
 
void set_streamingSource (const enum StreamingType &t_newValue)
 
bool & imageInput ()
 
const bool & imageInput () const
 
void set_imageInput (const bool &t_newValue)
 
int & jpegStreamQuality ()
 
const int & jpegStreamQuality () const
 
void set_jpegStreamQuality (const int &t_newValue)
 
int & jpegStreamStride ()
 
const int & jpegStreamStride () const
 
void set_jpegStreamStride (const int &t_newValue)
 
int & frameRate ()
 
const int & frameRate () const
 
void set_frameRate (const int &t_newValue)
 
bool & runPipelineOnce ()
 
const bool & runPipelineOnce () const
 
void set_runPipelineOnce (const bool &t_newValue)
 
uint64_t & frameNumber ()
 
const uint64_t & frameNumber () const
 
void set_frameNumber (const uint64_t &t_newValue)
 
const char * colourCalibration () const
 
size_t colourCalibration_size () const
 
char & colourCalibration (int t_i)
 
const char & colourCalibration (int t_i) const
 
void set_colourCalibration (const char *t_newValue)
 
struct timeval & imageTime ()
 
const struct timeval & imageTime () const
 
void set_imageTime (const struct timeval &t_newValue)
 
 VisionControlStatus (const std::string &t_str)
 String Constructor. More...
 
std::string description ()
 
std::string to_string ()
 
void from_string (const std::string &t_str)
 

Additional Inherited Members

- Public Attributes inherited from wb_vision_control_status
enum Resolutions cameraResolution
 Resolution that the camera should caputre images at. More...
 
bool pipelineRunning
 Whether the pipeline is running or not. More...
 
enum VisionCamera selectedCamera
 Which camera to use. More...
 
enum SaveFileType saveImage
 Whether to save the image used in the next iteration of the pipeline to file. More...
 
bool saveClassifiedImage
 Whether to save the classified version of the image used in the next iteration of the pipeline to file. More...
 
enum NamedPipeline pipeline
 vision pipeline to be run More...
 
int chooseCamera
 Choose which camera to run on (0-Top, 1-Bottom, 2-Both) More...
 
float confidence
 Confidence threshold for the neural net. More...
 
enum NeuralNetworkType networkTop
 neural network to run on top camera More...
 
enum NeuralNetworkType networkBottom
 neural network to run on bottom camera More...
 
enum StreamingType streamingSource
 The type of streaming to be used. More...
 
bool imageInput
 Use /tmp/test.ai2 as pipeline image rather then camera if true. More...
 
int jpegStreamQuality
 The quality to compress jpeg images at for streaming can be between 0 and 100. More...
 
int jpegStreamStride
 The stride to use when streaming jpeg images. More...
 
int frameRate
 The current framerate that the pipeline is running at. More...
 
bool runPipelineOnce
 run the pipeline one time only if true More...
 
uint64_t frameNumber
 The current frame number reported by guvison. More...
 
char colourCalibration [10]
 the DLC file to use for segmentation, searched in $HOME/data/ with the .dlc extension More...
 
struct timeval imageTime
 the time that the image was taken that this status message refers to More...
 

Detailed Description

Provides a C++ wrapper around wb_vision_control_status.

Definition at line 84 of file VisionControlStatus.hpp.

Constructor & Destructor Documentation

◆ VisionControlStatus() [1/4]

guWhiteboard::VisionControlStatus::VisionControlStatus ( enum Resolutions  t_cameraResolution = VGA,
bool  t_pipelineRunning = true,
enum VisionCamera  t_selectedCamera = Top,
enum SaveFileType  t_saveImage = None,
bool  t_saveClassifiedImage = false,
enum NamedPipeline  t_pipeline = Soccer,
int  t_chooseCamera = 0,
float  t_confidence = 0.8f,
enum NeuralNetworkType  t_networkTop = v2,
enum NeuralNetworkType  t_networkBottom = v2,
enum StreamingType  t_streamingSource = Normal,
bool  t_imageInput = false,
int  t_jpegStreamQuality = 30,
int  t_jpegStreamStride = 4,
int  t_frameRate = 0,
bool  t_runPipelineOnce = false,
uint64_t  t_frameNumber = 0,
std::string  t_colourCalibration = "class",
struct timeval  t_imageTime = {} 
)
inline

Create a new VisionControlStatus.

Definition at line 118 of file VisionControlStatus.hpp.

Referenced by operator==().

◆ VisionControlStatus() [2/4]

◆ VisionControlStatus() [3/4]

◆ VisionControlStatus() [4/4]

guWhiteboard::VisionControlStatus::VisionControlStatus ( const std::string &  t_str)
inline

String Constructor.

Definition at line 488 of file VisionControlStatus.hpp.

References from_string().

Member Function Documentation

◆ cameraResolution() [1/2]

enum Resolutions & guWhiteboard::VisionControlStatus::cameraResolution ( )
inline

◆ cameraResolution() [2/2]

enum Resolutions & guWhiteboard::VisionControlStatus::cameraResolution ( ) const
inline

◆ chooseCamera() [1/2]

int & guWhiteboard::VisionControlStatus::chooseCamera ( )
inline

◆ chooseCamera() [2/2]

const int & guWhiteboard::VisionControlStatus::chooseCamera ( ) const
inline

Definition at line 284 of file VisionControlStatus.hpp.

References wb_vision_control_status::chooseCamera.

◆ colourCalibration() [1/3]

const char * guWhiteboard::VisionControlStatus::colourCalibration ( ) const
inline

◆ colourCalibration() [2/3]

char & guWhiteboard::VisionControlStatus::colourCalibration ( int  t_i)
inline

◆ colourCalibration() [3/3]

const char & guWhiteboard::VisionControlStatus::colourCalibration ( int  t_i) const
inline

◆ colourCalibration_size()

size_t guWhiteboard::VisionControlStatus::colourCalibration_size ( ) const
inline

Definition at line 449 of file VisionControlStatus.hpp.

◆ confidence() [1/2]

float & guWhiteboard::VisionControlStatus::confidence ( )
inline

◆ confidence() [2/2]

const float & guWhiteboard::VisionControlStatus::confidence ( ) const
inline

Definition at line 299 of file VisionControlStatus.hpp.

References wb_vision_control_status::confidence.

◆ description()

◆ frameNumber() [1/2]

uint64_t & guWhiteboard::VisionControlStatus::frameNumber ( )
inline

◆ frameNumber() [2/2]

const uint64_t & guWhiteboard::VisionControlStatus::frameNumber ( ) const
inline

Definition at line 434 of file VisionControlStatus.hpp.

References wb_vision_control_status::frameNumber.

◆ frameRate() [1/2]

int & guWhiteboard::VisionControlStatus::frameRate ( )
inline

◆ frameRate() [2/2]

const int & guWhiteboard::VisionControlStatus::frameRate ( ) const
inline

Definition at line 404 of file VisionControlStatus.hpp.

References wb_vision_control_status::frameRate.

◆ from_string()

◆ imageInput() [1/2]

bool & guWhiteboard::VisionControlStatus::imageInput ( )
inline

◆ imageInput() [2/2]

const bool & guWhiteboard::VisionControlStatus::imageInput ( ) const
inline

Definition at line 359 of file VisionControlStatus.hpp.

References wb_vision_control_status::imageInput.

◆ imageTime() [1/2]

struct timeval & guWhiteboard::VisionControlStatus::imageTime ( )
inline

Definition at line 469 of file VisionControlStatus.hpp.

References wb_vision_control_status::imageTime.

Referenced by VisionControlStatus(), and operator=().

◆ imageTime() [2/2]

const struct timeval & guWhiteboard::VisionControlStatus::imageTime ( ) const
inline

Definition at line 474 of file VisionControlStatus.hpp.

References wb_vision_control_status::imageTime.

◆ jpegStreamQuality() [1/2]

int & guWhiteboard::VisionControlStatus::jpegStreamQuality ( )
inline

◆ jpegStreamQuality() [2/2]

const int & guWhiteboard::VisionControlStatus::jpegStreamQuality ( ) const
inline

◆ jpegStreamStride() [1/2]

int & guWhiteboard::VisionControlStatus::jpegStreamStride ( )
inline

◆ jpegStreamStride() [2/2]

const int & guWhiteboard::VisionControlStatus::jpegStreamStride ( ) const
inline

◆ networkBottom() [1/2]

enum NeuralNetworkType & guWhiteboard::VisionControlStatus::networkBottom ( )
inline

◆ networkBottom() [2/2]

enum NeuralNetworkType & guWhiteboard::VisionControlStatus::networkBottom ( ) const
inline

Definition at line 329 of file VisionControlStatus.hpp.

References wb_vision_control_status::networkBottom.

◆ networkTop() [1/2]

enum NeuralNetworkType & guWhiteboard::VisionControlStatus::networkTop ( )
inline

◆ networkTop() [2/2]

enum NeuralNetworkType & guWhiteboard::VisionControlStatus::networkTop ( ) const
inline

Definition at line 314 of file VisionControlStatus.hpp.

References wb_vision_control_status::networkTop.

◆ operator!=() [1/2]

bool guWhiteboard::VisionControlStatus::operator!= ( const VisionControlStatus t_other) const
inline

Definition at line 174 of file VisionControlStatus.hpp.

◆ operator!=() [2/2]

bool guWhiteboard::VisionControlStatus::operator!= ( const wb_vision_control_status t_other) const
inline

Definition at line 184 of file VisionControlStatus.hpp.

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

bool guWhiteboard::VisionControlStatus::operator== ( const wb_vision_control_status t_other) const
inline

Definition at line 179 of file VisionControlStatus.hpp.

References VisionControlStatus().

◆ pipeline() [1/2]

enum NamedPipeline & guWhiteboard::VisionControlStatus::pipeline ( )
inline

◆ pipeline() [2/2]

enum NamedPipeline & guWhiteboard::VisionControlStatus::pipeline ( ) const
inline

Definition at line 269 of file VisionControlStatus.hpp.

References wb_vision_control_status::pipeline.

◆ pipelineRunning() [1/2]

bool & guWhiteboard::VisionControlStatus::pipelineRunning ( )
inline

◆ pipelineRunning() [2/2]

const bool & guWhiteboard::VisionControlStatus::pipelineRunning ( ) const
inline

◆ runPipelineOnce() [1/2]

bool & guWhiteboard::VisionControlStatus::runPipelineOnce ( )
inline

◆ runPipelineOnce() [2/2]

const bool & guWhiteboard::VisionControlStatus::runPipelineOnce ( ) const
inline

◆ saveClassifiedImage() [1/2]

bool & guWhiteboard::VisionControlStatus::saveClassifiedImage ( )
inline

◆ saveClassifiedImage() [2/2]

const bool & guWhiteboard::VisionControlStatus::saveClassifiedImage ( ) const
inline

◆ saveImage() [1/2]

enum SaveFileType & guWhiteboard::VisionControlStatus::saveImage ( )
inline

◆ saveImage() [2/2]

enum SaveFileType & guWhiteboard::VisionControlStatus::saveImage ( ) const
inline

Definition at line 239 of file VisionControlStatus.hpp.

References wb_vision_control_status::saveImage.

◆ selectedCamera() [1/2]

enum VisionCamera & guWhiteboard::VisionControlStatus::selectedCamera ( )
inline

◆ selectedCamera() [2/2]

enum VisionCamera & guWhiteboard::VisionControlStatus::selectedCamera ( ) const
inline

Definition at line 224 of file VisionControlStatus.hpp.

References wb_vision_control_status::selectedCamera.

◆ set_cameraResolution()

void guWhiteboard::VisionControlStatus::set_cameraResolution ( const enum Resolutions t_newValue)
inline

Definition at line 199 of file VisionControlStatus.hpp.

References wb_vision_control_status::cameraResolution.

Referenced by from_string().

◆ set_chooseCamera()

void guWhiteboard::VisionControlStatus::set_chooseCamera ( const int &  t_newValue)
inline

Definition at line 289 of file VisionControlStatus.hpp.

References wb_vision_control_status::chooseCamera.

Referenced by from_string().

◆ set_colourCalibration()

void guWhiteboard::VisionControlStatus::set_colourCalibration ( const char *  t_newValue)
inline

◆ set_confidence()

void guWhiteboard::VisionControlStatus::set_confidence ( const float &  t_newValue)
inline

Definition at line 304 of file VisionControlStatus.hpp.

References wb_vision_control_status::confidence.

Referenced by from_string().

◆ set_frameNumber()

void guWhiteboard::VisionControlStatus::set_frameNumber ( const uint64_t &  t_newValue)
inline

Definition at line 439 of file VisionControlStatus.hpp.

References wb_vision_control_status::frameNumber.

Referenced by from_string().

◆ set_frameRate()

void guWhiteboard::VisionControlStatus::set_frameRate ( const int &  t_newValue)
inline

Definition at line 409 of file VisionControlStatus.hpp.

References wb_vision_control_status::frameRate.

Referenced by from_string().

◆ set_imageInput()

void guWhiteboard::VisionControlStatus::set_imageInput ( const bool &  t_newValue)
inline

Definition at line 364 of file VisionControlStatus.hpp.

References wb_vision_control_status::imageInput.

Referenced by from_string().

◆ set_imageTime()

void guWhiteboard::VisionControlStatus::set_imageTime ( const struct timeval &  t_newValue)
inline

Definition at line 479 of file VisionControlStatus.hpp.

References wb_vision_control_status::imageTime.

◆ set_jpegStreamQuality()

void guWhiteboard::VisionControlStatus::set_jpegStreamQuality ( const int &  t_newValue)
inline

Definition at line 379 of file VisionControlStatus.hpp.

References wb_vision_control_status::jpegStreamQuality.

Referenced by from_string().

◆ set_jpegStreamStride()

void guWhiteboard::VisionControlStatus::set_jpegStreamStride ( const int &  t_newValue)
inline

Definition at line 394 of file VisionControlStatus.hpp.

References wb_vision_control_status::jpegStreamStride.

Referenced by from_string().

◆ set_networkBottom()

void guWhiteboard::VisionControlStatus::set_networkBottom ( const enum NeuralNetworkType t_newValue)
inline

Definition at line 334 of file VisionControlStatus.hpp.

References wb_vision_control_status::networkBottom.

Referenced by from_string().

◆ set_networkTop()

void guWhiteboard::VisionControlStatus::set_networkTop ( const enum NeuralNetworkType t_newValue)
inline

Definition at line 319 of file VisionControlStatus.hpp.

References wb_vision_control_status::networkTop.

Referenced by from_string().

◆ set_pipeline()

void guWhiteboard::VisionControlStatus::set_pipeline ( const enum NamedPipeline t_newValue)
inline

Definition at line 274 of file VisionControlStatus.hpp.

References wb_vision_control_status::pipeline.

Referenced by from_string().

◆ set_pipelineRunning()

void guWhiteboard::VisionControlStatus::set_pipelineRunning ( const bool &  t_newValue)
inline

Definition at line 214 of file VisionControlStatus.hpp.

References wb_vision_control_status::pipelineRunning.

Referenced by from_string().

◆ set_runPipelineOnce()

void guWhiteboard::VisionControlStatus::set_runPipelineOnce ( const bool &  t_newValue)
inline

Definition at line 424 of file VisionControlStatus.hpp.

References wb_vision_control_status::runPipelineOnce.

Referenced by from_string().

◆ set_saveClassifiedImage()

void guWhiteboard::VisionControlStatus::set_saveClassifiedImage ( const bool &  t_newValue)
inline

Definition at line 259 of file VisionControlStatus.hpp.

References wb_vision_control_status::saveClassifiedImage.

Referenced by from_string().

◆ set_saveImage()

void guWhiteboard::VisionControlStatus::set_saveImage ( const enum SaveFileType t_newValue)
inline

Definition at line 244 of file VisionControlStatus.hpp.

References wb_vision_control_status::saveImage.

Referenced by from_string().

◆ set_selectedCamera()

void guWhiteboard::VisionControlStatus::set_selectedCamera ( const enum VisionCamera t_newValue)
inline

Definition at line 229 of file VisionControlStatus.hpp.

References wb_vision_control_status::selectedCamera.

Referenced by from_string().

◆ set_streamingSource()

void guWhiteboard::VisionControlStatus::set_streamingSource ( const enum StreamingType t_newValue)
inline

Definition at line 349 of file VisionControlStatus.hpp.

References wb_vision_control_status::streamingSource.

Referenced by from_string().

◆ streamingSource() [1/2]

enum StreamingType & guWhiteboard::VisionControlStatus::streamingSource ( )
inline

◆ streamingSource() [2/2]

enum StreamingType & guWhiteboard::VisionControlStatus::streamingSource ( ) const
inline

◆ to_string()


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