/* -*- C++ -*- */
/** @file "IntegerDomain.hh"
 * @brief Integer domain representation
 *
 * This files defines an integer based domain
 *
 * @author Frederic Py <fpy@mbari.org>
 * @ingroup domains
 */
/*********************************************************************
 * Software License Agreement (BSD License)
 * 
 *  Copyright (c) 2011, MBARI.
 *  All rights reserved.
 * 
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 * 
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of the TREX Project nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 * 
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef H_IntegerDomain 
# define H_IntegerDomain 

# include "IntervalDomain.hh" 

namespace TREX {
  namespace transaction {
    
    /** @brief Integer domain
     *
     * This class implements a a domain used to describe integers.
     * The symbolic type name for this class is "int" and it fully
     * support XML serialization.
     *
     * @author Frederic Py <fpy@mbari.org>
     * @ingroup domains
     */
    class IntegerDomain :public IntervalDomain<long long, false> {
    public:
      /** @brief Symbolic type name for this domain
       *
       * This static attibute gives an access to the symbolic name
       * used for IntegerDomain. As stated in the main class description
       * its value is "int" but programmers who want to use this name
       * would better use this variable in case it changes in the future
       */
      static TREX::utils::Symbol const type_name;
      
      /** @brief Constructor
       *
       * Create a full integer domain
       */
      IntegerDomain() 
	:IntervalDomain<long long, false>(type_name) {}
      /** @brief Constructor
       *
       * @param node A XML node
       *
       * Create a integer domain by parsing @e node.
       * 
       * @throw TREX::utils::bad_string_cast One of the attributes is
       * not correctly formatted
       * @throw EmptyDomain the resulting interval is empty
       */
      IntegerDomain(boost::property_tree::ptree::value_type &node)
	:IntervalDomain<long long, false>(node) {}
      /** @brief Constructor
       * @param lb A lower bound
       * @param ub An upper bound
       *
       * Create an integer domain represented by the interval [lb, ub]
       * @pre [lb, ub] is a valid interval (ie not empty)
       * @throw EmptyDomain the resulting domain is empty
       */
      IntegerDomain(IntervalDomain<long long, false>::bound const &lb,
		    IntervalDomain<long long, false>::bound const ub)
	:IntervalDomain<long long, false>(type_name, lb, ub) {}
      /** @brief Constructor
       * @param val A value
       *
       * Create a new integer domain with only the value 
       * @e val. in other terms the domain is represented by the interval
       * [val, val]
       */
      IntegerDomain(long long val) 
	:IntervalDomain<long long, false>(type_name, val) {}
      /** @brief Destructor */
      ~IntegerDomain() {}

      DomainBase *copy() const {
	return new IntegerDomain(*this);
      }
      
    }; // IntegerDomain 

  } // TREX::utils
} // TREX

#endif // H_IntegerDomain
