1/* Copyright (c) 2012 Massachusetts Institute of Technology
2 *
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to deal
5 * in the Software without restriction, including without limitation the rights
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 * copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions:
9 *
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
12 *
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 * THE SOFTWARE.
20 */
21
22#ifndef __DSENT_MODEL_ELECTRICAL_DRIVER_H__
23#define __DSENT_MODEL_ELECTRICAL_DRIVER_H__
24
25#include "util/CommonType.h"
26#include "model/timing_graph/ElectricalTimingNode.h"
27
28namespace DSENT
29{
30    class ElectricalModel;
31
32    class ElectricalDriver : public ElectricalTimingNode
33    {
34        public:
35            ElectricalDriver(const String& instance_name_, ElectricalModel* model_, bool sizable_);
36            virtual ~ElectricalDriver();
37
38        public:
39            // Set the output resistance of this driver
40            void setOutputRes(double output_res_);
41            // Get the output resistance of this driver
42            double getOutputRes() const;
43            // Calculate delay due to total load capacitance
44            double calculateDelay() const;
45            // Calculate transition
46            double calculateTransition() const;
47            // get maximum of upstream drive resistance
48            double getMaxUpstreamRes() const;
49
50            // Get whether the driver is sizable
51            bool isSizable() const;
52            // Return true if the instance has minimum driving strength
53            bool hasMinDrivingStrength() const;
54            // Return true if the instance has maximum driving strength
55            bool hasMaxDrivingStrength() const;
56            // Increase driving strength index by 1
57            void increaseDrivingStrength();
58            // Decrease driving strength index by 1
59            void decreaseDrivingStrength();
60
61            bool isDriver() const;
62
63        private:
64            // Disable copy constructor
65            ElectricalDriver(const ElectricalDriver& port_);
66
67        private:
68            // Name of this instance
69            String m_instance_name_;
70            // Output resistance
71            double m_output_res_;
72            // Sizable flag
73            bool m_sizable_;
74    };
75} // namespace DSENT
76
77#endif // __DSENT_MODEL_ELECTRICAL_DRIVER_H__
78
79