pcbnew.UNITS_PROVIDER Class Reference

Inheritance diagram for pcbnew.UNITS_PROVIDER:

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

Static Public Member Functions
def	GetTypeFromUnits (aUnits)

Static Public Attributes
_pcbnew	NullUiString = _pcbnew.UNITS_PROVIDER_NullUiString

Properties
property	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 10501 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

def pcbnew.UNITS_PROVIDER.__init__	(		self,
			aIuScale,
			aUnits
	)

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

Definition at line 10507 of file pcbnew.py.

Member Function Documentation

AngleValueFromString()

def pcbnew.UNITS_PROVIDER.AngleValueFromString	(		self,
			aTextValue
	)

AngleValueFromString(UNITS_PROVIDER self, wxString aTextValue) -> EDA_ANGLE

Definition at line 10562 of file pcbnew.py.

GetIuScale()

def pcbnew.UNITS_PROVIDER.GetIuScale

(

self

)

GetIuScale(UNITS_PROVIDER self) -> EDA_IU_SCALE

Definition at line 10524 of file pcbnew.py.

GetOriginTransforms()

def pcbnew.UNITS_PROVIDER.GetOriginTransforms

(

self

)

GetOriginTransforms(UNITS_PROVIDER self) -> ORIGIN_TRANSFORMS &

Definition at line 10528 of file pcbnew.py.

GetTypeFromUnits()

def pcbnew.UNITS_PROVIDER.GetTypeFromUnits (   aUnits )

static

GetTypeFromUnits(EDA_UNITS const aUnits) -> EDA_DATA_TYPE

Definition at line 10571 of file pcbnew.py.

GetUnitPair()

def pcbnew.UNITS_PROVIDER.GetUnitPair	(		self,
			aPrimaryUnit,
			aSecondaryUnits
	)

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

Definition at line 10520 of file pcbnew.py.

GetUnitsFromType()

def pcbnew.UNITS_PROVIDER.GetUnitsFromType	(		self,
			aType
	)

GetUnitsFromType(UNITS_PROVIDER self, EDA_DATA_TYPE aType) -> EDA_UNITS

Definition at line 10566 of file pcbnew.py.

GetUserUnits()

def pcbnew.UNITS_PROVIDER.GetUserUnits

(

self

)

GetUserUnits(UNITS_PROVIDER self) -> EDA_UNITS

Definition at line 10512 of file pcbnew.py.

MessageTextFromMinOptMax()

def pcbnew.UNITS_PROVIDER.MessageTextFromMinOptMax	(		self,
		*	args
	)

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

Definition at line 10550 of file pcbnew.py.

MessageTextFromValue()

def 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 10543 of file pcbnew.py.

Here is the caller graph for this function:

OptionalValueFromString()

def pcbnew.UNITS_PROVIDER.OptionalValueFromString	(		self,
		*	args
	)

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

Definition at line 10558 of file pcbnew.py.

SetUserUnits()

def pcbnew.UNITS_PROVIDER.SetUserUnits	(		self,
			aUnits
	)

SetUserUnits(UNITS_PROVIDER self, EDA_UNITS aUnits)

Definition at line 10516 of file pcbnew.py.

StringFromOptionalValue()

def 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 10532 of file pcbnew.py.

StringFromValue()

def 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 10536 of file pcbnew.py.

Here is the caller graph for this function:

ValueFromString()

def pcbnew.UNITS_PROVIDER.ValueFromString	(		self,
		*	args
	)

ValueFromString(UNITS_PROVIDER self, wxString aTextValue, EDA_DATA_TYPE aType=DISTANCE) -> int

Definition at line 10554 of file pcbnew.py.

Member Data Documentation

NullUiString

_pcbnew pcbnew.UNITS_PROVIDER.NullUiString = _pcbnew.UNITS_PROVIDER_NullUiString

static

Definition at line 10574 of file pcbnew.py.

Property Documentation

thisown

property 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 10504 of file pcbnew.py.

---

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

• pcbnew.py