xentara-cpp-control v1.0.1
The Xentara C++ Control Framework
Loading...
Searching...
No Matches
xentara::ControlExporter< ConcreteControl > Class Template Reference

A class used to export your control class with Xentara. More...

#include <xentara/ControlExporter.hpp>

Public Member Functions

 ControlExporter ()
 Constructor.
 

Detailed Description

template<std::derived_from< Control > ConcreteControl>
class xentara::ControlExporter< ConcreteControl >

A class used to export your control class with Xentara.

This class is used to tell Xentara about the existence of the control class you implemented. You must have exactly one object of this class in one of your source files. The object can be one of the following:

  1. A global variable
  2. A static member variable of your control class

If your control class is called MyControl, for example, you can put the following into your source file:

const xentara::skills::cppControl::ControlExporter<MyControl> kMyControlRegister;
ControlExporter()
Constructor.
Definition ControlExporter.hpp:47
Attention
Do not put the object into a header file (*.h, *.hpp, *.hh etc.). Put the object into a source file (*.cpp, *.cc etc.).
Template Parameters
ControlThis is the control class you implemented. It must be derived from xentara::skills::cppControl::Control.

Constructor & Destructor Documentation

◆ ControlExporter()

template<std::derived_from< Control > ConcreteControl>
xentara::ControlExporter< ConcreteControl >::ControlExporter ( )

Constructor.

This constructor registers the Control class with Xentara.