WPropertyConstraintIsValid.h

//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// OpenWalnut is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------
 
#ifndef WPROPERTYCONSTRAINTISVALID_H
#define WPROPERTYCONSTRAINTISVALID_H
 
#include <memory>
 
#include "../WPropertyTypes.h"
#include "WPropertyConstraintTypes.h"
 
/**
 * This class allows constraining properties to only be set if a isValid method returns true. This constraint is especially useful for class-type
 * typenames T providing a isValid method.
 */
template< typename T >
class WPropertyConstraintIsValid: public WPropertyVariable< T >::PropertyConstraint
{
public:
    /**
     * Constructor.
     */
    WPropertyConstraintIsValid();
 
    /**
     * Destructor.
     */
    virtual ~WPropertyConstraintIsValid();
 
    /**
     * Checks whether the specified new value is a valid, using T::isValid.
     *
     * \param property the property whose new value should be set.
     * \param value the new value to check
     *
     * \return true if value.isValid()
     */
    virtual bool accept( std::shared_ptr< WPropertyVariable< T > > property, const T& value );
 
    /**
     * Allows simple identification of the real constraint type.
     *
     * \return the type
     */
    virtual PROPERTYCONSTRAINT_TYPE getType();
 
    /**
     * Method to clone the constraint and create a new one with the correct dynamic type.
     *
     * \return the constraint.
     */
    virtual std::shared_ptr< typename WPropertyVariable< T >::PropertyConstraint > clone();
 
private:
};
 
template < typename T >
WPropertyConstraintIsValid< T >::WPropertyConstraintIsValid()
{
}
 
template < typename T >
WPropertyConstraintIsValid< T >::~WPropertyConstraintIsValid()
{
}
 
template < typename T >
bool WPropertyConstraintIsValid< T >::accept( std::shared_ptr< WPropertyVariable< T > > /* property */, const T& value )
{
    return value.isValid();
}
 
template < typename T >
PROPERTYCONSTRAINT_TYPE WPropertyConstraintIsValid< T >::getType()
{
    return PC_ISVALID;
}
 
template < typename T >
std::shared_ptr< typename WPropertyVariable< T >::PropertyConstraint > WPropertyConstraintIsValid< T >::clone()
{
    return std::shared_ptr< typename WPropertyVariable< T >::PropertyConstraint >( new WPropertyConstraintIsValid< T >( *this ) );
}
 
#endif  // WPROPERTYCONSTRAINTISVALID_H