iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nrt::ParameterCategory Struct Reference

#include <nrt/Core/Model/ParameterDef.H>

A category to which multiple ParameterDefs can belong.

ParameterDefs which belong to the same category will show up next to each other when the user requests –help on the command line.

Examples:
tests/test-Component.C, and tests/test-Option.C.

Definition at line 51 of file ParameterDef.H.

Public Member Functions

 ParameterCategory (std::string const &name_="General Use Options", std::string const &description_="")
 Constructor. More...
 

Public Attributes

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

Constructor & Destructor Documentation

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

Constructor.

Parameters
name_The name of this category.
description_An optional short description of the category

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