# Hurricane Documentation

# Hurricane VLSI Database

RegularLayer.h
1
2 // -*- C++ -*-
3 //
4 // Copyright (c) BULL S.A. 2000-2018, All Rights Reserved
5 //
6 // This file is part of Hurricane.
7 //
8 // Hurricane is free software: you can redistribute it and/or modify
9 // it under the terms of the GNU Lesser General Public License as
10 // published by the Free Software Foundation, either version 3 of the
11 // License, or (at your option) any later version.
12 //
13 // Hurricane is distributed in the hope that it will be useful, but
14 // WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN-
15 // TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Lesser GNU
16 // General Public License for more details.
17 //
18 // You should have received a copy of the Lesser GNU General Public
19 // License along with Hurricane. If not, see
20 // <http://www.gnu.org/licenses/>.
21 //
22 // +-----------------------------------------------------------------+
23 // | H U R R I C A N E |
24 // | V L S I B a c k e n d D a t a - B a s e |
25 // | |
26 // | Author : Jean-Paul Chaput |
27 // | E-mail : Jean-Paul.Chaput@lip6.fr |
28 // | =============================================================== |
29 // | C++ Header : "./hurricane/RegularLayer.h" |
30 // +-----------------------------------------------------------------+
31
32
33 #ifndef HURRICANE_REGULAR_LAYER_H
34 #define HURRICANE_REGULAR_LAYER_H
35
36 #include "hurricane/Layer.h"
37 #include "hurricane/RegularLayers.h"
38
39
40 namespace Hurricane {
41
42 // -------------------------------------------------------------------
43 // Class : "Hurricane::RegularLayer".
44
45 class RegularLayer : public Layer {
46 public:
47 typedef Layer Super;
48
49 public:
50 // Constructor.
51 static RegularLayer* create ( Technology* technology
52 , const Name& name
53 , BasicLayer* layer
54 );
55 // Accessors.
56 virtual BasicLayers getBasicLayers () const;
57 inline BasicLayer* getBasicLayer () const;
58 virtual const Layer* getBlockageLayer () const;
59 virtual const Layer* getTop () const;
60 virtual const Layer* getBottom () const;
61 virtual const Layer* getOpposite ( const Layer* ) const;
62 virtual DbU::Unit getEnclosure ( uint32_t flags=0 ) const;
63 virtual DbU::Unit getExtentionCap () const;
64 virtual DbU::Unit getExtentionWidth () const;
65 virtual DbU::Unit getEnclosure ( const BasicLayer* layer, uint32_t flags=0 ) const;
66 virtual DbU::Unit getExtentionCap ( const BasicLayer* layer ) const;
67 virtual DbU::Unit getExtentionWidth ( const BasicLayer* layer ) const;
68 // Updators
69 void setBasicLayer ( BasicLayer* layer );
70 virtual void setEnclosure ( const BasicLayer* layer, DbU::Unit enclosure, uint32_t flags=0 );
71 virtual void setExtentionCap ( const BasicLayer* layer, DbU::Unit cap );
72 virtual void setExtentionWidth ( const BasicLayer* layer, DbU::Unit width );
73 // Hurricane Managment.
74 virtual void _toJson ( JsonWriter* ) const;
75 virtual void _onDbuChange ( float scale );
76 virtual string _getTypeName () const;
77 virtual string _getString () const;
78 virtual Record* _getRecord () const;
79
80 private:
81 // Internal: Attributes
82 BasicLayer* _basicLayer;
83 DbU::Unit _enclosure;
84 DbU::Unit _extentionCap;
85 DbU::Unit _extentionWidth;
86
87 protected:
88 // Internal: Constructors & Destructors.
89 RegularLayer ( Technology* technology
90 , const Name& name
91 );
92 };
93
94
95 // Inline Functions.
96 inline BasicLayer* RegularLayer::getBasicLayer () const { return _basicLayer; }
97
98
99 // -------------------------------------------------------------------
100 // Class : "Hurricane::JsonRegularLayer".
101
102 class JsonRegularLayer : public JsonLayer {
103 public:
104 static void initialize ();
105 JsonRegularLayer ( unsigned long flags );
106 ~JsonRegularLayer ();
107 virtual string getTypeName () const;
108 virtual JsonRegularLayer* clone ( unsigned long ) const;
109 virtual void toData ( JsonStack& );
110 };
111
112
113 } // Hurricane namespace.
114
115 INSPECTOR_P_SUPPORT(Hurricane::RegularLayer);
116
117 #endif // HURRICANE_REGULAR_LAYER_H
Hurricane::RegularLayer
RegularLayer description (API)
Definition: RegularLayer.h:45
Hurricane::BasicLayer
BasicLayer description (API)
Definition: BasicLayer.h:44
Hurricane::Name
Name description (API)
Definition: Name.h:35
Hurricane::DbU::Unit
std::int64_t Unit
Definition: DbU.h:70
Hurricane::DBo
DataBase object root class (API).
Definition: DBo.h:47
Hurricane::RegularLayer::getBasicLayer
BasicLayer * getBasicLayer() const
Definition: RegularLayer.h:96
Hurricane::RegularLayer::create
static RegularLayer * create(Technology *technology, const Name &name, BasicLayer *layer)
Hurricane::JsonStack
JSON Parser Stack.
Definition: JsonObject.h:249
Hurricane::Layer
Layer description (API)
Definition: Layer.h:52
Hurricane
The namespace dedicated to Hurricane.
Definition: Generalities.dox:5
Hurricane::Technology
Technological rules description (API).
Definition: Technology.h:62