ZLayout EDA Library v1.0.0
Advanced Electronic Design Automation Layout Library with Bilingual Documentation
Loading...
Searching...
No Matches
zlayout::components::Inductor Class Reference

Inductor component. More...

#include <passive_components.hpp>

Inheritance diagram for zlayout::components::Inductor:
Collaboration diagram for zlayout::components::Inductor:

Public Types

enum class  CoreType {
  Air , Ferrite , Iron , Laminated ,
  Powdered
}

Public Member Functions

 Inductor (const std::string &name, double inductance, CoreType core)
double getInductance () const
void setInductance (double inductance)
double getTolerance () const
void setTolerance (double tolerance)
double getCurrentRating () const
void setCurrentRating (double current)
CoreType getCoreType () const
void setCoreType (CoreType type)
double getDCR () const
void setDCR (double dcr)
double getSRF () const
void setSRF (double srf)
double getParasiticCapacitance () const
void setParasiticCapacitance (double cap)
double getSaturationCurrent () const
void setSaturationCurrent (double current)
double getQualityFactor () const
void setQualityFactor (double q)
void simulate (double time_step) override
std::string getDescription () const override
Public Member Functions inherited from zlayout::components::Component
 Component (const std::string &name, ComponentCategory category)
virtual ~Component ()=default
const std::string & getName () const
const std::string & getType () const
ComponentCategory getCategory () const
void setName (const std::string &name)
void setType (const std::string &type)
void addChild (std::shared_ptr< Component > child)
void removeChild (const std::string &name)
std::shared_ptr< Component > getChild (const std::string &name) const
const std::vector< std::shared_ptr< Component > > & getChildren () const
std::shared_ptr< Component > getParent () const
void setParent (std::shared_ptr< Component > parent)
const geometry::Rectangle & getBoundingBox () const
void setBoundingBox (const geometry::Rectangle &bbox)
geometry::Point getPosition () const
void setPosition (const geometry::Point &pos)
double getRotation () const
void setRotation (double angle)
void addPin (std::shared_ptr< Pin > pin)
void removePin (const std::string &name)
std::shared_ptr< Pin > getPin (const std::string &name) const
const std::vector< std::shared_ptr< Pin > > & getPins () const
void setProperty (const std::string &key, const std::string &value)
std::string getProperty (const std::string &key) const
const std::map< std::string, std::string > & getProperties () const
void setTimingInfo (const TimingInfo &timing)
const TimingInfo & getTimingInfo () const
void setPowerInfo (const PowerInfo &power)
const PowerInfo & getPowerInfo () const
void setElectricalInfo (const ElectricalInfo &electrical)
const ElectricalInfo & getElectricalInfo () const
void setTechNode (TechNode node)
TechNode getTechNode () const
virtual void reset ()
virtual geometry::Rectangle calculateHierarchicalBoundingBox () const
virtual double calculateTotalArea () const
virtual size_t getTotalGateCount () const
virtual std::vector< std::shared_ptr< Component > > flattenHierarchy () const
virtual std::string serialize () const
virtual void deserialize (const std::string &data)

Static Public Member Functions

static std::vector< double > getStandardValues ()
static double getNearestStandardValue (double value)

Additional Inherited Members

Protected Attributes inherited from zlayout::components::Component
std::string name_
std::string type_
ComponentCategory category_
std::vector< std::shared_ptr< Component > > children_
std::weak_ptr< Component > parent_
geometry::Rectangle bounding_box_
geometry::Point position_
double rotation_ = 0.0
std::vector< std::shared_ptr< Pin > > pins_
std::unordered_map< std::string, std::shared_ptr< Pin > > pin_map_
std::map< std::string, std::string > properties_
TimingInfo timing_
PowerInfo power_
ElectricalInfo electrical_
TechNode tech_node_ = TechNode::um_7

Detailed Description

Inductor component.

Definition at line 129 of file passive_components.hpp.

Member Enumeration Documentation

◆ CoreType

enum class zlayout::components::Inductor::CoreType
strong
Enumerator
Air 
Ferrite 
Iron 
Laminated 
Powdered 

Definition at line 131 of file passive_components.hpp.

Constructor & Destructor Documentation

◆ Inductor()

zlayout::components::Inductor::Inductor ( const std::string & name,
double inductance,
CoreType core )

Member Function Documentation

◆ getCoreType()

CoreType zlayout::components::Inductor::getCoreType ( ) const
inline

Definition at line 151 of file passive_components.hpp.

◆ getCurrentRating()

double zlayout::components::Inductor::getCurrentRating ( ) const
inline

Definition at line 148 of file passive_components.hpp.

◆ getDCR()

double zlayout::components::Inductor::getDCR ( ) const
inline

Definition at line 155 of file passive_components.hpp.

◆ getDescription()

std::string zlayout::components::Inductor::getDescription ( ) const
overridevirtual

Reimplemented from zlayout::components::Component.

◆ getInductance()

double zlayout::components::Inductor::getInductance ( ) const
inline

Definition at line 142 of file passive_components.hpp.

◆ getNearestStandardValue()

double zlayout::components::Inductor::getNearestStandardValue ( double value)
static

◆ getParasiticCapacitance()

double zlayout::components::Inductor::getParasiticCapacitance ( ) const
inline

Definition at line 161 of file passive_components.hpp.

◆ getQualityFactor()

double zlayout::components::Inductor::getQualityFactor ( ) const
inline

Definition at line 168 of file passive_components.hpp.

◆ getSaturationCurrent()

double zlayout::components::Inductor::getSaturationCurrent ( ) const
inline

Definition at line 165 of file passive_components.hpp.

◆ getSRF()

double zlayout::components::Inductor::getSRF ( ) const
inline

Definition at line 158 of file passive_components.hpp.

◆ getStandardValues()

std::vector< double > zlayout::components::Inductor::getStandardValues ( )
static

◆ getTolerance()

double zlayout::components::Inductor::getTolerance ( ) const
inline

Definition at line 145 of file passive_components.hpp.

◆ setCoreType()

void zlayout::components::Inductor::setCoreType ( CoreType type)
inline

Definition at line 152 of file passive_components.hpp.

◆ setCurrentRating()

void zlayout::components::Inductor::setCurrentRating ( double current)
inline

Definition at line 149 of file passive_components.hpp.

◆ setDCR()

void zlayout::components::Inductor::setDCR ( double dcr)
inline

Definition at line 156 of file passive_components.hpp.

◆ setInductance()

void zlayout::components::Inductor::setInductance ( double inductance)

◆ setParasiticCapacitance()

void zlayout::components::Inductor::setParasiticCapacitance ( double cap)
inline

Definition at line 162 of file passive_components.hpp.

◆ setQualityFactor()

void zlayout::components::Inductor::setQualityFactor ( double q)
inline

Definition at line 169 of file passive_components.hpp.

◆ setSaturationCurrent()

void zlayout::components::Inductor::setSaturationCurrent ( double current)
inline

Definition at line 166 of file passive_components.hpp.

◆ setSRF()

void zlayout::components::Inductor::setSRF ( double srf)
inline

Definition at line 159 of file passive_components.hpp.

◆ setTolerance()

void zlayout::components::Inductor::setTolerance ( double tolerance)
inline

Definition at line 146 of file passive_components.hpp.

◆ simulate()

void zlayout::components::Inductor::simulate ( double time_step)
overridevirtual

Reimplemented from zlayout::components::Component.

The documentation for this class was generated from the following file: