Namespaces
namespace	types

Functions
void	PackLayerSet (google::protobuf::RepeatedField< int > &aOutput, const LSET &aLayerSet)

LSET	UnpackLayerSet (const google::protobuf::RepeatedField< int > &aProtoLayerSet)

void	PackBoardStackup (const BOARD &aBoard, BoardStackup &aOut)

void	PackTeardropSettings (types::PadTeardropSettings &aOutput, const TEARDROP_PARAMETERS &aParams)

void	UnpackTeardropSettings (TEARDROP_PARAMETERS &aOutput, const types::PadTeardropSettings &aProto)

void	PackZoneLayerOverrides (google::protobuf::RepeatedPtrField< types::ZoneLayerOverrideEntry > *aOutput, const std::map< PCB_LAYER_ID, ZONE_LAYER_OVERRIDE > &aInput)

void	UnpackZoneLayerOverrides (std::map< PCB_LAYER_ID, ZONE_LAYER_OVERRIDE > &aOutput, const google::protobuf::RepeatedPtrField< types::ZoneLayerOverrideEntry > &aInput)

void	PackEmbeddedFiles (common::types::EmbeddedFiles &aOutput, const EMBEDDED_FILES &aFiles)

bool	UnpackEmbeddedFiles (EMBEDDED_FILES &aOutput, const common::types::EmbeddedFiles &aProto)

std::vector< BOARD_ITEM * >	FindItemsFromSyncSelection (const BOARD *aBoard, const google::protobuf::RepeatedPtrField< kiapi::common::commands::SelectionSpec > &aItems)
	Resolve a cross-probe selection request against a board.

void	PackEmbeddedFiles (kiapi::common::types::EmbeddedFiles &aOutput, const EMBEDDED_FILES &aFiles)

bool	UnpackEmbeddedFiles (EMBEDDED_FILES &aOutput, const kiapi::common::types::EmbeddedFiles &aProto)

Function Documentation

◆ FindItemsFromSyncSelection()

std::vector< BOARD_ITEM * > kiapi::board::FindItemsFromSyncSelection	(	const BOARD *	aBoard,
		const google::protobuf::RepeatedPtrField< kiapi::common::commands::SelectionSpec > &	aItems )

Resolve a cross-probe selection request against a board.

Parameters

aBoard	is the board to search.
aItems	are the specs to resolve, each naming a footprint, a pad or a schematic sheet.

Returns: the matching items, ordered to follow the order of aItems.

Definition at line 290 of file api_pcb_utils.cpp.

References BOARD::Footprints(), index, pad, and kiapi::common::UnpackSheetPath().

Referenced by API_HANDLER_PCB::handleSyncSelection(), and CROSS_PROBE_SELECTION_FIXTURE::Resolve().

◆ PackBoardStackup()

void kiapi::board::PackBoardStackup	(	const BOARD &	aBoard,
		BoardStackup &	aOut )

Definition at line 153 of file api_pcb_utils.cpp.

References FromProtoEnum(), BOARD::GetLayerName(), BOARD::GetStackupOrDefault(), and BOARD_STACKUP::Serialize().

Referenced by API_HANDLER_BOARD::handleGetStackup(), and PCBNEW_JOBS_HANDLER::JobExportStackup().

◆ PackEmbeddedFiles() [1/2]

void kiapi::board::PackEmbeddedFiles	(	common::types::EmbeddedFiles &	aOutput,
		const EMBEDDED_FILES &	aFiles )

Definition at line 242 of file api_pcb_utils.cpp.

References EMBEDDED_FILES::EmbeddedFileMap(), name, and ToProtoEnum().

Referenced by API_HANDLER_PCB::handleGetEmbeddedFiles(), and FOOTPRINT::Serialize().

◆ PackEmbeddedFiles() [2/2]

void kiapi::board::PackEmbeddedFiles	(	kiapi::common::types::EmbeddedFiles &	aOutput,
		const EMBEDDED_FILES &	aFiles )

