oaAppObjectDef.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaAppObjectDef.h
//
// This file contains the definition for the oaAppObjectDef and oaAppObject
// classes. The oaAppObject class implements an object that contains
// information about a particular appObject. The supporting classes include:
//
//  oaAppObjectDef
//      This class registers an object extension with a given extension name in
//      the session database.
//
//  oaAppObject
//      This class implements an appObject. Methods for creating, deleting, and
//      querying an appObjects attributes are in this 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(oaObjectAppDef_P)
#define oaObjectAppDef_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBaseModTypes.h"
#include "oaTimeStamp.h"
#include "oaSessionObject.h"



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



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



// *****************************************************************************
// oaAppObjectDef
// *****************************************************************************
class OA_BASE_DLL_API oaAppObjectDef : public oaSessionObject {
public:
    static oaAppObjectDef   *get(const oaString &nameIn);
    static oaAppObjectDef   *find(const oaString &nameIn);

    void                    getName(oaString &name) const;

    oaBoolean               isUsedIn(const oaObject *database);
    void                    remove(oaObject *database);
    oaTimeStamp             &getTimeStamp(const oaObject *database);
};



// *****************************************************************************
// oaAppObject
// *****************************************************************************
class OA_BASE_DLL_API oaAppObject : public oaObject {
public:

    static oaAppObject      *create(oaObject        *database,
                                    oaAppObjectDef  *def);
    void                    destroy();

    oaAppObjectDef          *getAppObjectDef() const;
};



// *****************************************************************************
// Objects derived from oaObject
// *****************************************************************************
template<>
class oaTraits<oaAppObject> {
public:
    typedef oaObject                parentType;
    typedef oaAppObjectModTypeEnum  modTypeType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {dtIndex = oacBaseAppObjectDataType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacAppObjectType};
    enum {dataTypeEnumVal = oacBaseAppObjectDataType};
};

template<>
class oaTraits<oaAppObjectDef> {
public:
    typedef oaSessionObject parentType;
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {dbType = oacBaseDBType};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacAppObjectDefType};
    enum {dataTypeEnumVal = oacAppObjectDefDataType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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