dust3d/thirdparty/cgal/CGAL-5.1/include/CGAL/Classification/Feature_base.h

116 lines
2.6 KiB
C++

// Copyright (c) 2017 GeometryFactory Sarl (France).
// All rights reserved.
//
// This file is part of CGAL (www.cgal.org).
//
// $URL: https://github.com/CGAL/cgal/blob/v5.1/Classification/include/CGAL/Classification/Feature_base.h $
// $Id: Feature_base.h 0779373 2020-03-26T13:31:46+01:00 Sébastien Loriot
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-Commercial
//
// Author(s) : Simon Giraudot
#ifndef CGAL_CLASSIFICATION_FEATURE_BASE_H
#define CGAL_CLASSIFICATION_FEATURE_BASE_H
#include <CGAL/license/Classification.h>
#include <boost/shared_ptr.hpp>
#include <vector>
namespace CGAL {
namespace Classification {
/*!
\ingroup PkgClassificationFeature
\brief Abstract class describing a classification feature that
associates a scalar value to each item of the classification input.
*/
class Feature_base
{
std::string m_name;
public:
/// \cond SKIP_IN_MANUAL
Feature_base() : m_name ("abstract_feature") { }
virtual ~Feature_base() { }
/// \endcond
/*!
\brief Returns the name of the feature (initialized to
`abstract_feature` for `Feature_base`).
*/
const std::string& name() const { return m_name; }
/*!
\brief Changes the name of the feature.
*/
void set_name (const std::string& name) { m_name = name; }
/*!
\brief Returns the value taken by the feature for at the item for
the item at position `index`. This method must be implemented by
inherited classes.
*/
virtual float value (std::size_t index) = 0;
};
#ifdef DOXYGEN_RUNNING
/*!
\ingroup PkgClassificationFeature
\brief %Handle to a `Feature_base`.
\cgalModels Handle
*/
class Feature_handle { };
#else
//typedef boost::shared_ptr<Feature_base> Feature_handle;
class Feature_set;
class Feature_handle
{
friend Feature_set;
boost::shared_ptr<boost::shared_ptr<Feature_base> > m_base;
template <typename Feature>
Feature_handle (Feature* f) : m_base (new boost::shared_ptr<Feature_base>(f)) { }
template <typename Feature>
void attach (Feature* f) const
{
*m_base = boost::shared_ptr<Feature_base>(f);
}
public:
Feature_handle() : m_base (new boost::shared_ptr<Feature_base>()) { }
Feature_base& operator*() { return **m_base; }
Feature_base* operator->() { return m_base->get(); }
const Feature_base& operator*() const { return **m_base; }
const Feature_base* operator->() const { return m_base->get(); }
bool operator< (const Feature_handle& other) const { return *m_base < *(other.m_base); }
bool operator== (const Feature_handle& other) const { return *m_base == *(other.m_base); }
};
#endif
} // namespace Classification
} // namespace CGAL
#endif // CGAL_CLASSIFICATION_FEATURE_BASE_H