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, aValue)

def	ValueFromString (self, *args)

def	OptionalValueFromString (self, *args)

def	AngleValueFromString (self, aTextValue)

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 10074 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 10080 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 10135 of file pcbnew.py.

◆ GetIuScale()

def pcbnew.UNITS_PROVIDER.GetIuScale ( self )

GetIuScale(UNITS_PROVIDER self) -> EDA_IU_SCALE

Definition at line 10097 of file pcbnew.py.

◆ GetOriginTransforms()

def pcbnew.UNITS_PROVIDER.GetOriginTransforms ( self )

GetOriginTransforms(UNITS_PROVIDER self) -> ORIGIN_TRANSFORMS &

Definition at line 10101 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 10093 of file pcbnew.py.

◆ GetUserUnits()

def pcbnew.UNITS_PROVIDER.GetUserUnits ( self )

GetUserUnits(UNITS_PROVIDER self) -> EDA_UNITS

Definition at line 10085 of file pcbnew.py.

◆ MessageTextFromMinOptMax()

def pcbnew.UNITS_PROVIDER.MessageTextFromMinOptMax	(	self,
		aValue
	)

MessageTextFromMinOptMax(UNITS_PROVIDER self, MINOPTMAX< int > const & aValue) -> wxString

Definition at line 10123 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 10116 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 10131 of file pcbnew.py.

◆ SetUserUnits()

def pcbnew.UNITS_PROVIDER.SetUserUnits	(	self,
		aUnits
	)

SetUserUnits(UNITS_PROVIDER self, EDA_UNITS aUnits)

Definition at line 10089 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 10105 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 10109 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 10127 of file pcbnew.py.

Member Data Documentation

◆ NullUiString

_pcbnew pcbnew.UNITS_PROVIDER.NullUiString = _pcbnew.UNITS_PROVIDER_NullUiString

static

Definition at line 10138 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")