oaAppDef.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaAppDef.h
//
// This file contains the definitions for the oaAppDef and related classes.
// These classes implement attribute extensions in the database.
//
// oaAppDef
//   This is a base class for all types of attribute extensions.
//
// oaIntAppDef
//   This class implements an integer attribute extension.
//
// oaFloatAppDef
//   This class implements a float attribute extension.
//
// oaStringAppDef
//   This class implements a string attribute extension.
//
// oaIntraPointerAppDef
//   This class implements an attribute extension that is a poiner to
//   another object of the same type, in the same database.
//
// oaInterPointerAppDef
//   This class implements an attribute extension that is a pointer to
//   another object in the same database.
//
// oaDataAppDef
//   This class implements a fixed size byte array extension.
//
// oaVarDataAppDef
//   This class implements a variable sized byte array extension.
//
// oaTimeAppDef
//   This class implements an oaTime attribute extension.
//
// oaDoubleAppDef
//   This class implements a double attribute extension.
//
// oaVoidAppDef
//   This class implements a pointer attribute extension. This extension type
//   cannot be persistent, as pointer values will differ between sessions.
//
// oaBooleanAppDef
//   This class implemants a boolean attribute extension.
//
// *****************************************************************************
// 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(oaAppDef_P)
#define oaAppDef_P



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



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



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaString;
class oaAppObjectDef;



// *****************************************************************************
// oaAppDef
// *****************************************************************************
class OA_BASE_DLL_API oaAppDef : public oaSessionObject {
public:
    void                    getName(oaString &name) const;
#if !defined(OA_DEPRECATED)
    void                    getName(oaString &name);
#endif

    oaBoolean               isPersistent() const;

    void                    destroy(oaObject *object);

    oaBoolean               isUsedIn(const oaObject *database);
    void                    remove(oaObject *database);

protected:
    static oaAppDef         *getInt(const oaString          &name,
                                    oaUInt4                 dbType,
                                    oaUInt4                 dataType,
                                    oaDomain                domain,
                                    oaBoolean               persistent,
                                    oaInt4                  defValue,
                                    const oaAppObjectDef    *def = NULL);
    static oaAppDef         *getFloat(const oaString        &name,
                                      oaUInt4               dbType,
                                      oaUInt4               dataType,
                                      oaDomain              domain,
                                      oaBoolean             persistent,
                                      oaFloat               defValue,
                                      const oaAppObjectDef  *def = NULL);
    static oaAppDef         *getString(const oaString       &name,
                                       oaUInt4              dbType,
                                       oaUInt4              dataType,
                                       oaDomain             domain,
                                       oaBoolean            persistent,
                                       const oaString       &defValue,
                                       const oaAppObjectDef *def = NULL);
    static oaAppDef         *getIntra(const oaString        &name,
                                      oaUInt4               dbType,
                                      oaUInt4               dataType,
                                      oaDomain              domain,
                                      oaBoolean             persistent,
                                      const oaAppObjectDef  *def = NULL);
    static oaAppDef         *getInter(const oaString        &name,
                                      oaUInt4               dbType,
                                      oaUInt4               dataType,
                                      oaDomain              domain,
                                      oaBoolean             persistent,
                                      const oaAppObjectDef  *def = NULL);
    static oaAppDef         *getData(const oaString         &name,
                                     oaUInt4                dbType,
                                     oaUInt4                dataType,
                                     oaDomain               domain,
                                     oaBoolean              persistent,
                                     oaUInt4                size,
                                     const oaByte           *defValue,
                                     const oaAppObjectDef   *def = NULL);
    static oaAppDef         *getVarData(const oaString          &name,
                                        oaUInt4                 dbType,
                                        oaUInt4                 dataType,
                                        oaDomain                domain,
                                        oaBoolean               persistent,
                                        oaUInt4                 defSize,
                                        const oaByte            *defValue,
                                        const oaAppObjectDef    *def = NULL);
    static oaAppDef         *getTime(const oaString         &name,
                                     oaUInt4                dbType,
                                     oaUInt4                dataType,
                                     oaDomain               domain,
                                     oaBoolean              persistent,
                                     oaTime                 defValue,
                                     const oaAppObjectDef   *def = NULL);
    static oaAppDef         *getDouble(const oaString       &name,
                                       oaUInt4              dbType,
                                       oaUInt4              dataType,
                                       oaDomain             domain,
                                       oaBoolean            persistent,
                                       oaDouble             defValue,
                                       const oaAppObjectDef *def = NULL);
    static oaAppDef         *getVoid(const oaString         &name,
                                     oaUInt4                dbType,
                                     oaUInt4                dataType,
                                     oaDomain               domain,
                                     const oaAppObjectDef   *def = NULL);
    static oaAppDef         *getBoolean(const oaString          &name,
                                        oaUInt4                 dbType,
                                        oaUInt4                 dataType,
                                        oaDomain                domain,
                                        oaBoolean               persistent,
                                        oaBoolean               defValue,
                                        const oaAppObjectDef    *def = NULL);