◆ PackLayerSet()

void kiapi::board::PackLayerSet	(	google::protobuf::RepeatedField< int > &	aOutput,
		const LSET &	aLayerSet )

Definition at line 128 of file api_pcb_utils.cpp.

References LSET::Seq(), and ToProtoEnum().

Referenced by API_HANDLER_BOARD::handleGetBoardEnabledLayers(), API_HANDLER_PCB::handleGetBoardPlotSettings(), API_HANDLER_PCB::handleSetBoardEnabledLayers(), PADSTACK::Serialize(), PCB_VIA::Serialize(), and ZONE::Serialize().

◆ PackTeardropSettings()

void kiapi::board::PackTeardropSettings	(	types::PadTeardropSettings &	aOutput,
		const TEARDROP_PARAMETERS &	aParams )

Definition at line 169 of file api_pcb_utils.cpp.

References TEARDROP_PARAMETERS::m_AllowUseTwoTracks, TEARDROP_PARAMETERS::m_BestLengthRatio, TEARDROP_PARAMETERS::m_BestWidthRatio, TEARDROP_PARAMETERS::m_CurvedEdges, TEARDROP_PARAMETERS::m_Enabled, TEARDROP_PARAMETERS::m_TdMaxLen, TEARDROP_PARAMETERS::m_TdMaxWidth, TEARDROP_PARAMETERS::m_TdOnPadsInZones, and TEARDROP_PARAMETERS::m_WidthtoSizeFilterRatio.

Referenced by PAD::Serialize(), and PCB_VIA::Serialize().

◆ PackZoneLayerOverrides()

void kiapi::board::PackZoneLayerOverrides	(	google::protobuf::RepeatedPtrField< types::ZoneLayerOverrideEntry > *	aOutput,
		const std::map< PCB_LAYER_ID, ZONE_LAYER_OVERRIDE > &	aInput )

Definition at line 197 of file api_pcb_utils.cpp.

References ToProtoEnum(), ZLO_FORCE_FLASHED, and ZLO_FORCE_NO_ZONE_CONNECTION.

Referenced by PAD::Serialize(), and PCB_VIA::Serialize().

◆ UnpackEmbeddedFiles() [1/2]

bool kiapi::board::UnpackEmbeddedFiles	(	EMBEDDED_FILES &	aOutput,
		const common::types::EmbeddedFiles &	aProto )

Definition at line 259 of file api_pcb_utils.cpp.

References EMBEDDED_FILES::AddFile(), EMBEDDED_FILES::ClearEmbeddedFiles(), EMBEDDED_FILES::DecompressAndDecode(), FromProtoEnum(), and EMBEDDED_FILES::OK.

Referenced by FOOTPRINT::Deserialize(), and unpackEmbeddedFiles().

◆ UnpackEmbeddedFiles() [2/2]

bool kiapi::board::UnpackEmbeddedFiles	(	EMBEDDED_FILES &	aOutput,
		const kiapi::common::types::EmbeddedFiles &	aProto )

◆ UnpackLayerSet()

LSET kiapi::board::UnpackLayerSet ( const google::protobuf::RepeatedField< int > & aProtoLayerSet )

Definition at line 135 of file api_pcb_utils.cpp.

References F_Cu, FromProtoEnum(), IsValidLayer(), PCB_LAYER_ID_COUNT, and BASE_SET::set().

Referenced by PADSTACK::Deserialize(), ZONE::Deserialize(), API_HANDLER_PCB::handleSetBoardEnabledLayers(), and API_HANDLER_PCB::handleSetBoardPlotSettings().

◆ UnpackTeardropSettings()

void kiapi::board::UnpackTeardropSettings	(	TEARDROP_PARAMETERS &	aOutput,
		const types::PadTeardropSettings &	aProto )

Definition at line 183 of file api_pcb_utils.cpp.