jevois::ParameterCategory Struct Reference

#include <jevois/Component/ParameterDef.H>

A category to which multiple ParameterDef definitions can belong.

All the ParameterDef classes which belong to the same category will show up next to each other when the user requests the help message.

Definition at line 33 of file ParameterDef.H.

Collaboration diagram for jevois::ParameterCategory:

Public Member Functions
	ParameterCategory (std::string const &name_="General Options", std::string const &description_="")
	Constructor.

Public Attributes
std::string	name
	The name of the category.
std::string	description
	An optional short description of the category.

Constructor & Destructor Documentation

ParameterCategory()

jevois::ParameterCategory::ParameterCategory	(	std::string const &	name_ = "General Options",
		std::string const &	description_ = ""
	)

Constructor.

Definition at line 25 of file ParameterDef.C.

Member Data Documentation

description

std::string jevois::ParameterCategory::description

An optional short description of the category.

Definition at line 39 of file ParameterDef.H.

name

std::string jevois::ParameterCategory::name

The name of the category.

Definition at line 38 of file ParameterDef.H.

---

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

• include/jevois/Component/ParameterDef.H
• src/jevois/Component/ParameterDef.C