    static oaAppDef         *find(const oaString        &name,
                                  oaUInt4               dbType,
                                  oaUInt4               dtIndex,
                                  oaDomain              domain,
                                  const oaAppObjectDef  *def = NULL);

    void                    setInt(oaObject *object,
                                   oaInt4   value);
    oaInt4                  getInt(const oaObject *object);
    oaInt4                  getIntDefault() const;

    void                    setFloat(oaObject   *object,
                                     oaFloat    value);
    oaFloat                 getFloat(const oaObject *object);
    oaFloat                 getFloatDefault() const;

    void                    setString(oaObject          *object,
                                      const oaString    &value);
    void                    getString(const oaObject    *object,
                                      oaString          &value);
    void                    getStringDefault(oaString &value) const;

    void                    setIntra(oaObject       *object,
                                     const oaObject *otherObject);
    oaObject                *getIntra(const oaObject *object);

    void                    setInter(oaObject       *object,
                                     const oaObject *otherObject);
    oaObject                *getInter(const oaObject *object);

    void                    setData(oaObject        *object,
                                    const oaByte    *byteData);
    void                    getData(const oaObject  *object,
                                    oaByte          *byteData);
    void                    getDataDefault(oaByte *byteData) const;
    oaUInt4                 getDataSize() const;

    void                    setVarData(oaObject     *object,
                                       oaUInt4      dataSize,
                                       const oaByte *value);
    void                    getVarData(const oaObject   *object,
                                       oaByte           *value);
    oaUInt4                 getVarDataSize(const oaObject *object);
    void                    getVarDataDefault(oaByte *value) const;
    oaUInt4                 getVarDataSizeDefault() const;

    void                    setTime(oaObject    *object,
                                    oaTime      value);
    oaTime                  getTime(const oaObject *object);
    oaTime                  getTimeDefault() const;

    void                    setDouble(oaObject  *object,
                                      oaDouble  value);
    oaDouble                getDouble(const oaObject *object);
    oaDouble                getDoubleDefault() const;

    void                    setVoid(oaObject    *object,
                                    const void  *value);
    void                    *getVoid(const oaObject *object);

    void                    setBoolean(oaObject     *object,
                                       oaBoolean    value);
    oaBoolean               getBoolean(const oaObject *object);
    oaBoolean               getBooleanDefault() const;
};



// *****************************************************************************
// oaIntAppDef
// *****************************************************************************
template <class T>
class oaIntAppDef : public oaAppDef {
public:
    static oaIntAppDef<T>   *get(const oaString &name,
                                 oaInt4         defValue = 0,
                                 oaBoolean      persist = true);
    static oaIntAppDef<T>   *get(const oaString         &name,
                                 const oaAppObjectDef   *objDef,
                                 oaInt4                 defValue = 0,
                                 oaBoolean              persist = true);
    static oaIntAppDef<T>   *find(const oaString &name);
    static oaIntAppDef<T>   *find(const oaString        &name,
                                  const oaAppObjectDef  *objDef);

    void                    set(T       *object,
                                oaInt4  value);
    oaInt4                  get(const T *object);

    oaInt4                  getDefault() const;
};



// *****************************************************************************
// oaFloatAppDef
// *****************************************************************************
template <class T>
class oaFloatAppDef : public oaAppDef {
public:
    static oaFloatAppDef<T> *get(const oaString &name,
                                 oaFloat        defValue = 0.,
                                 oaBoolean      persist = true);
    static oaFloatAppDef<T> *get(const oaString         &name,
                                 const oaAppObjectDef   *objDef,
                                 oaFloat                defValue = 0,
                                 oaBoolean              persist = true);
    static oaFloatAppDef<T> *find(const oaString &name);
    static oaFloatAppDef<T> *find(const oaString        &name,
                                  const oaAppObjectDef  *objDef);

