oaObject.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaObject.h
//
// This file contains the definition for the oaObject class. This is an abstract
// class that is the base for all OpenAccess database objects.
//
// Note that construction, desctruction, copying, and assigning of objects is
// not allowed. These methods are specified as private to insure that
// application code does not call them.
//
// *****************************************************************************
// 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$
// *****************************************************************************
// *****************************************************************************



#if !defined(oaObject_P)
#define oaObject_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaType.h"
#include "oaDomain.h"



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



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaConstraintGroup;
class oaProp;
class oaObject;
class oaAppDef;
class oaGroupMember;
class oaGroup;
template <class U, class V>
class OA_BASE_DLL_PVT oaCollection;



// *****************************************************************************
// oaObject
// *****************************************************************************
class OA_BASE_DLL_API oaObject {
public:
    oaBoolean                               isValid() const;
    oaType                                  getType() const;
    oaDomain                                getDomain() const;
    oaBoolean                               isTech() const;
    oaBoolean                               isDesign() const;
    oaBoolean                               isDM() const;
    oaBoolean                               isDMData() const;
    oaBoolean                               isWafer() const;
    oaBoolean                               isSession() const;
    oaBoolean                               isProp() const;
    oaBoolean                               isGroup() const;
    oaBoolean                               isGroupMember() const;
    oaBoolean                               isAppObject() const;
    oaBoolean                               isConstraint() const;
    oaBoolean                               isConstraintGroup() const;
    oaBoolean                               isConstraintGroupMem() const;
    oaBoolean                               isConstraintGroupHeader() const;
    oaBoolean                               isConstraintParam() const;
    oaBoolean                               isValue() const;
    oaBoolean                               isViaVariant() const;
    oaBoolean                               isViaVariantHeader() const;

    oaBoolean                               hasProp() const;
    oaBoolean                               inGroup() const;
    oaBoolean                               hasAppDef() const;
    oaBoolean                               hasConstraintGroup() const;
    oaBoolean                               hasAssociate() const;

    oaConstraintGroup                       *getConstraintGroup() const;

    oaObject                                *getDatabase() const;

    oaCollection<oaProp, oaObject>          getProps() const;
    oaCollection<oaAppDef, oaObject>        getAppDefs() const;
    oaCollection<oaGroupMember, oaObject>   getGroupMems() const;
    oaCollection<oaGroupMember, oaObject>   getGroupLeaders() const;
    oaCollection<oaGroup, oaObject>         getGroupsOwnedBy() const;

    enum {dbType = oacBaseDBType};
    enum {domain = oacNoDomain};

protected:
    oaByte                                  id;

                                            ~oaObject();

private:
                                            oaObject();
                                            oaObject(const oaObject &obj);

    oaObject                                &operator=(const oaObject &obj);

    friend class oaObjectPage;
};



// *****************************************************************************
// oaBaseTraits<>
//
// oaBaseTraits<> is a placeholder for traits that are common to most objects.
// Its usage has been deprecated as each oaTraits<> specialization is fully
// specified and independent from each other.
// *****************************************************************************
template<class obj>
class oaBaseTraits {
public:
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
};



// *****************************************************************************
// oaTraits<>
//
// The oaTraits<> template has no default implementation since all instances of
// it are specializations. All specializations of oaTraits<> are independent and
// fully specified.
// *****************************************************************************
template<class obj>
class oaTraits;



// *****************************************************************************
// oaObject is the base object for all OpenAccess objects
// *****************************************************************************
template<>
class oaTraits<oaObject> {
public:
    enum {domain = oacNoDomain};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {dbType = oacBaseDBType};
    enum {abstractTypeEnumVal = oacObjectType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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