oaRefHeader.h

Go to the documentation of this file.
00001 // *****************************************************************************
00002 // *****************************************************************************
00003 // oaRefHeader.h
00004 //
00005 // This file contains the definition for the oaRefHeader class. This is an
00006 // abstract base class that encapsulates information about a particular design
00007 // master referenced in another design and all of the instances or vias that use
00008 // it. The oaRefHeader class is the base of oaInstHeader and oaViaHeader.
00009 //
00010 // *****************************************************************************
00011 // Except as specified in the OpenAccess terms of use of Cadence or Silicon
00012 // Integration Initiative, this material may not be copied, modified,
00013 // re-published, uploaded, executed, or distributed in any way, in any medium,
00014 // in whole or in part, without prior written permission from Cadence.
00015 //
00016 //                Copyright 2002-2005 Cadence Design Systems, Inc.
00017 //                           All Rights Reserved.
00018 //
00019 //  $Author: icftcm $
00020 //  $Revision: #1 $
00021 //  $Date: 2010/08/09 $
00022 //  $State: Exp $
00023 // *****************************************************************************
00024 // *****************************************************************************
00025 
00026 
00027 
00028 #if !defined(oaRefHeader_P)
00029 #define oaRefHeader_P
00030 
00031 
00032 
00033 // *****************************************************************************
00034 // Nested includes
00035 // *****************************************************************************
00036 #include "oaBox.h"
00037 #include "oaBlockObject.h"
00038 
00039 
00040 
00041 // *****************************************************************************
00042 // Declare and define types in the OpenAccess namespace.
00043 // *****************************************************************************
00044 BEGIN_OA_NAMESPACE
00045 
00046 
00047 
00048 // *****************************************************************************
00049 // oaRefHeader
00050 // *****************************************************************************
00051 class OA_DESIGN_DLL_API oaRefHeader : public oaBlockObject {
00052 public:
00053     oaDesign                *getMaster() const;
00054     void                    getMasterBBox(oaBox &bBox) const;
00055     void                    getBBox(oaBox &bBox) const;
00056     oaRefHeader             *getSuperHeader() const;
00057 
00058     oaBoolean               isBound() const;
00059     oaBoolean               isSuperHeader() const;
00060     oaBoolean               isSubHeader() const;
00061 };
00062 
00063 
00064 
00065 // *****************************************************************************
00066 // Design Traits.
00067 // *****************************************************************************
00068 template<>
00069 class oaTraits<oaRefHeader> {
00070 public:
00071     typedef oaBlockObject   parentType;
00072     enum {domain = oacBlockDomain};
00073     enum {dbType = oacDesignDBType};
00074     enum {isMultiDomain = false};
00075     enum {isConcrete = false};
00076     enum {abstractTypeEnumVal = oacRefHeaderType};
00077 };
00078 
00079 
00080 
00081 END_OA_NAMESPACE
00082 
00083 #endif

Return to top of page