g2o
Loading...
Searching...
No Matches
parameter_container.h
Go to the documentation of this file.
1// g2o - General Graph Optimization
2// Copyright (C) 2011 R. Kuemmerle, G. Grisetti, W. Burgard
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are
7// met:
8//
9// * Redistributions of source code must retain the above copyright notice,
10// this list of conditions and the following disclaimer.
11// * Redistributions in binary form must reproduce the above copyright
12// notice, this list of conditions and the following disclaimer in the
13// documentation and/or other materials provided with the distribution.
14//
15// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
16// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
18// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
21// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
27#ifndef G2O_GRAPH_PARAMETER_CONTAINER_HH_
28#define G2O_GRAPH_PARAMETER_CONTAINER_HH_
29
30#include <iosfwd>
31#include <map>
32#include <string>
33
34namespace g2o {
35
36class Parameter;
37
41class ParameterContainer : protected std::map<int, Parameter*> {
42 public:
43 typedef std::map<int, Parameter*> BaseClass;
44
50 ParameterContainer(bool isMainStorage_ = true);
51 virtual ~ParameterContainer();
53 bool addParameter(Parameter* p);
55 Parameter* getParameter(int id);
57 const Parameter* getParameter(int id) const;
61 virtual bool read(std::istream& is,
62 const std::map<std::string, std::string>* renamedMap = 0);
64 virtual bool write(std::ostream& os) const;
65 bool isMainStorage() const { return _isMainStorage; }
66 void clear();
67
68 // stuff of the base class that should re-appear
69 using BaseClass::size;
70
71 protected:
73};
74
75} // namespace g2o
76
77#endif
virtual bool write(std::ostream &os) const
write the data to a stream
std::map< int, Parameter * > BaseClass
Parameter * detachParameter(int id)
remove a parameter from the container, i.e., the user now owns the pointer
bool addParameter(Parameter *p)
add parameter to the container
Parameter * getParameter(int id)
return a parameter based on its ID
virtual bool read(std::istream &is, const std::map< std::string, std::string > *renamedMap=0)
read parameters from a stream