oaEnumProp.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaEnumProp.h
//
// This file contains the definitions for the oaEnumProp class. This class
// implements an enumeration-type property.
//
// *****************************************************************************
// 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(oaEnumProp_P)
#define oaEnumProp_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaProp.h"
#include "oaStringArray.h"



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



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaEnumCollection;



// *****************************************************************************
// oaEnumProp
// *****************************************************************************
class OA_BASE_DLL_API oaEnumProp : public oaProp {
public:
#if !defined(OA_DEPRECATED)
    static oaEnumProp       *create(oaObject        *object,
                                    const oaString  &name,
                                    const oaString  &value,
                                    oaUInt4         numEnums,
                                    const oaString  *enums);
#endif

    static oaEnumProp       *create(oaObject            *object,
                                    const oaString      &name,
                                    const oaString      &value,
                                    const oaStringArray &enums);

    void                    getValue(oaString &value) const;

    void                    setValue(const oaString &value);

    oaEnumCollection        getEnums() const;
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaEnumProp> {
public:
    typedef oaPropModTypeEnum   modTypeType;
    typedef oaProp              parentType;
    enum {dtIndex = oacBasePropDataType};
    enum {dataTypeEnumVal = oacBasePropDataType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacEnumPropType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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