oaProp.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaProp.h
//
// This file contains the definitions for the oaProp class. The oaProp class is
// an abstract base for all types of properties.
//
// *****************************************************************************
// 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(oaProp_P)
#define oaProp_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBaseModTypes.h"
#include "oaObject.h"



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



// *****************************************************************************
// oaProp
// *****************************************************************************
class OA_BASE_DLL_API oaProp : public oaObject {
public:
    static oaProp           *find(const oaObject    *object,
                                  const oaString    &name,
                                  oaBoolean         crossDomain = false);

    void                    destroy();

    oaObject                *getOwner() const;
    void                    getName(oaString &name) const;
    void                    getValue(oaString &value) const;

    void                    setName(const oaString &name);

    oaProp                  *moveTo(oaObject *object);
    oaProp                  *copyTo(oaObject *object) const;

    enum {dtIndex = oacBasePropDataType};
    enum {domain = oacNoDomain};
};



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



END_OA_NAMESPACE

#endif

Return to top of page

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