KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.UNITS_PROVIDER Class Reference
Inheritance diagram for pcbnew.UNITS_PROVIDER:

Public Member Functions

 __init__ (self, aIuScale, aUnits)
 
 GetUserUnits (self)
 
 SetUserUnits (self, aUnits)
 
 GetUnitPair (self, aPrimaryUnit, aSecondaryUnits)
 
 GetIuScale (self)
 
 GetOriginTransforms (self)
 
 StringFromOptionalValue (self, *args)
 
 StringFromValue (self, *args)
 
 MessageTextFromValue (self, *args)
 
 MessageTextFromMinOptMax (self, *args)
 
 ValueFromString (self, *args)
 
 OptionalValueFromString (self, *args)
 
 AngleValueFromString (self, aTextValue)
 
 GetUnitsFromType (self, aType)
 

Static Public Member Functions

 GetTypeFromUnits (aUnits)
 

Static Public Attributes

 NullUiString = _pcbnew.UNITS_PROVIDER_NullUiString
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Detailed Description

Proxy of C++ UNITS_PROVIDER class.

Definition at line 10546 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.UNITS_PROVIDER.__init__ ( self,
aIuScale,
aUnits )
__init__(UNITS_PROVIDER self, EDA_IU_SCALE aIuScale, EDA_UNITS aUnits) -> UNITS_PROVIDER

Definition at line 10552 of file pcbnew.py.

Member Function Documentation

◆ AngleValueFromString()

pcbnew.UNITS_PROVIDER.AngleValueFromString ( self,
aTextValue )
AngleValueFromString(UNITS_PROVIDER self, wxString aTextValue) -> EDA_ANGLE

Definition at line 10607 of file pcbnew.py.

◆ GetIuScale()

pcbnew.UNITS_PROVIDER.GetIuScale ( self)
GetIuScale(UNITS_PROVIDER self) -> EDA_IU_SCALE

Definition at line 10569 of file pcbnew.py.

◆ GetOriginTransforms()

pcbnew.UNITS_PROVIDER.GetOriginTransforms ( self)
GetOriginTransforms(UNITS_PROVIDER self) -> ORIGIN_TRANSFORMS &

Definition at line 10573 of file pcbnew.py.

◆ GetTypeFromUnits()

pcbnew.UNITS_PROVIDER.GetTypeFromUnits ( aUnits)
static
GetTypeFromUnits(EDA_UNITS const aUnits) -> EDA_DATA_TYPE

Definition at line 10616 of file pcbnew.py.

◆ GetUnitPair()

pcbnew.UNITS_PROVIDER.GetUnitPair ( self,
aPrimaryUnit,
aSecondaryUnits )
GetUnitPair(UNITS_PROVIDER self, EDA_UNITS & aPrimaryUnit, EDA_UNITS & aSecondaryUnits)

Definition at line 10565 of file pcbnew.py.

◆ GetUnitsFromType()

pcbnew.UNITS_PROVIDER.GetUnitsFromType ( self,
aType )
GetUnitsFromType(UNITS_PROVIDER self, EDA_DATA_TYPE aType) -> EDA_UNITS

Definition at line 10611 of file pcbnew.py.

◆ GetUserUnits()

pcbnew.UNITS_PROVIDER.GetUserUnits ( self)
GetUserUnits(UNITS_PROVIDER self) -> EDA_UNITS

Definition at line 10557 of file pcbnew.py.

◆ MessageTextFromMinOptMax()

pcbnew.UNITS_PROVIDER.MessageTextFromMinOptMax ( self,
* args )
MessageTextFromMinOptMax(UNITS_PROVIDER self, MINOPTMAX< int > const & aValue, EDA_DATA_TYPE aType=DISTANCE) -> wxString

Definition at line 10595 of file pcbnew.py.

◆ MessageTextFromValue()

pcbnew.UNITS_PROVIDER.MessageTextFromValue ( self,
* args )
    MessageTextFromValue(UNITS_PROVIDER self, double aValue, bool aAddUnitLabel=True, EDA_DATA_TYPE aType=DISTANCE) -> wxString
    MessageTextFromValue(UNITS_PROVIDER self, EDA_ANGLE aValue, bool aAddUnitLabel=True) -> wxString

Definition at line 10588 of file pcbnew.py.

◆ OptionalValueFromString()

pcbnew.UNITS_PROVIDER.OptionalValueFromString ( self,
* args )
OptionalValueFromString(UNITS_PROVIDER self, wxString aTextValue, EDA_DATA_TYPE aType=DISTANCE) -> std::optional< int >

Definition at line 10603 of file pcbnew.py.

◆ SetUserUnits()

pcbnew.UNITS_PROVIDER.SetUserUnits ( self,
aUnits )
SetUserUnits(UNITS_PROVIDER self, EDA_UNITS aUnits)

Definition at line 10561 of file pcbnew.py.

◆ StringFromOptionalValue()

pcbnew.UNITS_PROVIDER.StringFromOptionalValue ( self,
* args )
StringFromOptionalValue(UNITS_PROVIDER self, std::optional< int > aValue, bool aAddUnitLabel=False, EDA_DATA_TYPE aType=DISTANCE) -> wxString

Definition at line 10577 of file pcbnew.py.

◆ StringFromValue()

pcbnew.UNITS_PROVIDER.StringFromValue ( self,
* args )
    StringFromValue(UNITS_PROVIDER self, double aValue, bool aAddUnitLabel=False, EDA_DATA_TYPE aType=DISTANCE) -> wxString
    StringFromValue(UNITS_PROVIDER self, EDA_ANGLE aValue, bool aAddUnitLabel=False) -> wxString

Definition at line 10581 of file pcbnew.py.

◆ ValueFromString()

pcbnew.UNITS_PROVIDER.ValueFromString ( self,
* args )
ValueFromString(UNITS_PROVIDER self, wxString aTextValue, EDA_DATA_TYPE aType=DISTANCE) -> int

Definition at line 10599 of file pcbnew.py.

Member Data Documentation

◆ NullUiString

pcbnew.UNITS_PROVIDER.NullUiString = _pcbnew.UNITS_PROVIDER_NullUiString
static

Definition at line 10619 of file pcbnew.py.

Property Documentation

◆ thisown

pcbnew.UNITS_PROVIDER.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

Definition at line 10549 of file pcbnew.py.


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