oaAppProp.h

Go to the documentation of this file.

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



#if !defined(oaAppProp_P)
#define oaAppProp_P



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



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



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

    oaUInt4                 getSize() const;
#if !defined(OA_DEPRECATED)
    void                    getValue(oaByte *value) const;
#endif
    void                    getAppType(oaString &appType) const;
#if !defined(OA_DEPRECATED)
    void                    setAppType(const oaString &appType);
    void                    setValue(oaUInt4        size,
                                     const oaByte   *value);
#endif

    static oaAppProp        *create(oaObject            *object,
                                    const oaString      &name,
                                    const oaString      &appType,
                                    const oaByteArray   &valueArray);

    void                    getValue(oaByteArray &valueArray) const;
    void                    setValue(const oaByteArray &valueArray);
};



// *****************************************************************************
// Objects derived from oaProp
// *****************************************************************************
template<>
class oaTraits<oaAppProp> : public oaBaseTraits<oaAppProp> {
public:
    typedef oaPropModTypeEnum   modTypeType;
    typedef oaProp              parentType;
    enum {dtIndex = oacBasePropDataType};
    enum {dbType = oacBaseDBType};
    enum {dataTypeEnumVal = oacBasePropDataType};
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacAppPropType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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