oaRange.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaRange.h
//
// This file contains the definitions for the following classes:
//   oaRangeType
//      This class is a wrapper around oaRangeTypeEnum enumeration.
//   oaRangeBase
//      This is a base class for range classes.
//   oaRange
//      Instantiations of this template will represent the ranges for different
//      types of numerical data.
//   oaIntRange
//   oaUInt8Range
//      These are wrapper classes for template instances of oaRange classes.
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaRange_P)
#define oaRange_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaString.h"



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaString;
class oaIntRange;
class oaUInt8Range;

template <class T>
class oaChecker;



// *****************************************************************************
// oaRangeTypeEnum
// *****************************************************************************
#define oavNumRangeTypes        8

enum oaRangeTypeEnum {
    oacLessThanRangeType            = 0,
    oacLessThanEqualRangeType       = 1,
    oacGreaterThanRangeType         = 2,
    oacGreaterThanEqualRangeType    = 3,
    oacClosedRangeType              = 4,
    oacOpenRangeType                = 5,
    oacOpenLeftRangeType            = 6,
    oacOpenRightRangeType           = 7
};



// *****************************************************************************
// oaRangeType
// *****************************************************************************
class OA_BASE_DLL_API oaRangeType {
public:
                            oaRangeType(oaRangeTypeEnum valueIn);
                            oaRangeType(const oaString &name);
                            ~oaRangeType();

    const oaString          &getName() const;
                            operator                oaRangeTypeEnum() const;

private:
    static const oaString   *initNames();

    oaRangeTypeEnum         value;

    static const oaString   *names;
};



// *****************************************************************************
// oaRangeBase
// *****************************************************************************
class OA_BASE_DLL_API oaRangeBase {
public:
                            oaRangeBase();
                            oaRangeBase(oaRangeTypeEnum rangeTypeIn);

    oaRangeType             getRangeType() const;
    oaBoolean               hasLowerBound() const;
    oaBoolean               hasUpperBound() const;

private:
    oaRangeTypeEnum         rangeType;

    friend class oaChecker<oaIntRange>;
    friend class oaChecker<oaUInt8Range>;
};



// *****************************************************************************
// oaRange
// *****************************************************************************
template <class T>
class oaRange : public oaRangeBase {
public:
                            oaRange();
                            oaRange(oaRangeType type,
                                    T           value);
                            oaRange(oaRangeType type,
                                    T           lowerBoundIn,
                                    T           upperBoundIn);

    T                       getLowerBound() const;
    T                       getUpperBound() const;

    void                    setLowerBound(T lowerBoundIn);
    void                    setUpperBound(T upperBoundIn);
    void                    setBounds(T lowerBoundIn,
                                      T upperBoundIn);

    oaBoolean               isInRange(const T &value) const;

    oaBoolean               operator==(const oaRange<T> &range) const;
    oaBoolean               operator!=(const oaRange<T> &range) const;

private:
    T                       lowerBound;
    T                       upperBound;

    friend class oaChecker<oaIntRange>;
    friend class oaChecker<oaUInt8Range>;
};



// *****************************************************************************
// oaIntRange
// *****************************************************************************
class OA_BASE_DLL_API oaIntRange : public oaRange<oaInt4> {
public:
                            oaIntRange();
                            oaIntRange(oaRangeType  type,
                                       oaInt4       value);
                            oaIntRange(oaRangeType  type,
                                       oaInt4       lowerBoundIn,
                                       oaInt4       upperBoundIn);
};



// *****************************************************************************
// oaUInt8Range
// *****************************************************************************
class OA_BASE_DLL_API oaUInt8Range : public oaRange<oaUInt8> {
public:
                            oaUInt8Range();
                            oaUInt8Range(oaRangeType    type,
                                         oaUInt8        value);
                            oaUInt8Range(oaRangeType    type,
                                         oaUInt8        lowerBoundIn,
                                         oaUInt8        upperBoundIn);
};



END_OA_NAMESPACE

#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.