JeVois  1.5
JeVois Smart Embedded Machine Vision Toolkit
Share this page:
ParameterDef.C
Go to the documentation of this file.
1 // ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
2 //
3 // JeVois Smart Embedded Machine Vision Toolkit - Copyright (C) 2016 by Laurent Itti, the University of Southern
4 // California (USC), and iLab at USC. See http://iLab.usc.edu and http://jevois.org for information about this project.
5 //
6 // This file is part of the JeVois Smart Embedded Machine Vision Toolkit. This program is free software; you can
7 // redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software
8 // Foundation, version 2. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
9 // without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
10 // License for more details. You should have received a copy of the GNU General Public License along with this program;
11 // if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
12 //
13 // Contact information: Laurent Itti - 3641 Watt Way, HNB-07A - Los Angeles, CA 90089-2520 - USA.
14 // Tel: +1 213 740 3527 - itti@pollux.usc.edu - http://iLab.usc.edu - http://jevois.org
15 // ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
16 /*! \file */
17 
18 // This code is inspired by the Neuromorphic Robotics Toolkit (http://nrtkit.org)
19 
21 
22 // ######################################################################
23 // ######################################################################
24 // ######################################################################
25 jevois::ParameterCategory::ParameterCategory(std::string const & name_, std::string const & description_) :
26  name(name_), description(description_)
27 { }
28 
29 // ######################################################################
30 // ######################################################################
31 // ######################################################################
32 jevois::ParameterDefBase::ParameterDefBase(std::string const & name, std::string const & description,
33  ParameterCategory const & category) :
34  itsName(name), itsDescription(description), itsCategory(category)
35 { }
36 
37 // ######################################################################
39 { }
40 
41 // ######################################################################
42 std::string const & jevois::ParameterDefBase::name() const
43 { return itsName; }
44 
45 // ######################################################################
46 std::string const & jevois::ParameterDefBase::description() const
47 { return itsDescription; }
48 
49 // ######################################################################
51 { return itsCategory; }
52 
ParameterCategory(std::string const &name_="General Options", std::string const &description_="")
Constructor.
Definition: ParameterDef.C:25
std::string itsName
Our name.
Definition: ParameterDef.H:73
virtual ~ParameterDefBase()
Destructor.
Definition: ParameterDef.C:38
std::string description
An optional short description of the category.
Definition: ParameterDef.H:39
ParameterDefBase(std::string const &name, std::string const &description, ParameterCategory const &category=ParameterCategory())
Construct a ParameterDefBase.
Definition: ParameterDef.C:32
A category to which multiple ParameterDef definitions can belong.
Definition: ParameterDef.H:33
std::string const & name() const
The parameter name (without the leading "--")
Definition: ParameterDef.C:42
std::string name
The name of the category.
Definition: ParameterDef.H:38
ParameterCategory itsCategory
Our category.
Definition: ParameterDef.H:75
ParameterCategory const & category() const
The Parameter category.
Definition: ParameterDef.C:50
std::string itsDescription
Our description string.
Definition: ParameterDef.H:74
std::string const & description() const
Description of what the parameter does.
Definition: ParameterDef.C:46