vpMomentDatabase.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2025 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Pseudo-database used to handle dependencies between moments
 */

#ifndef VP_MOMENT_DATABASE_H
#define VP_MOMENT_DATABASE_H
 
#include <visp3/core/vpImage.h>
 
#include <cstring>
#include <iostream>
#include <map>
 
BEGIN_VISP_NAMESPACE
class vpMoment;
class vpMomentObject;

class VISP_EXPORT vpMomentDatabase
{
private:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  struct vpCmpStr_t
  {
    bool operator()(const std::string &a, const std::string &b) const { return std::strcmp(a.c_str(), b.c_str()) < 0; }
  };
#endif
  std::map<const std::string, vpMoment *, vpCmpStr_t> moments;
  void add(vpMoment &moment, const std::string &name);
 
public:
  vpMomentDatabase() : moments() { }
#if (VISP_CXX_STANDARD > VISP_CXX_STANDARD_98)
  vpMomentDatabase(const vpMomentDatabase &) = default;
#endif
  virtual ~vpMomentDatabase() { }
 
#if (VISP_CXX_STANDARD > VISP_CXX_STANDARD_98)
  vpMomentDatabase &operator=(const vpMomentDatabase &) = default;
#endif

  const vpMoment &get(const std::string &moment_name, bool &found) const;
  vpMoment &get_first() { return *(moments.begin()->second); }
 
  virtual void updateAll(vpMomentObject &object);
 
  friend class vpMoment;
  friend VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpMomentDatabase &v);
};
END_VISP_NAMESPACE
#endif