gaze::pipeline::FallbackStep Class Reference

This pipeline step is used whenever something goes wrong. More...

#include "gaze/pipeline_steps/fallback_step.h"

Inheritance diagram for gaze::pipeline::FallbackStep:

Public Member Functions
	FallbackStep ()
void	process (util::Data &) override
void	visualize (util::Data &) override
Public Member Functions inherited from gaze::PipelineStep
	PipelineStep ()
std::string	get_name ()
virtual	~PipelineStep ()=default
Public Member Functions inherited from gaze::gui::Visualizeable< widget_type >
std::shared_ptr< dlib::drawable >	init (dlib::drawable_window &parent, int width, int height, std::string text="No visualization.") final
void	remove_widget () override
Public Member Functions inherited from gaze::gui::VisualizeableBase
virtual	~VisualizeableBase ()=default

Additional Inherited Members
Protected Attributes inherited from gaze::PipelineStep
int	number
std::string	name
Protected Attributes inherited from gaze::gui::Visualizeable< widget_type >
std::shared_ptr< widget_type >	widget

Detailed Description

This pipeline step is used whenever something goes wrong.

Definition at line 19 of file fallback_step.h.

Constructor & Destructor Documentation

gaze::pipeline::FallbackStep::FallbackStep

(

)

Initializes the FallbackStep. Reads all configuration for this step, in case something went wrong.

Definition at line 15 of file fallback_step.cpp.

References basic_string< char >::c_str(), gaze::util::get_config(), gaze::PipelineStep::name, and gaze::PipelineStep::number.

                           {
  YAML::Node config = util::get_config(this->number);
  this->name = config["name"] ?
    config["name"].as<std::string>() : "Fallback Step";
  YAML::Emitter emitter;
  emitter << config;
  this->config = emitter.c_str();
}

Member Function Documentation

void gaze::pipeline::FallbackStep::process ( util::Data &  )

overridevirtual

Does nothing.

Implements gaze::PipelineStep.

Definition at line 24 of file fallback_step.cpp.

                                    {
}

void gaze::pipeline::FallbackStep::visualize ( util::Data &  )

overridevirtual

Shows instructions on how to implement a custom pipeline step and register it successfully. Shows all information from gaze.yaml for this step (even if its the wrong step).

Implements gaze::gui::VisualizeableBase.

Definition at line 27 of file fallback_step.cpp.

References gaze::gui::Visualizeable< widget_type >::widget.

                                      {
  std::string text(""
      "This is a fallback in case something goes wrong.\n"
      "If you see this, then either your configuration is wrong (see below)\n"
      "or you forgot to implement one place where pipeline steps have to go.\n"
      "\nThis is your configuration:\n\n"
      + this->config +
      "\n\nAnd here is a checklist of what to do to develop a new step:\n"
      "- Create include/gaze/pipeline_steps/....h\n"
      "- Create src/gaze/pipeline_steps/....cpp\n"
      "- Add an #include to include/gaze/pipeline_steps.h\n"
      "- Add the *.cpp file to src/gaze/CMakeLists.txt\n"
      "- Add a case to init_pipeline in src/gaze/gaze_tracker.cpp\n"
      "- If you use a new widget, add traits to "
      "include/gaze/gui/visualizeable.h");
  this->widget->set_text(text);
}

---

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

• include/gaze/pipeline_steps/fallback_step.h
• src/gaze/pipeline_steps/fallback_step.cpp