PropertyVerifier.h

Go to the documentation of this file.

#ifndef GAUDIKERNEL_PROPERTYVERIFIER_H
#define GAUDIKERNEL_PROPERTYVERIFIER_H
// ============================================================================
// Include files
// ============================================================================
// STD& STL
// ============================================================================
#include <algorithm>
// ============================================================================
// GaudiKernel
// ============================================================================
#include "GaudiKernel/PropertyTypeTraits.h"
// ============================================================================
/**********************************************************
 * Verifier Classes are used with Property Classes to
 * provide validation criteria for Property values.
 *
 **********************************************************/
template< class T >
class PropertyVerifier
{
public:
  // Data and Function Members for Collaborators.
  // Constructors - compiler generated default is ok
  // Destructor
  virtual ~PropertyVerifier() = default;

  // Copy Constructor - compiler generated default is ok
  // Assignment Operator - compiler generated default is ok
  // Accessor members (const)
  virtual bool isValid ( const typename Gaudi::Utils::PropertyTypeTraits<T>::CVal value ) const = 0;
};
// ============================================================================
template< class T >
class NullVerifier : public PropertyVerifier< T >
{
public:
  // Data and Function Members for Collaborators.
  // Constructors - compiler generated default is ok
  // Destructor
  ~NullVerifier() override = default;

  // Copy Constructor - compiler generated default is ok
  // Assignment Operator - compiler generated default is ok

  // Accessor members (const)
  bool isValid
  ( const typename Gaudi::Utils::PropertyTypeTraits<T>::CVal /* val */ ) const override
  { return true; }

};
// ============================================================================
template< class T >
class BoundedVerifier : public PropertyVerifier< T > {     // Abstract derived class
public:
  BoundedVerifier()
    : m_hasLowerBound( false ),
      m_hasUpperBound( false ),
      m_lowerBound( T() ),
      m_upperBound( T() ) { }

  ~BoundedVerifier() override = default;

  bool isValid( const typename Gaudi::Utils::PropertyTypeTraits<T>::CVal value ) const override
  {
    return
      (( m_hasLowerBound && ( *value < m_lowerBound ) ) ? false : true ) &&
      (( m_hasUpperBound && ( *value > m_upperBound ) ) ? false : true )  ;
  }

  bool        hasLower() const { return m_hasLowerBound; }
  bool        hasUpper() const { return m_hasUpperBound; }
  const T&    lower()    const { return m_lowerBound; }
  const T&    upper()    const { return m_upperBound; }

  void setLower( const T& value ) { m_hasLowerBound = true; m_lowerBound = value; }
  void setUpper( const T& value ) { m_hasUpperBound = true; m_upperBound = value; }
  void clearLower()  { m_hasLowerBound = false; m_lowerBound = T(); }
  void clearUpper()  { m_hasUpperBound = false; m_upperBound = T(); }

  void setBounds( const T& lower, const T& upper)
  {
    setLower( lower );
    setUpper( upper );
  }

  void clearBounds()
  {
    clearLower();
    clearUpper();
  }

private:
  bool  m_hasLowerBound;
  bool  m_hasUpperBound;
  T     m_lowerBound;
  T     m_upperBound;
};
// ============================================================================

// =======================================================================
// The END
// =======================================================================
#endif    // GAUDIKERNEL_PROPERTYVERIFIER_H
// =======================================================================