api_sch_utils.h File Reference

#include <memory>
#include <tl/expected.hpp>
#include <core/typeinfo.h>
#include <api/common/envelope.pb.h>
#include <api/schematic/schematic_types.pb.h>
#include <pin_map.h>

Go to the source code of this file.

Functions
std::unique_ptr< EDA_ITEM >	CreateItemForType (KICAD_T aType, EDA_ITEM *aContainer)
bool	PackSymbol (kiapi::schematic::types::SchematicSymbolInstance *aOutput, const SCH_SYMBOL *aInput, const SCH_SHEET_PATH &aPath)
bool	UnpackSymbol (SCH_SYMBOL *aOutput, const kiapi::schematic::types::SchematicSymbolInstance &aInput)
void	PackPinMapOverride (kiapi::schematic::types::PinMapInstanceOverride *aOutput, const PIN_MAP_INSTANCE_OVERRIDE &aOverride)
	Pack/unpack a pin-to-pad map instance override to/from its protobuf form (issue #2282).
PIN_MAP_INSTANCE_OVERRIDE	UnpackPinMapOverride (const kiapi::schematic::types::PinMapInstanceOverride &aInput)
bool	PackSheet (kiapi::schematic::types::SheetSymbol *aOutput, const SCH_SHEET *aInput, const SCH_SHEET_PATH &aPath)
tl::expected< bool, kiapi::common::ApiResponseStatus >	UnpackSheet (SCH_SHEET *aOutput, const kiapi::schematic::types::SheetSymbol &aInput)

Function Documentation

CreateItemForType()

std::unique_ptr< EDA_ITEM > CreateItemForType	(	KICAD_T	aType,
		EDA_ITEM *	aContainer )

Definition at line 53 of file api_sch_utils.cpp.

References LIB_SYMBOL_T, SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_GROUP_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_PIN_T, SCH_SCREEN_T, SCH_SHAPE_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TABLE_T, SCH_TABLECELL_T, SCH_TEXT_T, SCH_TEXTBOX_T, and EDA_ITEM::Type().

Referenced by API_HANDLER_BOARD::createItemForType(), API_HANDLER_SCH::createItemForType(), FOOTPRINT::Deserialize(), and SCH_SYMBOL::Deserialize().

PackPinMapOverride()

void PackPinMapOverride	(	kiapi::schematic::types::PinMapInstanceOverride *	aOutput,
		const PIN_MAP_INSTANCE_OVERRIDE &	aOverride )

Pack/unpack a pin-to-pad map instance override to/from its protobuf form (issue #2282).

Definition at line 105 of file api_sch_utils.cpp.

References edit, PIN_MAP_INSTANCE_OVERRIDE::m_ActiveMapName, PIN_MAP_INSTANCE_OVERRIDE::m_Edits, PIN_MAP_INSTANCE_OVERRIDE::m_Mode, and ToProtoEnum().

Referenced by BOOST_AUTO_TEST_CASE(), and PackSymbol().

PackSheet()

bool PackSheet	(	kiapi::schematic::types::SheetSymbol *	aOutput,
		const SCH_SHEET *	aInput,
		const SCH_SHEET_PATH &	aPath )

Definition at line 301 of file api_sch_utils.cpp.

References SCH_SHEET_PATH::GetPageNumber(), kiapi::common::PackSheetPath(), SCH_SHEET_PATH::Path(), and SCH_SHEET::Serialize().

Referenced by API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleGetItems(), and API_HANDLER_SCH::handleGetItemsById().

PackSymbol()

bool PackSymbol	(	kiapi::schematic::types::SchematicSymbolInstance *	aOutput,
		const SCH_SYMBOL *	aInput,
		const SCH_SHEET_PATH &	aPath )

Definition at line 137 of file api_sch_utils.cpp.

References KIID::AsString(), SCH_SYMBOL::GetInstance(), SCH_SYMBOL::GetLibSymbolRef(), SCH_SYMBOL::GetPinMapOverride(), SCH_SYMBOL::GetPins(), SCH_SYMBOL_INSTANCE::m_DNP, SCH_SYMBOL_INSTANCE::m_ExcludedFromBoard, SCH_SYMBOL_INSTANCE::m_ExcludedFromBOM, SCH_SYMBOL_INSTANCE::m_ExcludedFromPosFiles, SCH_SYMBOL_INSTANCE::m_ExcludedFromSim, SCH_SYMBOL_INSTANCE::m_Reference, SCH_SYMBOL_INSTANCE::m_Unit, EDA_ITEM::m_Uuid, SCH_SYMBOL_INSTANCE::m_Variants, name, kiapi::common::PackLibId(), PackPinMapOverride(), kiapi::common::PackSheetPath(), SCH_SHEET_PATH::Path(), path, SCH_SHEET_PATH::PathHumanReadable(), pin, SCH_SYMBOL::Serialize(), and traceApi.

Referenced by BOOST_AUTO_TEST_CASE(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleGetItems(), and API_HANDLER_SCH::handleGetItemsById().

UnpackPinMapOverride()

PIN_MAP_INSTANCE_OVERRIDE UnpackPinMapOverride

(

const kiapi::schematic::types::PinMapInstanceOverride &

aInput

)

Definition at line 122 of file api_sch_utils.cpp.

References FromProtoEnum(), and PIN_MAP_INSTANCE_OVERRIDE::m_Mode.

Referenced by BOOST_AUTO_TEST_CASE(), and UnpackSymbol().

UnpackSheet()

tl::expected< bool, kiapi::common::ApiResponseStatus > UnpackSheet	(	SCH_SHEET *	aOutput,
		const kiapi::schematic::types::SheetSymbol &	aInput )

Definition at line 317 of file api_sch_utils.cpp.

References SCH_SHEET::AddInstance(), SCH_SHEET::Deserialize(), SCH_SHEET_INSTANCE::m_PageNumber, SCH_SHEET_INSTANCE::m_Path, and kiapi::common::UnpackSheetPath().

Referenced by API_HANDLER_SCH::handleCreateUpdateItemsInternal().

UnpackSymbol()

bool UnpackSymbol	(	SCH_SYMBOL *	aOutput,
		const kiapi::schematic::types::SchematicSymbolInstance &	aInput )

Definition at line 240 of file api_sch_utils.cpp.

References SCH_SYMBOL::AddHierarchicalReference(), SCH_SYMBOL::Deserialize(), VARIANT::m_Description, SCH_SYMBOL_INSTANCE::m_DNP, VARIANT::m_DNP, SCH_SYMBOL_INSTANCE::m_ExcludedFromBoard, VARIANT::m_ExcludedFromBoard, SCH_SYMBOL_INSTANCE::m_ExcludedFromBOM, VARIANT::m_ExcludedFromBOM, SCH_SYMBOL_INSTANCE::m_ExcludedFromPosFiles, VARIANT::m_ExcludedFromPosFiles, SCH_SYMBOL_INSTANCE::m_ExcludedFromSim, VARIANT::m_ExcludedFromSim, VARIANT::m_Fields, VARIANT::m_Name, SCH_SYMBOL_INSTANCE::m_Path, SCH_SYMBOL_INSTANCE::m_Reference, SCH_SYMBOL_INSTANCE::m_Unit, SCH_SYMBOL_INSTANCE::m_Variants, SCH_SYMBOL::SetDNP(), SCH_SYMBOL::SetExcludedFromBoard(), SCH_SYMBOL::SetExcludedFromBOM(), SCH_SYMBOL::SetExcludedFromPosFiles(), SCH_SYMBOL::SetExcludedFromSim(), SCH_SYMBOL::SetPinMapOverride(), UnpackPinMapOverride(), and kiapi::common::UnpackSheetPath().

Referenced by BOOST_AUTO_TEST_CASE(), and API_HANDLER_SCH::handleCreateUpdateItemsInternal().