oaConstraint.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaConstraint.h
//
// This file contains the definitions for the following oaConstraint class.
//
// *****************************************************************************
// 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 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaConstraint_P)
#define oaConstraint_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaConstraintParam.h"
#include "oaConstraintDef.h"



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



// *****************************************************************************
// Forward Class Declarations
// *****************************************************************************
class oaConstraintDef;
class oaValue;
class oaConstraintParamArray;



// *****************************************************************************
// oaConstraint
// *****************************************************************************
class OA_BASE_DLL_API oaConstraint : public oaObject {
public:
    void                    getName(oaString &name) const;
    oaConstraintDef         *getDef() const;
    oaValue                 *getValue() const;
    void                    getParams(oaConstraintParamArray &params) const;
    void                    getID(oaString &id) const;
    void                    getDescription(oaString &description) const;

    oaBoolean               hasParams() const;
    oaBoolean               isHard() const;

    void                    setValue(oaValue *value);
    void                    setParams(const oaConstraintParamArray &params);
    void                    setHard(oaBoolean isHard);
    void                    setID(const oaString &id);
    void                    setDescription(const oaString &description);

    void                    destroy();

    enum {dtIndex = oacBaseConstraintDataType};
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaConstraint> {
public:
    typedef oaObject                parentType;
    typedef oaConstraintModTypeEnum modTypeType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dbType = oacBaseDBType};
    enum {dtIndex = oacBaseConstraintDataType};
    enum {dataTypeEnumVal = oacBaseConstraintDataType};
    enum {abstractTypeEnumVal = oacConstraintType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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