mc_rtc::gui::FormObjectInput Struct Reference

#include <mc_rtc/gui/Form.h>

Inheritance diagram for mc_rtc::gui::FormObjectInput:
Collaboration diagram for mc_rtc::gui::FormObjectInput:

Public Member Functions

template<typename... Args>
 FormObjectInput (const std::string &name, bool required, Args &&... args)
 
void write_ (mc_rtc::MessagePackBuilder &builder)
 
- Public Member Functions inherited from mc_rtc::gui::FormElement< FormObjectInput, Elements::Form >
void write (mc_rtc::MessagePackBuilder &builder)
 
 FormElement ()
 
- Public Member Functions inherited from mc_rtc::gui::details::FormElements
template<typename... Args>
 FormElements (Args &&... args)
 
template<typename T >
void addElement (T &&element)
 
void write_impl (mc_rtc::MessagePackBuilder &builder)
 

Static Public Member Functions

static constexpr bool is_dynamic ()
 
static constexpr size_t write_size_ ()
 
- Static Public Member Functions inherited from mc_rtc::gui::FormElement< FormObjectInput, Elements::Form >
static constexpr size_t write_size ()
 
static constexpr bool is_dynamic ()
 

Additional Inherited Members

- Public Types inherited from mc_rtc::gui::FormElement< FormObjectInput, Elements::Form >
using is_form_element_t = std::true_type
 
- Static Public Attributes inherited from mc_rtc::gui::FormElement< FormObjectInput, Elements::Form >
static constexpr auto type
 
- Protected Member Functions inherited from mc_rtc::gui::FormElement< FormObjectInput, Elements::Form >
 FormElement (const std::string &name, bool required)
 
- Protected Member Functions inherited from mc_rtc::gui::details::FormElements
template<typename... Args>
void write_elements (mc_rtc::MessagePackBuilder &, Args &&...)
 
template<typename Arg , typename... Args>
void write_elements (mc_rtc::MessagePackBuilder &builder, Arg &&element, Args &&... args)
 
template<typename T >
void addDynamicElement (T &&element)
 
- Protected Attributes inherited from mc_rtc::gui::FormElement< FormObjectInput, Elements::Form >
std::string name_
 
bool required_
 
- Protected Attributes inherited from mc_rtc::gui::details::FormElements
size_t count_
 
std::vector< std::function< void(mc_rtc::MessagePackBuilder &)> > dynamic_elements_
 
std::vector< char > data_
 
size_t data_size_
 

Detailed Description

Creates a form within another form

If the object is required then it will be received in the callback and its own required elements are also contained in the object

Constructor & Destructor Documentation

◆ FormObjectInput()

template<typename... Args>
mc_rtc::gui::FormObjectInput::FormObjectInput ( const std::string &  name,
bool  required,
Args &&...  args 
)
inline

Member Function Documentation

◆ is_dynamic()

static constexpr bool mc_rtc::gui::FormObjectInput::is_dynamic ( )
inlinestaticconstexpr

◆ write_()

void mc_rtc::gui::FormObjectInput::write_ ( mc_rtc::MessagePackBuilder builder)
inline

◆ write_size_()

static constexpr size_t mc_rtc::gui::FormObjectInput::write_size_ ( )
inlinestaticconstexpr

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