Visual Servoing Platform  version 3.6.1 under development (2024-02-13)
vpMoment.h
1 /*
2  * ViSP, open source Visual Servoing Platform software.
3  * Copyright (C) 2005 - 2023 by Inria. All rights reserved.
4  *
5  * This software is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  * See the file LICENSE.txt at the root directory of this source
10  * distribution for additional information about the GNU GPL.
11  *
12  * For using ViSP with software that can not be combined with the GNU
13  * GPL, please contact Inria about acquiring a ViSP Professional
14  * Edition License.
15  *
16  * See https://visp.inria.fr for more information.
17  *
18  * This software was developed at:
19  * Inria Rennes - Bretagne Atlantique
20  * Campus Universitaire de Beaulieu
21  * 35042 Rennes Cedex
22  * France
23  *
24  * If you have questions regarding the use of this file, please contact
25  * Inria at visp@inria.fr
26  *
27  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
28  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
29  *
30  * Description:
31  * Base for 2D moment descriptor
32  */
33 
39 #ifndef _vpMoment_h_
40 #define _vpMoment_h_
41 
42 #include <iostream>
43 #include <vector>
44 
45 #include <visp3/core/vpConfig.h>
46 #include <visp3/core/vpException.h>
47 
48 class vpMomentDatabase;
49 class vpMomentObject;
50 
104 class VISP_EXPORT vpMoment
105 {
106 private:
107  vpMomentObject *object;
108  vpMomentDatabase *moments;
109  std::string m_name;
110 
111 protected:
112  std::vector<double> values;
117  inline vpMomentDatabase &getMoments() const { return *moments; }
118 
119  // private:
120  //#ifndef DOXYGEN_SHOULD_SKIP_THIS
121  // vpMoment(const vpMoment &)
122  // : object(nullptr), moments(nullptr), values()
123  // {
124  // throw vpException(vpException::functionNotImplementedError,"Not
125  // implemented!");
126  // }
127  // vpMoment &operator=(const vpMoment &){
128  // throw vpException(vpException::functionNotImplementedError,"Not
129  // implemented!"); return *this;
130  // }
131  //#endif
132 
133 public:
134  vpMoment();
135 
139  virtual ~vpMoment() { }
140 
143  virtual void compute() = 0;
144  inline const vpMomentObject &getObject() const { return *object; }
149  const std::vector<double> &get() const { return values; }
150  void linkTo(vpMomentDatabase &moments);
151  virtual const std::string name() const = 0;
152  virtual void printDependencies(std::ostream &os) const;
153  void update(vpMomentObject &object);
155  friend VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpMoment &m);
156 };
157 #endif
This class allows to register all vpMoments so they can access each other according to their dependen...
Class for generic objects.
This class defines shared methods/attributes for 2D moments.
Definition: vpMoment.h:105
virtual const std::string name() const =0
std::vector< double > values
Definition: vpMoment.h:112
const vpMomentObject & getObject() const
Definition: vpMoment.h:144
virtual void compute()=0
vpMomentDatabase & getMoments() const
Definition: vpMoment.h:117
const std::vector< double > & get() const
Definition: vpMoment.h:149
virtual ~vpMoment()
Definition: vpMoment.h:139