    void                    set(T       *object,
                                oaFloat value);
    oaFloat                 get(const T *object);

    oaFloat                 getDefault() const;
};



// *****************************************************************************
// oaStringAppDef
// *****************************************************************************
template <class T>
class oaStringAppDef : public oaAppDef {
public:
    static oaStringAppDef<T>    *get(const oaString &name,
                                     const oaString &defValue = "",
                                     oaBoolean      persist = true);
    static oaStringAppDef<T>    *get(const oaString         &name,
                                     const oaAppObjectDef   *objDef,
                                     const oaString         &defValue = "",
                                     oaBoolean              persist = true);
    static oaStringAppDef<T>    *find(const oaString &name);
    static oaStringAppDef<T>    *find(const oaString        &name,
                                      const oaAppObjectDef  *objDef);

    void                        set(T               *object,
                                    const oaString  &value);
    void                        get(const T     *object,
                                    oaString    &value);

    void                        getDefault(oaString &value) const;
};



// *****************************************************************************
// oaIntraPointerAppDef
// *****************************************************************************
template <class T>
class oaIntraPointerAppDef : public oaAppDef {
public:
    static oaIntraPointerAppDef<T>  *get(const oaString &name,
                                         oaBoolean      persist = true);
    static oaIntraPointerAppDef<T>  *get(const oaString         &name,
                                         const oaAppObjectDef   *objDef,
                                         oaBoolean              persist = true);
    static oaIntraPointerAppDef<T>  *find(const oaString &name);
    static oaIntraPointerAppDef<T>  *find(const oaString        &name,
                                          const oaAppObjectDef  *objDef);

    void                            set(T       *object,
                                        const T *otherObject);
    T                               *get(const T *object);
};



// *****************************************************************************
// oaInterPointerAppDef
// *****************************************************************************
template <class T>
class oaInterPointerAppDef : public oaAppDef {
public:
    static oaInterPointerAppDef<T>  *get(const oaString &name,
                                         oaBoolean      persist = true);
    static oaInterPointerAppDef<T>  *get(const oaString         &name,
                                         const oaAppObjectDef   *objDef,
                                         oaBoolean              persist = true);
    static oaInterPointerAppDef<T>  *find(const oaString &name);
    static oaInterPointerAppDef<T>  *find(const oaString        &name,
                                          const oaAppObjectDef  *objDef);

    void                            set(T               *object,
                                        const oaObject  *otherObject);
    oaObject                        *get(const T *object);
};



// *****************************************************************************
// oaDataAppDef
// *****************************************************************************
template <class T>
class oaDataAppDef : public oaAppDef {
public:
    static oaDataAppDef<T>  *get(const oaString &name,
                                 oaUInt4        dataSize,
                                 const oaByte   *defValue,
                                 oaBoolean      persist = true);
    static oaDataAppDef<T>  *get(const oaString         &name,
                                 const oaAppObjectDef   *objDef,
                                 oaUInt4                dataSize,
                                 const oaByte           *defValue,
                                 oaBoolean              persist = true);
    static oaDataAppDef<T>  *find(const oaString &name);
    static oaDataAppDef<T>  *find(const oaString        &name,
                                  const oaAppObjectDef  *objDef);

    void                    set(T               *object,
                                const oaByte    *value);
    void                    get(const T *object,
                                oaByte  *value);
    oaUInt4                 getSize();

    void                    getDefault(oaByte *value) const;
};



// *****************************************************************************
// oaVarDataAppDef
// *****************************************************************************
template <class T>
class oaVarDataAppDef : public oaAppDef {
public:
    static oaVarDataAppDef<T>   *get(const oaString &name,
                                     oaBoolean      persist = true);
    static oaVarDataAppDef<T>   *get(const oaString &name,
                                     oaUInt4        defSize,
                                     const oaByte   *defValue,
                                     oaBoolean      persist = true);
    static oaVarDataAppDef<T>   *get(const oaString         &name,
                                     const oaAppObjectDef   *objDef,
                                     oaBoolean              persist = true);
    static oaVarDataAppDef<T>   *get(const oaString         &name,
                                     const oaAppObjectDef   *objDef,
                                     oaUInt4                defSize,
                                     const oaByte           *defValue,
                                     oaBoolean              persist = true);
    static oaVarDataAppDef<T>   *find(const oaString &name);
    static oaVarDataAppDef<T>   *find(const oaString        &name,
                                      const oaAppObjectDef  *objDef);

