oaBlockObject.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaBlockObject.h
//
// This file contains the definition for the oaBlockObject class. This is an
// abstract class that is the base for all OpenAccess database objects in the
// block hierarchy.
//
// *****************************************************************************
// 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(oaBlockObject_P)
#define oaBlockObject_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaCollection.h"
#include "oaDesignObject.h"



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



// *****************************************************************************
// oaBlockDomainVisibilityEnum
// *****************************************************************************
#define oavNumBlockDomainVisibilityTypes    2

enum oaBlockDomainVisibilityEnum {
    oacInheritFromTopBlock      = 0,
    oacExcludeFromModuleDomain  = 1
};



// *****************************************************************************
// oaBlockDomainVisibility
// *****************************************************************************
class OA_DESIGN_DLL_API oaBlockDomainVisibility {
public:
                                oaBlockDomainVisibility(oaBlockDomainVisibilityEnum valueIn);
                                oaBlockDomainVisibility(const oaString &name);
                                ~oaBlockDomainVisibility();

    const oaString              &getName() const;

                                operator                    oaBlockDomainVisibilityEnum() const;

private:
    oaBlockDomainVisibilityEnum value;

    static const oaString       names[];
};



// *****************************************************************************
// oaBlockObject
// *****************************************************************************
class OA_DESIGN_DLL_API oaBlockObject : public oaDesignObject {
public:
    oaBoolean                               isNet() const;
    oaBoolean                               isBitNet() const;
    oaBoolean                               isTerm() const;
    oaBoolean                               isBitTerm() const;
    oaBoolean                               isInst() const;
    oaBoolean                               isBitInst() const;
    oaBoolean                               isAssignment() const;
    oaBoolean                               isConnectDef() const;
    oaBoolean                               isFig() const;
    oaBoolean                               isConnFig() const;
    oaBoolean                               isPinFig() const;
    oaBoolean                               isShape() const;
    oaBoolean                               isOccShape() const;
    oaBoolean                               isBlockage() const;
    oaBoolean                               isTextDisplay() const;
    oaBoolean                               isOccTextDisplay() const;
    oaBoolean                               isRef() const;
    oaBoolean                               isBoundary() const;
    oaBoolean                               isVia() const;
    oaBoolean                               isViaHeader() const;

    oaBlock                                 *getBlock();

    oaCollection<oaMarker, oaBlockObject>   getMarkersOwnedBy() const;

    enum {domain = oacBlockDomain};
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaBlockObject> {
public:
    typedef oaDesignObject  parentType;
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = false};
    enum {domain = oacBlockDomain};
    enum {abstractTypeEnumVal = oacBlockObjectType};
};



END_OA_NAMESPACE

#endif

Return to top of page

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