// OpenSTA, Static Timing Analyzer
// Copyright (c) 2023, Parallax Software, Inc.
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

#pragma once

#include "ParallelDelayCalc.hh"

namespace sta {

// Liberty table model lumped capacitance arc delay calculator.
// Wire delays are zero.
class LumpedCapDelayCalc : public ParallelDelayCalc
{
public:
  LumpedCapDelayCalc(StaState *sta);
  ArcDelayCalc *copy() override;
  Parasitic *findParasitic(const Pin *drvr_pin,
                           const RiseFall *rf,
                           const DcalcAnalysisPt *dcalc_ap) override;
  ReducedParasiticType reducedParasiticType() const override;
  void gateDelay(const TimingArc *arc,
                 const Slew &in_slew,
                 float load_cap,
                 const Parasitic *drvr_parasitic,
                 float related_out_cap,
                 const Pvt *pvt,
                 const DcalcAnalysisPt *dcalc_ap,
                 // Return values.
                 ArcDelay &gate_delay,
                 Slew &drvr_slew) override;
  float ceff(const TimingArc *arc,
             const Slew &in_slew,
             float load_cap,
             const Parasitic *drvr_parasitic,
             float related_out_cap,
             const Pvt *pvt,
             const DcalcAnalysisPt *dcalc_ap) override;
  void loadDelay(const Pin *load_pin,
                 // Return values.
                 ArcDelay &wire_delay,
                 Slew &load_slew) override;
  void checkDelay(const TimingArc *arc,
                  const Slew &from_slew,
                  const Slew &to_slew,
                  float related_out_cap,
                  const Pvt *pvt,
                  const DcalcAnalysisPt *dcalc_ap,
                  // Return values.
                  ArcDelay &margin) override;
  string reportGateDelay(const TimingArc *arc,
                         const Slew &in_slew,
                         float load_cap,
                         const Parasitic *drvr_parasitic,
                         float related_out_cap,
                         const Pvt *pvt,
                         const DcalcAnalysisPt *dcalc_ap,
                         int digits) override;
  string reportCheckDelay(const TimingArc *arc,
                          const Slew &from_slew,
                          const char *from_slew_annotation,
                          const Slew &to_slew,
                          float related_out_cap,
                          const Pvt *pvt,
                          const DcalcAnalysisPt *dcalc_ap,
                          int digits) override;

protected:
};

ArcDelayCalc *
makeLumpedCapDelayCalc(StaState *sta);

} // namespace