MATCH_PROPERTIES_CATALOG Namespace Reference

Functions
wxString	Family (const EDA_ITEM &aItem)
wxString	DisplayLabel (const wxString &aKey)
wxString	FamilyLabel (const wxString &aFamily)
	The translated name of a family, for the heading of its group.
wxString	PropertyLabel (const wxString &aKey)
	The translated property name alone, without the family it belongs to.
std::set< wxString >	FamiliesFor (const wxString &aKey)
	The families a key reaches. One for a family key, several for a common one.
bool	PropertyIsRegistered (const wxString &aFamily, const wxString &aName)
	Whether aFamily registers a property of that name. Used to prune the common table.
bool	Compatible (const EDA_ITEM &aSource, const EDA_ITEM &aTarget)
std::vector< EDA_ITEM * >	CompatibleTargets (const EDA_ITEM &aSource, const std::vector< EDA_ITEM * > &aCandidates)
bool	AnyEnabledFor (const EDA_ITEM &aItem, const std::set< wxString > &aEnabledKeys)
	True if any enabled key names a property of this item's family.
const std::set< wxString > &	AllSafeKeys ()
	Every property Match Properties may copy, keyed as "family/Property Name".
const std::set< wxString > &	DefaultKeys ()
	The subset enabled until the user says otherwise.
MATCH_PROPERTIES_RESULT	Copy (const EDA_ITEM &aSource, EDA_ITEM &aTarget, const std::set< wxString > &aEnabledKeys)

Function Documentation

AllSafeKeys()

const std::set< wxString > & MATCH_PROPERTIES_CATALOG::AllSafeKeys

(

)

Every property Match Properties may copy, keyed as "family/Property Name".

Derived from PROPERTY_BASE::IsCopyable(), so a property becomes copyable by being flagged where it is registered rather than by being named here.

Definition at line 532 of file match_properties.cpp.

References COMMON_FAMILY, commonProperties(), families(), PROPERTY_MANAGER::GetProperties(), PROPERTY_MANAGER::Instance(), PROPERTY_MANAGER::IsAvailableFor(), name, result, ZONE::SetIsRuleArea(), and TYPE_HASH.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), commonReach(), and MATCH_PROPERTIES_DIALOG::MATCH_PROPERTIES_DIALOG().

AnyEnabledFor()

bool MATCH_PROPERTIES_CATALOG::AnyEnabledFor	(	const EDA_ITEM &	aItem,
		const std::set< wxString > &	aEnabledKeys )

True if any enabled key names a property of this item's family.

Definition at line 343 of file match_properties.cpp.

References COMMON_FAMILY, commonReach(), families(), Family(), and familyPrefix().

Referenced by BOOST_AUTO_TEST_CASE(), and MATCH_PROPERTIES_TOOL::Match().

Compatible()

bool MATCH_PROPERTIES_CATALOG::Compatible	(	const EDA_ITEM &	aSource,
		const EDA_ITEM &	aTarget )

Definition at line 306 of file match_properties.cpp.

References commonReach(), families(), and Family().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CompatibleTargets(), Copy(), and MATCH_PROPERTIES_TOOL::runInteractive().

CompatibleTargets()

std::vector< EDA_ITEM * > MATCH_PROPERTIES_CATALOG::CompatibleTargets	(	const EDA_ITEM &	aSource,
		const std::vector< EDA_ITEM * > &	aCandidates )

Definition at line 328 of file match_properties.cpp.

References Compatible().

Referenced by BOOST_AUTO_TEST_CASE(), and MATCH_PROPERTIES_TOOL::runInteractive().

Copy()

MATCH_PROPERTIES_RESULT MATCH_PROPERTIES_CATALOG::Copy	(	const EDA_ITEM &	aSource,
		EDA_ITEM &	aTarget,
		const std::set< wxString > &	aEnabledKeys )

Definition at line 434 of file match_properties.cpp.

References _, EDA_ITEM::Clone(), Compatible(), INSPECTABLE::Get(), PROPERTY_MANAGER::Instance(), PROPERTY_MANAGER::IsAvailableFor(), PROPERTY_MANAGER::IsWriteableFor(), KiWxAnyEquals(), PROPERTY_BASE::Name(), plan(), result, INSPECTABLE::Set(), and TYPE_HASH.

Referenced by MATCH_PROPERTIES_TOOL::applyToTargets(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

DefaultKeys()

const std::set< wxString > & MATCH_PROPERTIES_CATALOG::DefaultKeys

(

)

The subset enabled until the user says otherwise.

Definition at line 624 of file match_properties.cpp.

Referenced by PCB_VIEWERS_SETTINGS_BASE::addMatchPropertiesParam(), BOOST_AUTO_TEST_CASE(), and MATCH_PROPERTIES_TOOL::enabledKeys().

DisplayLabel()

wxString MATCH_PROPERTIES_CATALOG::DisplayLabel

(

const wxString &

aKey

)

Definition at line 300 of file match_properties.cpp.

References FamilyLabel(), and PropertyLabel().

Referenced by BOOST_AUTO_TEST_CASE().

FamiliesFor()

std::set< wxString > MATCH_PROPERTIES_CATALOG::FamiliesFor

(

const wxString &

aKey

)

The families a key reaches. One for a family key, several for a common one.

Definition at line 250 of file match_properties.cpp.

References COMMON_FAMILY, commonReach(), end, families(), and name.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), MATCH_PROPERTIES_DIALOG::MATCH_PROPERTIES_DIALOG(), and MATCH_PROPERTIES_TOOL::runInteractive().

Family()

wxString MATCH_PROPERTIES_CATALOG::Family

(

const EDA_ITEM &

aItem

)

Definition at line 210 of file match_properties.cpp.

References PCB_ARC_T, PCB_BARCODE_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_PAD_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TABLECELL_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, and EDA_ITEM::Type().

Referenced by AnyEnabledFor(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Compatible(), familyPrefix(), hasMatchableSource(), MATCH_PROPERTIES_TOOL::Match(), plan(), MATCH_PROPERTIES_TOOL::runInteractive(), and MATCH_PROPERTIES_TOOL::showSettingsDialog().

FamilyLabel()

wxString MATCH_PROPERTIES_CATALOG::FamilyLabel

(

const wxString &

aFamily

)

The translated name of a family, for the heading of its group.

Definition at line 239 of file match_properties.cpp.

References _, COMMON_FAMILY, and families().

Referenced by BOOST_AUTO_TEST_CASE(), DisplayLabel(), and MATCH_PROPERTIES_DIALOG::MATCH_PROPERTIES_DIALOG().

PropertyIsRegistered()

bool MATCH_PROPERTIES_CATALOG::PropertyIsRegistered	(	const wxString &	aFamily,
		const wxString &	aName )

Whether aFamily registers a property of that name. Used to prune the common table.

Definition at line 271 of file match_properties.cpp.

References end, families(), PROPERTY_MANAGER::GetProperty(), and PROPERTY_MANAGER::Instance().

Referenced by commonReach().

PropertyLabel()

wxString MATCH_PROPERTIES_CATALOG::PropertyLabel

(

const wxString &

aKey

)

The translated property name alone, without the family it belongs to.

Definition at line 282 of file match_properties.cpp.

References COMMON_FAMILY, commonProperties(), end, and name.

Referenced by BOOST_AUTO_TEST_CASE(), DisplayLabel(), and MATCH_PROPERTIES_DIALOG::MATCH_PROPERTIES_DIALOG().