    void                        set(T               *object,
                                    oaUInt4         dataSize,
                                    const oaByte    *value);
    void                        get(const T *object,
                                    oaByte  *value);
    oaUInt4                     getSize(const T *object);

    oaUInt4                     getDefaultSize() const;
    void                        getDefault(oaByte *value) const;
};



// *****************************************************************************
// oaTimeAppDef
// *****************************************************************************
template <class T>
class oaTimeAppDef : public oaAppDef {
public:
    static oaTimeAppDef<T>  *get(const oaString &name,
                                 oaTime         defValue = oaTime(0),
                                 oaBoolean      persist = true);
    static oaTimeAppDef<T>  *get(const oaString         &name,
                                 const oaAppObjectDef   *objDef,
                                 oaTime                 defValue = oaTime(0),
                                 oaBoolean              persist = true);
    static oaTimeAppDef<T>  *find(const oaString &name);
    static oaTimeAppDef<T>  *find(const oaString        &name,
                                  const oaAppObjectDef  *objDef);

    void                    set(T       *object,
                                oaTime  value);
    oaTime                  get(const T *object);

    oaTime                  getDefault() const;
};



// *****************************************************************************
// oaDoubleAppDef
// *****************************************************************************
template <class T>
class oaDoubleAppDef : public oaAppDef {
public:
    static oaDoubleAppDef<T>    *get(const oaString &name,
                                     oaDouble       defValue = 0.,
                                     oaBoolean      persist = true);
    static oaDoubleAppDef<T>    *get(const oaString         &name,
                                     const oaAppObjectDef   *objDef,
                                     oaDouble               defValue = 0.,
                                     oaBoolean              persist = true);
    static oaDoubleAppDef<T>    *find(const oaString &name);
    static oaDoubleAppDef<T>    *find(const oaString        &name,
                                      const oaAppObjectDef  *objDef);

    void                        set(T           *object,
                                    oaDouble    value);
    oaDouble                    get(const T *object);

    oaDouble                    getDefault() const;
};



// *****************************************************************************
// oaVoidPointerAppDef
// *****************************************************************************
template <class T>
class oaVoidPointerAppDef : public oaAppDef {
public:
    static oaVoidPointerAppDef<T>   *get(const oaString &name);
    static oaVoidPointerAppDef<T>   *get(const oaString         &name,
                                         const oaAppObjectDef   *objDef);
    static oaVoidPointerAppDef<T>   *find(const oaString &name);
    static oaVoidPointerAppDef<T>   *find(const oaString        &name,
                                          const oaAppObjectDef  *objDef);

    void                            set(T           *object,
                                        const void  *value);
    void                            *get(const T *object);
};



// *****************************************************************************
// oaVoidPointerAppDef
// *****************************************************************************
template <class T>
class oaBooleanAppDef : public oaAppDef {
public:
    static oaBooleanAppDef<T>   *get(const oaString &name,
                                     oaBoolean      defValue = false,
                                     oaBoolean      persist = true);
    static oaBooleanAppDef<T>   *get(const oaString         &name,
                                     const oaAppObjectDef   *objDef,
                                     oaBoolean              defValue = false,
                                     oaBoolean              persist = true);
    static oaBooleanAppDef<T>   *find(const oaString &name);
    static oaBooleanAppDef<T>   *find(const oaString        &name,
                                      const oaAppObjectDef  *objDef);

    void                        set(T           *object,
                                    oaBoolean   value);
    oaBoolean                   get(const T *object);

    oaBoolean                   getDefault() const;
};



// *****************************************************************************
// Traits
// *****************************************************************************
template<>
class oaTraits<oaAppDef> {
public:
    typedef oaSessionObject parentType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dbType = oacBaseDBType};
    enum {abstractTypeEnumVal = oacAppDefType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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