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)
	MessageTextFromUnscaledValue (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 10686 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 10692 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 10751 of file pcbnew.py.

GetIuScale()

pcbnew.UNITS_PROVIDER.GetIuScale

(

self

)

GetIuScale(UNITS_PROVIDER self) -> EDA_IU_SCALE

Definition at line 10709 of file pcbnew.py.

GetOriginTransforms()

pcbnew.UNITS_PROVIDER.GetOriginTransforms

(

self

)

GetOriginTransforms(UNITS_PROVIDER self) -> ORIGIN_TRANSFORMS &

Definition at line 10713 of file pcbnew.py.

GetTypeFromUnits()

pcbnew.UNITS_PROVIDER.GetTypeFromUnits ( aUnits )

static

GetTypeFromUnits(EDA_UNITS const aUnits) -> EDA_DATA_TYPE

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

GetUnitsFromType()

pcbnew.UNITS_PROVIDER.GetUnitsFromType	(		self,
			aType )

GetUnitsFromType(UNITS_PROVIDER self, EDA_DATA_TYPE aType) -> EDA_UNITS

Definition at line 10755 of file pcbnew.py.

GetUserUnits()

pcbnew.UNITS_PROVIDER.GetUserUnits

(

self

)

GetUserUnits(UNITS_PROVIDER self) -> EDA_UNITS

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

MessageTextFromUnscaledValue()

pcbnew.UNITS_PROVIDER.MessageTextFromUnscaledValue	(		self,
		*	args )

MessageTextFromUnscaledValue(UNITS_PROVIDER self, double aValue, bool aAddUnitLabel=True, EDA_DATA_TYPE aType=DISTANCE) -> wxString

Definition at line 10735 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 10728 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 10747 of file pcbnew.py.

SetUserUnits()

pcbnew.UNITS_PROVIDER.SetUserUnits	(		self,
			aUnits )

SetUserUnits(UNITS_PROVIDER self, EDA_UNITS aUnits)

Definition at line 10701 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 10717 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 10721 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 10743 of file pcbnew.py.

Member Data Documentation

NullUiString

pcbnew.UNITS_PROVIDER.NullUiString = _pcbnew.UNITS_PROVIDER_NullUiString

static

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

---

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

• pcbnew.py