API_HANDLER_PCB Class Reference

#include <api_handler_pcb.h>

Inheritance diagram for API_HANDLER_PCB:

Public Member Functions
	API_HANDLER_PCB (PCB_EDIT_FRAME *aFrame)
	API_HANDLER_PCB (std::shared_ptr< PCB_CONTEXT > aContext, PCB_EDIT_FRAME *aFrame=nullptr)
API_RESULT	Handle (ApiRequest &aMsg)
	Attempt to handle the given API request, if a handler exists in this class for the message.
void	requestNetSettingsNotification ()
bool	clearNetSettingsNotification ()
	Returns true if the notification had been requested at the time of the call.
void	setApiServer (KICAD_API_SERVER *aServer)
	Set by KICAD_API_SERVER::RegisterHandler; null when the handler is not registered.
KICAD_API_SERVER *	apiServer () const

Protected Types
typedef std::function< HANDLER_RESULT< ApiResponse >(ApiRequest &)>	REQUEST_HANDLER
	A handler for outer messages (envelopes) that will unpack to inner messages and call a specific handler function.

Protected Member Functions
kiapi::common::types::DocumentType	thisDocumentType () const override
	Override this to specify which document type this editor handles.
tl::expected< bool, ApiResponseStatus >	validateDocumentInternal (const DocumentSpecifier &aDocument) const override
std::optional< TITLE_BLOCK * >	getTitleBlock (const DocumentSpecifier &aDocument) override
std::optional< PAGE_INFO >	getPageSettings (const DocumentSpecifier &aDocument) override
bool	setPageSettings (const DocumentSpecifier &aDocument, const PAGE_INFO &aPageInfo) override
wxString	getDrawingSheetFileName () override
void	setDrawingSheetFileName (const wxString &aFileName) override
void	onModified () override
void	onNetSettingsChanged () override
	Called on all registered handlers after project net settings (netclasses or netclass assignments) have been changed via the API.
HANDLER_RESULT< commands::GetDocumentModifiedStateResponse >	handleGetDocumentModifiedState (const HANDLER_CONTEXT< commands::GetDocumentModifiedState > &aCtx) override
std::unique_ptr< COMMIT >	createCommit () override
	Override this to create an appropriate COMMIT subclass for the frame in question.
void	deleteItemsInternal (std::map< KIID, ItemDeletionStatus > &aItemsToDelete, const std::string &aClientName) override
std::optional< EDA_ITEM * >	getItemFromDocument (const DocumentSpecifier &aDocument, const KIID &aId) override
void	pushCurrentCommit (const std::string &aClientName, const wxString &aMessage) override
HANDLER_RESULT< types::ItemRequestStatus >	handleCreateUpdateItemsInternal (bool aCreate, const std::string &aClientName, const types::ItemHeader &aHeader, const google::protobuf::RepeatedPtrField< google::protobuf::Any > &aItems, std::function< void(commands::ItemStatus, google::protobuf::Any)> aItemHandler) override
BOARD_CONTEXT *	context () const
BOARD *	board () const
PROJECT &	project () const
TOOL_MANAGER *	toolManager () const
std::optional< BOARD_ITEM * >	getItemById (const KIID &aId) const
virtual BOARD_ITEM_CONTAINER *	getDefaultContainer ()
std::optional< ApiResponseStatus >	checkForHeadless (const std::string &aCommandName) const
GENERATOR_TOOL *	ensureGeneratorTool () const
	Creates the generator tool if needed (e.g. in headless mode); returns it if available.
void	regenerateGenerators (GENERATOR_TOOL *aTool, BOARD_COMMIT *aCommit, const std::vector< PCB_GENERATOR * > &aGenerators, std::function< void(const KIID &, commands::ItemStatus)> aResultHandler) const
std::vector< KICAD_T >	parseRequestedItemTypes (const google::protobuf::RepeatedField< int > &aTypes)
HANDLER_RESULT< std::optional< KIID > >	validateItemHeaderDocument (const kiapi::common::types::ItemHeader &aHeader)
	If the header is valid, returns the item container.
HANDLER_RESULT< bool >	validateDocument (const DocumentSpecifier &aDocument)
virtual std::optional< ApiResponseStatus >	checkForBusy ()
	Checks if the editor can accept commands.
HANDLER_RESULT< commands::BeginCommitResponse >	handleBeginCommit (const HANDLER_CONTEXT< commands::BeginCommit > &aCtx)
HANDLER_RESULT< commands::EndCommitResponse >	handleEndCommit (const HANDLER_CONTEXT< commands::EndCommit > &aCtx)
COMMIT *	getCurrentCommit (const std::string &aClientName)
HANDLER_RESULT< commands::CreateItemsResponse >	handleCreateItems (const HANDLER_CONTEXT< commands::CreateItems > &aCtx)
HANDLER_RESULT< commands::UpdateItemsResponse >	handleUpdateItems (const HANDLER_CONTEXT< commands::UpdateItems > &aCtx)
HANDLER_RESULT< commands::DeleteItemsResponse >	handleDeleteItems (const HANDLER_CONTEXT< commands::DeleteItems > &aCtx)
HANDLER_RESULT< commands::HitTestResponse >	handleHitTest (const HANDLER_CONTEXT< commands::HitTest > &aCtx)
HANDLER_RESULT< types::TitleBlockInfo >	handleGetTitleBlockInfo (const HANDLER_CONTEXT< commands::GetTitleBlockInfo > &aCtx)
HANDLER_RESULT< google::protobuf::Empty >	handleSetTitleBlockInfo (const HANDLER_CONTEXT< commands::SetTitleBlockInfo > &aCtx)
HANDLER_RESULT< types::PageSettings >	handleGetPageSettings (const HANDLER_CONTEXT< commands::GetPageSettings > &aCtx)
HANDLER_RESULT< types::PageSettings >	handleSetPageSettings (const HANDLER_CONTEXT< commands::SetPageSettings > &aCtx)
virtual const EDA_IU_SCALE &	getIuScale () const
	Returns the internal-unit scale that the concrete editor uses.
template<class RequestType, class ResponseType, class HandlerType>
void	registerHandler (HANDLER_RESULT< ResponseType >(HandlerType::*aHandler)(const HANDLER_CONTEXT< RequestType > &))
	Registers an API command handler for the given message types.

Static Protected Member Functions
static HANDLER_RESULT< std::unique_ptr< BOARD_ITEM > >	createItemForType (KICAD_T aType, BOARD_ITEM_CONTAINER *aContainer)

Protected Attributes
std::map< std::string, std::pair< KIID, std::unique_ptr< COMMIT > > >	m_commits
std::set< std::string >	m_activeClients
EDA_BASE_FRAME *	m_frame
std::map< std::string, REQUEST_HANDLER >	m_handlers
	Maps type name (without the URL prefix) to a handler method.
bool	m_notifyNetSettings = false
KICAD_API_SERVER *	m_apiServer = nullptr

Static Protected Attributes
static const wxString	m_defaultCommitMessage = _( "Modification from API" )

Private Types
typedef std::map< std::string, PROPERTY_BASE * >	PROTO_PROPERTY_MAP

Private Member Functions
HANDLER_RESULT< commands::GetOpenDocumentsResponse >	handleGetOpenDocuments (const HANDLER_CONTEXT< commands::GetOpenDocuments > &aCtx)
HANDLER_RESULT< Empty >	handleSaveDocument (const HANDLER_CONTEXT< commands::SaveDocument > &aCtx)
HANDLER_RESULT< Empty >	handleSaveDocumentAs (const HANDLER_CONTEXT< commands::SaveDocumentAs > &aCtx)
HANDLER_RESULT< Empty >	handleSaveCopyOfDocument (const HANDLER_CONTEXT< commands::SaveCopyOfDocument > &aCtx)
HANDLER_RESULT< Empty >	handleRevertDocument (const HANDLER_CONTEXT< commands::RevertDocument > &aCtx)
HANDLER_RESULT< commands::GetItemsResponse >	handleGetItems (const HANDLER_CONTEXT< commands::GetItems > &aCtx)
HANDLER_RESULT< BoardEnabledLayersResponse >	handleSetBoardEnabledLayers (const HANDLER_CONTEXT< SetBoardEnabledLayers > &aCtx)
HANDLER_RESULT< BoardDesignRulesResponse >	handleGetBoardDesignRules (const HANDLER_CONTEXT< GetBoardDesignRules > &aCtx)
HANDLER_RESULT< BoardDesignRulesResponse >	handleSetBoardDesignRules (const HANDLER_CONTEXT< SetBoardDesignRules > &aCtx)
HANDLER_RESULT< CustomRulesResponse >	handleGetCustomDesignRules (const HANDLER_CONTEXT< GetCustomDesignRules > &aCtx)
HANDLER_RESULT< CustomRulesResponse >	handleSetCustomDesignRules (const HANDLER_CONTEXT< SetCustomDesignRules > &aCtx)
HANDLER_RESULT< common::types::EmbeddedFiles >	handleGetEmbeddedFiles (const HANDLER_CONTEXT< GetEmbeddedFiles > &aCtx)
HANDLER_RESULT< google::protobuf::Empty >	handleAddEmbeddedFiles (const HANDLER_CONTEXT< AddEmbeddedFiles > &aCtx)
HANDLER_RESULT< google::protobuf::Empty >	handleSetEmbeddedFiles (const HANDLER_CONTEXT< SetEmbeddedFiles > &aCtx)
HANDLER_RESULT< types::Vector2 >	handleGetBoardOrigin (const HANDLER_CONTEXT< GetBoardOrigin > &aCtx)
HANDLER_RESULT< Empty >	handleSetBoardOrigin (const HANDLER_CONTEXT< SetBoardOrigin > &aCtx)
HANDLER_RESULT< BoardLayerNameResponse >	handleGetBoardLayerName (const HANDLER_CONTEXT< GetBoardLayerName > &aCtx)
HANDLER_RESULT< BoardLayerResponse >	handleGetBoardLayerByName (const HANDLER_CONTEXT< GetBoardLayerByName > &aCtx)
HANDLER_RESULT< NetsResponse >	handleGetNets (const HANDLER_CONTEXT< GetNets > &aCtx)
HANDLER_RESULT< commands::GetItemsResponse >	handleGetConnectedItems (const HANDLER_CONTEXT< GetConnectedItems > &aCtx)
HANDLER_RESULT< commands::GetItemsResponse >	handleGetItemsByNet (const HANDLER_CONTEXT< GetItemsByNet > &aCtx)
HANDLER_RESULT< commands::GetItemsResponse >	handleGetItemsByNetClass (const HANDLER_CONTEXT< GetItemsByNetClass > &aCtx)
HANDLER_RESULT< NetClassForNetsResponse >	handleGetNetClassForNets (const HANDLER_CONTEXT< GetNetClassForNets > &aCtx)
HANDLER_RESULT< Empty >	handleRefillZones (const HANDLER_CONTEXT< RefillZones > &aCtx)
HANDLER_RESULT< ImportNetlistResponse >	handleImportNetlist (const HANDLER_CONTEXT< ImportNetlist > &aCtx)
HANDLER_RESULT< ImportSpecctraSessionResponse >	handleImportSpecctraSession (const HANDLER_CONTEXT< ImportSpecctraSession > &aCtx)
HANDLER_RESULT< BoardEditorAppearanceSettings >	handleGetBoardEditorAppearanceSettings (const HANDLER_CONTEXT< GetBoardEditorAppearanceSettings > &aCtx)
HANDLER_RESULT< Empty >	handleSetBoardEditorAppearanceSettings (const HANDLER_CONTEXT< SetBoardEditorAppearanceSettings > &aCtx)
HANDLER_RESULT< BoardPlotSettingsResponse >	handleGetBoardPlotSettings (const HANDLER_CONTEXT< GetBoardPlotSettings > &aCtx)
HANDLER_RESULT< Empty >	handleSetBoardPlotSettings (const HANDLER_CONTEXT< SetBoardPlotSettings > &aCtx)
HANDLER_RESULT< InjectDrcErrorResponse >	handleInjectDrcError (const HANDLER_CONTEXT< InjectDrcError > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExport3D (const HANDLER_CONTEXT< RunBoardJobExport3D > &aCtx)
HANDLER_RESULT< commands::VariantsResponse >	handleGetVariants (const HANDLER_CONTEXT< commands::GetVariants > &aCtx)
HANDLER_RESULT< Empty >	handleAddVariant (const HANDLER_CONTEXT< commands::AddVariant > &aCtx)
HANDLER_RESULT< Empty >	handleDeleteVariant (const HANDLER_CONTEXT< commands::DeleteVariant > &aCtx)
HANDLER_RESULT< Empty >	handleRenameVariant (const HANDLER_CONTEXT< commands::RenameVariant > &aCtx)
HANDLER_RESULT< Empty >	handleCopyVariant (const HANDLER_CONTEXT< commands::CopyVariant > &aCtx)
HANDLER_RESULT< Empty >	handleSetVariantDescription (const HANDLER_CONTEXT< commands::SetVariantDescription > &aCtx)
HANDLER_RESULT< Empty >	handleSetCurrentVariant (const HANDLER_CONTEXT< commands::SetCurrentVariant > &aCtx)
HANDLER_RESULT< commands::CurrentVariantResponse >	handleGetCurrentVariant (const HANDLER_CONTEXT< commands::GetCurrentVariant > &aCtx)
HANDLER_RESULT< kiapi::common::commands::PlaceFromLibraryResponse >	handlePlaceFootprintFromLibrary (const HANDLER_CONTEXT< kiapi::board::commands::PlaceFootprintFromLibrary > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportRender (const HANDLER_CONTEXT< RunBoardJobExportRender > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportSvg (const HANDLER_CONTEXT< RunBoardJobExportSvg > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportDxf (const HANDLER_CONTEXT< RunBoardJobExportDxf > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportPdf (const HANDLER_CONTEXT< RunBoardJobExportPdf > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportPs (const HANDLER_CONTEXT< RunBoardJobExportPs > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportPng (const HANDLER_CONTEXT< RunBoardJobExportPng > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportGerbers (const HANDLER_CONTEXT< RunBoardJobExportGerbers > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportDrill (const HANDLER_CONTEXT< RunBoardJobExportDrill > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportPosition (const HANDLER_CONTEXT< RunBoardJobExportPosition > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportGencad (const HANDLER_CONTEXT< RunBoardJobExportGencad > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportSpecctraDsn (const HANDLER_CONTEXT< RunBoardJobExportSpecctraDsn > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportIpc2581 (const HANDLER_CONTEXT< RunBoardJobExportIpc2581 > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportIpcD356 (const HANDLER_CONTEXT< RunBoardJobExportIpcD356 > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportODB (const HANDLER_CONTEXT< RunBoardJobExportODB > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportIdf (const HANDLER_CONTEXT< RunBoardJobExportIdf > &aCtx)
HANDLER_RESULT< types::RunJobResponse >	handleRunBoardJobExportStats (const HANDLER_CONTEXT< RunBoardJobExportStats > &aCtx)
HANDLER_RESULT< commands::CrossProbeAnnounceResponse >	handleCrossProbeAnnounce (const HANDLER_CONTEXT< commands::CrossProbeAnnounce > &aCtx)
HANDLER_RESULT< commands::SyncSelectionResponse >	handleSyncSelection (const HANDLER_CONTEXT< commands::SyncSelection > &aCtx)
HANDLER_RESULT< commands::HighlightNetsResponse >	handleHighlightNets (const HANDLER_CONTEXT< commands::HighlightNets > &aCtx)
PCB_CONTEXT *	pcbContext () const
PCB_EDIT_FRAME *	frame () const
HANDLER_RESULT< commands::RunActionResponse >	handleRunAction (const HANDLER_CONTEXT< commands::RunAction > &aCtx)
HANDLER_RESULT< commands::GetItemsResponse >	handleGetItemsById (const HANDLER_CONTEXT< commands::GetItemsById > &aCtx)
HANDLER_RESULT< commands::SelectionResponse >	handleGetSelection (const HANDLER_CONTEXT< commands::GetSelection > &aCtx)
HANDLER_RESULT< Empty >	handleClearSelection (const HANDLER_CONTEXT< commands::ClearSelection > &aCtx)
HANDLER_RESULT< commands::SelectionResponse >	handleAddToSelection (const HANDLER_CONTEXT< commands::AddToSelection > &aCtx)
HANDLER_RESULT< commands::SelectionResponse >	handleRemoveFromSelection (const HANDLER_CONTEXT< commands::RemoveFromSelection > &aCtx)
HANDLER_RESULT< Empty >	handleFocusOnItems (const HANDLER_CONTEXT< commands::FocusOnItems > &aCtx)
HANDLER_RESULT< BoardStackupResponse >	handleGetStackup (const HANDLER_CONTEXT< GetBoardStackup > &aCtx)
HANDLER_RESULT< BoardEnabledLayersResponse >	handleGetBoardEnabledLayers (const HANDLER_CONTEXT< GetBoardEnabledLayers > &aCtx)
HANDLER_RESULT< GraphicsDefaultsResponse >	handleGetGraphicsDefaults (const HANDLER_CONTEXT< GetGraphicsDefaults > &aCtx)
HANDLER_RESULT< commands::GetBoundingBoxResponse >	handleGetBoundingBox (const HANDLER_CONTEXT< commands::GetBoundingBox > &aCtx)
HANDLER_RESULT< BoardBoundingBoxResponse >	handleGetBoardBoundingBox (const HANDLER_CONTEXT< GetBoardBoundingBox > &aCtx)
HANDLER_RESULT< PadShapeAsPolygonResponse >	handleGetPadShapeAsPolygon (const HANDLER_CONTEXT< GetPadShapeAsPolygon > &aCtx)
HANDLER_RESULT< PadstackPresenceResponse >	handleCheckPadstackPresenceOnLayers (const HANDLER_CONTEXT< CheckPadstackPresenceOnLayers > &aCtx)
HANDLER_RESULT< commands::ExpandTextVariablesResponse >	handleExpandTextVariables (const HANDLER_CONTEXT< commands::ExpandTextVariables > &aCtx)
HANDLER_RESULT< Empty >	handleInteractiveMoveItems (const HANDLER_CONTEXT< InteractiveMoveItems > &aCtx)
HANDLER_RESULT< FlipItemsResponse >	handleFlipItems (const HANDLER_CONTEXT< FlipItems > &aCtx)
HANDLER_RESULT< commands::SavedDocumentResponse >	handleSaveDocumentToString (const HANDLER_CONTEXT< commands::SaveDocumentToString > &aCtx)
HANDLER_RESULT< commands::SavedSelectionResponse >	handleSaveSelectionToString (const HANDLER_CONTEXT< commands::SaveSelectionToString > &aCtx)
HANDLER_RESULT< commands::CreateItemsResponse >	handleParseAndCreateItemsFromString (const HANDLER_CONTEXT< commands::ParseAndCreateItemsFromString > &aCtx)
HANDLER_RESULT< BoardLayers >	handleGetVisibleLayers (const HANDLER_CONTEXT< GetVisibleLayers > &aCtx)
HANDLER_RESULT< Empty >	handleSetVisibleLayers (const HANDLER_CONTEXT< SetVisibleLayers > &aCtx)
HANDLER_RESULT< BoardLayerResponse >	handleGetActiveLayer (const HANDLER_CONTEXT< GetActiveLayer > &aCtx)
HANDLER_RESULT< Empty >	handleSetActiveLayer (const HANDLER_CONTEXT< SetActiveLayer > &aCtx)
template<typename MessageType>
bool	tryUnpack (ApiRequest &aRequest, ApiResponse &aReply, MessageType &aDest)

Private Attributes
std::shared_ptr< BOARD_CONTEXT >	m_context

Detailed Description

Definition at line 49 of file api_handler_pcb.h.

Member Typedef Documentation

PROTO_PROPERTY_MAP

typedef std::map<std::string, PROPERTY_BASE*> API_HANDLER_PCB::PROTO_PROPERTY_MAP

private

Definition at line 56 of file api_handler_pcb.h.

REQUEST_HANDLER

typedef std::function<HANDLER_RESULT<ApiResponse>( ApiRequest& )> API_HANDLER::REQUEST_HANDLER

protectedinherited

A handler for outer messages (envelopes) that will unpack to inner messages and call a specific handler function.

See also

registerHandler.

Definition at line 97 of file api_handler.h.

Constructor & Destructor Documentation

API_HANDLER_PCB() [1/2]

API_HANDLER_PCB::API_HANDLER_PCB

(

PCB_EDIT_FRAME *

aFrame

)

Definition at line 120 of file api_handler_pcb.cpp.

References API_HANDLER_PCB(), and CreatePcbFrameContext().

Referenced by API_HANDLER_PCB().

API_HANDLER_PCB() [2/2]

API_HANDLER_PCB::API_HANDLER_PCB	(	std::shared_ptr< PCB_CONTEXT >	aContext,
		PCB_EDIT_FRAME *	aFrame = nullptr )

Definition at line 126 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::API_HANDLER_BOARD(), handleAddEmbeddedFiles(), handleAddVariant(), handleCopyVariant(), handleCrossProbeAnnounce(), handleDeleteVariant(), handleGetBoardDesignRules(), handleGetBoardEditorAppearanceSettings(), handleGetBoardLayerByName(), handleGetBoardLayerName(), handleGetBoardOrigin(), handleGetBoardPlotSettings(), handleGetConnectedItems(), handleGetCurrentVariant(), handleGetCustomDesignRules(), handleGetEmbeddedFiles(), handleGetItems(), handleGetItemsByNet(), handleGetItemsByNetClass(), handleGetNetClassForNets(), handleGetNets(), handleGetOpenDocuments(), API_HANDLER_EDITOR::handleGetPageSettings(), handleGetVariants(), handleHighlightNets(), handleImportNetlist(), handleImportSpecctraSession(), handleInjectDrcError(), handlePlaceFootprintFromLibrary(), handleRefillZones(), handleRenameVariant(), handleRevertDocument(), handleRunBoardJobExport3D(), handleRunBoardJobExportDrill(), handleRunBoardJobExportDxf(), handleRunBoardJobExportGencad(), handleRunBoardJobExportGerbers(), handleRunBoardJobExportIdf(), handleRunBoardJobExportIpc2581(), handleRunBoardJobExportIpcD356(), handleRunBoardJobExportODB(), handleRunBoardJobExportPdf(), handleRunBoardJobExportPng(), handleRunBoardJobExportPosition(), handleRunBoardJobExportPs(), handleRunBoardJobExportRender(), handleRunBoardJobExportSpecctraDsn(), handleRunBoardJobExportStats(), handleRunBoardJobExportSvg(), handleSaveCopyOfDocument(), handleSaveDocument(), handleSaveDocumentAs(), handleSetBoardDesignRules(), handleSetBoardEditorAppearanceSettings(), handleSetBoardEnabledLayers(), handleSetBoardOrigin(), handleSetBoardPlotSettings(), handleSetCurrentVariant(), handleSetCustomDesignRules(), handleSetEmbeddedFiles(), API_HANDLER_EDITOR::handleSetPageSettings(), handleSetVariantDescription(), handleSyncSelection(), move, and API_HANDLER::registerHandler().

Member Function Documentation

apiServer()

KICAD_API_SERVER * API_HANDLER::apiServer ( ) const

inlineinherited

Definition at line 90 of file api_handler.h.

References m_apiServer.

Referenced by API_HANDLER_PCB::handleSaveDocumentAs(), and API_HANDLER_SCH::handleSaveDocumentAs().

board()

BOARD * API_HANDLER_BOARD::board ( ) const

inlineprotectedinherited

Definition at line 79 of file api_handler_board.h.

References context(), and BOARD_CONTEXT::GetBoard().

Referenced by deleteItemsInternal(), getDefaultContainer(), API_HANDLER_FOOTPRINT::getDefaultContainer(), getItemById(), API_HANDLER_PCB::handleAddEmbeddedFiles(), API_HANDLER_PCB::handleAddVariant(), API_HANDLER_PCB::handleCopyVariant(), handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handleDeleteVariant(), handleExpandTextVariables(), handleGetBoardBoundingBox(), API_HANDLER_PCB::handleGetBoardDesignRules(), handleGetBoardEnabledLayers(), API_HANDLER_PCB::handleGetBoardLayerByName(), API_HANDLER_PCB::handleGetBoardLayerName(), API_HANDLER_PCB::handleGetBoardOrigin(), API_HANDLER_PCB::handleGetBoardPlotSettings(), API_HANDLER_PCB::handleGetConnectedItems(), API_HANDLER_PCB::handleGetCustomDesignRules(), API_HANDLER_PCB::handleGetEmbeddedFiles(), handleGetGraphicsDefaults(), API_HANDLER_FOOTPRINT::handleGetItems(), API_HANDLER_PCB::handleGetItems(), API_HANDLER_PCB::handleGetItemsByNet(), API_HANDLER_PCB::handleGetItemsByNetClass(), API_HANDLER_PCB::handleGetNetClassForNets(), API_HANDLER_PCB::handleGetNets(), API_HANDLER_FOOTPRINT::handleGetOpenDocuments(), handleGetStackup(), API_HANDLER_PCB::handleGetVariants(), handleGetVisibleLayers(), API_HANDLER_PCB::handleImportSpecctraSession(), API_HANDLER_PCB::handlePlaceFootprintFromLibrary(), API_HANDLER_PCB::handleRefillZones(), API_HANDLER_PCB::handleRenameVariant(), API_HANDLER_PCB::handleSaveCopyOfDocument(), API_HANDLER_PCB::handleSaveDocument(), handleSaveDocumentToString(), handleSaveSelectionToString(), handleSetActiveLayer(), API_HANDLER_PCB::handleSetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardEnabledLayers(), API_HANDLER_PCB::handleSetBoardOrigin(), API_HANDLER_PCB::handleSetBoardPlotSettings(), API_HANDLER_PCB::handleSetCurrentVariant(), API_HANDLER_PCB::handleSetCustomDesignRules(), API_HANDLER_PCB::handleSetEmbeddedFiles(), API_HANDLER_PCB::handleSetVariantDescription(), handleSetVisibleLayers(), API_HANDLER_PCB::handleSyncSelection(), API_HANDLER_PCB::onNetSettingsChanged(), regenerateGenerators(), API_HANDLER_FOOTPRINT::validateAndGetFootprint(), and API_HANDLER_FOOTPRINT::validateDocumentInternal().

checkForBusy()

std::optional< ApiResponseStatus > API_HANDLER_EDITOR::checkForBusy ( )

protectedvirtualinherited

Checks if the editor can accept commands.

Returns

an error status if busy, std::nullopt if not busy

Definition at line 218 of file api_handler_editor.cpp.

References m_frame.

Referenced by API_HANDLER_PCB::handleAddEmbeddedFiles(), API_HANDLER_BOARD::handleAddToSelection(), API_HANDLER_SCH::handleAddToSelection(), API_HANDLER_PCB::handleAddVariant(), API_HANDLER_SCH::handleAddVariant(), handleBeginCommit(), API_HANDLER_BOARD::handleClearSelection(), API_HANDLER_SCH::handleClearSelection(), API_HANDLER_PCB::handleCopyVariant(), API_HANDLER_SCH::handleCopyVariant(), handleCreateItems(), handleDeleteItems(), API_HANDLER_PCB::handleDeleteVariant(), API_HANDLER_SCH::handleDeleteVariant(), handleEndCommit(), API_HANDLER_BOARD::handleFlipItems(), API_HANDLER_BOARD::handleFocusOnItems(), API_HANDLER_SCH::handleFocusOnItems(), API_HANDLER_BOARD::handleGetBoardBoundingBox(), API_HANDLER_BOARD::handleGetBoundingBox(), API_HANDLER_PCB::handleGetConnectedItems(), API_HANDLER_FOOTPRINT::handleGetItems(), API_HANDLER_PCB::handleGetItems(), API_HANDLER_SCH::handleGetItems(), API_HANDLER_SYMBOL::handleGetItems(), API_HANDLER_BOARD::handleGetItemsById(), API_HANDLER_SCH::handleGetItemsById(), API_HANDLER_SYMBOL::handleGetItemsById(), API_HANDLER_PCB::handleGetItemsByNet(), API_HANDLER_PCB::handleGetItemsByNetClass(), API_HANDLER_SCH::handleGetSchematicNetlist(), API_HANDLER_PCB::handleGetVariants(), API_HANDLER_SCH::handleGetVariants(), handleHitTest(), API_HANDLER_PCB::handleImportNetlist(), API_HANDLER_PCB::handleImportSpecctraSession(), API_HANDLER_PCB::handleInjectDrcError(), API_HANDLER_BOARD::handleInteractiveMoveItems(), API_HANDLER_BOARD::handleParseAndCreateItemsFromString(), API_HANDLER_PCB::handlePlaceFootprintFromLibrary(), API_HANDLER_SCH::handlePlaceSymbolFromLibrary(), API_HANDLER_PCB::handleRefillZones(), API_HANDLER_BOARD::handleRemoveFromSelection(), API_HANDLER_SCH::handleRemoveFromSelection(), API_HANDLER_PCB::handleRenameVariant(), API_HANDLER_SCH::handleRenameVariant(), API_HANDLER_FOOTPRINT::handleRevertDocument(), API_HANDLER_PCB::handleRevertDocument(), API_HANDLER_SCH::handleRevertDocument(), API_HANDLER_SYMBOL::handleRevertDocument(), API_HANDLER_BOARD::handleRunAction(), API_HANDLER_PCB::handleRunBoardJobExport3D(), API_HANDLER_PCB::handleRunBoardJobExportDrill(), API_HANDLER_PCB::handleRunBoardJobExportDxf(), API_HANDLER_PCB::handleRunBoardJobExportGencad(), API_HANDLER_PCB::handleRunBoardJobExportGerbers(), API_HANDLER_PCB::handleRunBoardJobExportIdf(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), API_HANDLER_PCB::handleRunBoardJobExportIpcD356(), API_HANDLER_PCB::handleRunBoardJobExportODB(), API_HANDLER_PCB::handleRunBoardJobExportPdf(), API_HANDLER_PCB::handleRunBoardJobExportPng(), API_HANDLER_PCB::handleRunBoardJobExportPosition(), API_HANDLER_PCB::handleRunBoardJobExportPs(), API_HANDLER_PCB::handleRunBoardJobExportRender(), API_HANDLER_PCB::handleRunBoardJobExportSpecctraDsn(), API_HANDLER_PCB::handleRunBoardJobExportStats(), API_HANDLER_PCB::handleRunBoardJobExportSvg(), API_HANDLER_SCH::handleRunSchematicJobExportBOM(), API_HANDLER_SCH::handleRunSchematicJobExportDxf(), API_HANDLER_SCH::handleRunSchematicJobExportNetlist(), API_HANDLER_SCH::handleRunSchematicJobExportPdf(), API_HANDLER_SCH::handleRunSchematicJobExportPng(), API_HANDLER_SCH::handleRunSchematicJobExportPs(), API_HANDLER_SCH::handleRunSchematicJobExportSvg(), API_HANDLER_PCB::handleSaveCopyOfDocument(), API_HANDLER_SCH::handleSaveCopyOfDocument(), API_HANDLER_SYMBOL::handleSaveCopyOfDocument(), API_HANDLER_PCB::handleSaveDocument(), API_HANDLER_SCH::handleSaveDocument(), API_HANDLER_SYMBOL::handleSaveDocument(), API_HANDLER_PCB::handleSaveDocumentAs(), API_HANDLER_SCH::handleSaveDocumentAs(), API_HANDLER_BOARD::handleSetActiveLayer(), API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), API_HANDLER_PCB::handleSetBoardOrigin(), API_HANDLER_PCB::handleSetBoardPlotSettings(), API_HANDLER_PCB::handleSetCurrentVariant(), API_HANDLER_SCH::handleSetCurrentVariant(), API_HANDLER_PCB::handleSetEmbeddedFiles(), API_HANDLER_PCB::handleSetVariantDescription(), API_HANDLER_SCH::handleSetVariantDescription(), API_HANDLER_BOARD::handleSetVisibleLayers(), handleUpdateItems(), and API_HANDLER_FOOTPRINT::validateAndGetFootprint().

checkForHeadless()

std::optional< ApiResponseStatus > API_HANDLER_BOARD::checkForHeadless ( const std::string & aCommandName ) const

protectedinherited

Definition at line 111 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::m_frame.

Referenced by handleAddToSelection(), handleClearSelection(), handleFocusOnItems(), handleGetActiveLayer(), API_HANDLER_PCB::handleGetBoardEditorAppearanceSettings(), handleGetSelection(), handleGetVisibleLayers(), API_HANDLER_PCB::handleHighlightNets(), handleInteractiveMoveItems(), API_HANDLER_FOOTPRINT::handleOpenLibraryItem(), handleRemoveFromSelection(), API_HANDLER_FOOTPRINT::handleRevertDocument(), handleRunAction(), handleSaveSelectionToString(), handleSetActiveLayer(), API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), handleSetVisibleLayers(), and API_HANDLER_PCB::handleSyncSelection().

clearNetSettingsNotification()

bool API_HANDLER::clearNetSettingsNotification ( )

inlineinherited

Returns true if the notification had been requested at the time of the call.

Definition at line 81 of file api_handler.h.

References m_notifyNetSettings.

context()

BOARD_CONTEXT * API_HANDLER_BOARD::context ( ) const

inlineprotectedinherited

Definition at line 77 of file api_handler_board.h.

References m_context.

Referenced by board(), API_HANDLER_FOOTPRINT::footprintContext(), API_HANDLER_PCB::getPageSettings(), API_HANDLER_PCB::getTitleBlock(), API_HANDLER_PCB::pcbContext(), project(), API_HANDLER_PCB::setPageSettings(), and toolManager().

createCommit()

std::unique_ptr< COMMIT > API_HANDLER_BOARD::createCommit ( )

overrideprotectedvirtualinherited

Override this to create an appropriate COMMIT subclass for the frame in question.

Returns

a new COMMIT, bound to the editor frame

Implements API_HANDLER_EDITOR.

Definition at line 138 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::m_frame, API_HANDLER_EDITOR::thisDocumentType(), and toolManager().

Referenced by API_HANDLER_PCB::handleRefillZones().

createItemForType()

HANDLER_RESULT< std::unique_ptr< BOARD_ITEM > > API_HANDLER_BOARD::createItemForType ( KICAD_T aType, BOARD_ITEM_CONTAINER * aContainer )

staticprotectedinherited

Definition at line 160 of file api_handler_board.cpp.

References CreateItemForType(), EDA_ITEM::GetFriendlyName(), PCB_3D_BODY_T, PCB_BARCODE_T, PCB_CONSTRAINT_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_GROUP_T, PCB_PAD_T, PCB_POINT_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TEXT_T, PCB_TEXTBOX_T, and PCB_ZONE_T.

Referenced by handleCreateUpdateItemsInternal().

deleteItemsInternal()

void API_HANDLER_BOARD::deleteItemsInternal ( std::map< KIID, ItemDeletionStatus > & aItemsToDelete, const std::string & aClientName )

overrideprotectedvirtualinherited

Implements API_HANDLER_EDITOR.

Definition at line 222 of file api_handler_board.cpp.

References _, board(), ensureGeneratorTool(), PCB_ACTIONS::genRemove, API_HANDLER_EDITOR::getCurrentCommit(), IsGeneratedTableCell(), PCB_FIELD::IsMandatory(), API_HANDLER_EDITOR::m_activeClients, COMMIT::Modify(), PCB_FIELD_T, PCB_GENERATOR_T, PCB_TABLECELL_T, pushCurrentCommit(), COMMIT::Remove(), TOOL_MANAGER::RunSynchronousAction(), and toolManager().

ensureGeneratorTool()

GENERATOR_TOOL * API_HANDLER_BOARD::ensureGeneratorTool ( ) const

protectedinherited

Creates the generator tool if needed (e.g. in headless mode); returns it if available.

Definition at line 287 of file api_handler_board.cpp.

References TOOL_MANAGER::FindTool(), GENERATOR_TOOL_NAME, TOOL_MANAGER::GetTool(), TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::ResetTools(), TOOL_BASE::RUN, and toolManager().

Referenced by deleteItemsInternal(), and handleCreateUpdateItemsInternal().

frame()

PCB_EDIT_FRAME * API_HANDLER_PCB::frame ( ) const

private

Definition at line 228 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::m_frame.

Referenced by handleAddVariant(), handleCopyVariant(), handleDeleteVariant(), handleGetBoardEditorAppearanceSettings(), handleHighlightNets(), handleRefillZones(), handleRenameVariant(), handleSetBoardEditorAppearanceSettings(), handleSetBoardOrigin(), handleSetCurrentVariant(), handleSyncSelection(), onModified(), onNetSettingsChanged(), and setDrawingSheetFileName().

getCurrentCommit()

COMMIT * API_HANDLER_EDITOR::getCurrentCommit ( const std::string & aClientName )

protectedinherited

Definition at line 154 of file api_handler_editor.cpp.

References createCommit(), and m_commits.

Referenced by API_HANDLER_BOARD::deleteItemsInternal(), API_HANDLER_SCH::deleteItemsInternal(), API_HANDLER_SYMBOL::deleteItemsInternal(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_SYMBOL::handleCreateUpdateItemsInternal(), API_HANDLER_BOARD::handleFlipItems(), API_HANDLER_PCB::handleImportSpecctraSession(), API_HANDLER_PCB::handleInjectDrcError(), API_HANDLER_BOARD::handleInteractiveMoveItems(), API_HANDLER_PCB::handlePlaceFootprintFromLibrary(), and API_HANDLER_SCH::handlePlaceSymbolFromLibrary().

getDefaultContainer()

BOARD_ITEM_CONTAINER * API_HANDLER_BOARD::getDefaultContainer ( )

protectedvirtualinherited

Reimplemented in API_HANDLER_FOOTPRINT.

Definition at line 124 of file api_handler_board.cpp.

References board().

Referenced by handleCreateUpdateItemsInternal().

getDrawingSheetFileName()

wxString API_HANDLER_PCB::getDrawingSheetFileName ( )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1442 of file api_handler_pcb.cpp.

References BASE_SCREEN::m_DrawingSheetFileName.

getItemById()

std::optional< BOARD_ITEM * > API_HANDLER_BOARD::getItemById ( const KIID & aId ) const

protectedinherited

Definition at line 149 of file api_handler_board.cpp.

References board(), and BOARD::ResolveItem().

Referenced by getItemFromDocument(), handleAddToSelection(), handleCheckPadstackPresenceOnLayers(), handleCreateUpdateItemsInternal(), handleFlipItems(), handleFocusOnItems(), handleGetBoundingBox(), API_HANDLER_PCB::handleGetConnectedItems(), handleGetItemsById(), handleGetPadShapeAsPolygon(), handleInteractiveMoveItems(), API_HANDLER_PCB::handleRefillZones(), and handleRemoveFromSelection().

getItemFromDocument()

std::optional< EDA_ITEM * > API_HANDLER_BOARD::getItemFromDocument ( const DocumentSpecifier & aDocument, const KIID & aId )

overrideprotectedvirtualinherited

Implements API_HANDLER_EDITOR.

Definition at line 334 of file api_handler_board.cpp.

References getItemById(), and API_HANDLER_EDITOR::validateDocument().

getIuScale()

virtual const EDA_IU_SCALE & API_HANDLER_EDITOR::getIuScale ( ) const

inlineprotectedvirtualinherited

Returns the internal-unit scale that the concrete editor uses.

API wire coordinates are always in nanometers, so this scale drives conversion to the editor's native IU. Defaults to pcbIUScale; schematic-like editors must override.

Reimplemented in API_HANDLER_SCH, and API_HANDLER_SYMBOL.

Definition at line 119 of file api_handler_editor.h.

References pcbIUScale.

Referenced by handleHitTest().

getPageSettings()

std::optional< PAGE_INFO > API_HANDLER_PCB::getPageSettings ( const DocumentSpecifier & aDocument )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1429 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::context(), BOARD_CONTEXT::GetBoard(), and BOARD::GetPageSettings().

getTitleBlock()

std::optional< TITLE_BLOCK * > API_HANDLER_PCB::getTitleBlock ( const DocumentSpecifier & aDocument )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1423 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::context(), BOARD_CONTEXT::GetBoard(), and BOARD::GetTitleBlock().

Handle()

API_RESULT API_HANDLER::Handle ( ApiRequest & aMsg )

inherited

Attempt to handle the given API request, if a handler exists in this class for the message.

Parameters

aMsg	is a request to attempt to handle

Returns

a response to send to the client, or an appropriate error

Definition at line 30 of file api_handler.cpp.

References m_handlers.

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(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

handleAddEmbeddedFiles()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleAddEmbeddedFiles ( const HANDLER_CONTEXT< AddEmbeddedFiles > & aCtx )

private

Definition at line 710 of file api_handler_pcb.cpp.

References EMBEDDED_FILES::AddFile(), API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), copy, EMBEDDED_FILES::EmbeddedFileMap(), BOARD::GetEmbeddedFiles(), onModified(), HANDLER_CONTEXT< RequestMessageType >::Request, result, unpackEmbeddedFiles(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleAddToSelection()

HANDLER_RESULT< SelectionResponse > API_HANDLER_BOARD::handleAddToSelection ( const HANDLER_CONTEXT< commands::AddToSelection > & aCtx )

privateinherited

Definition at line 840 of file api_handler_board.cpp.

References SELECTION_TOOL::AddItemsToSel(), API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), getItemById(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), API_HANDLER_EDITOR::m_frame, HANDLER_CONTEXT< RequestMessageType >::Request, toolManager(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_BOARD().

handleAddVariant()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleAddVariant ( const HANDLER_CONTEXT< commands::AddVariant > & aCtx )

private

Definition at line 3114 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), frame(), BOARD_CONTEXT::GetBoard(), GetDefaultVariantName(), name, onModified(), pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, PCB_EDIT_FRAME::UpdateVariantSelectionCtrl(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleBeginCommit()

HANDLER_RESULT< BeginCommitResponse > API_HANDLER_EDITOR::handleBeginCommit ( const HANDLER_CONTEXT< commands::BeginCommit > & aCtx )

protectedinherited

Definition at line 50 of file api_handler_editor.cpp.

References checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, createCommit(), m_activeClients, m_commits, HANDLER_CONTEXT< RequestMessageType >::Request, and validateItemHeaderDocument().

Referenced by API_HANDLER_EDITOR().

handleCheckPadstackPresenceOnLayers()

HANDLER_RESULT< PadstackPresenceResponse > API_HANDLER_BOARD::handleCheckPadstackPresenceOnLayers ( const HANDLER_CONTEXT< CheckPadstackPresenceOnLayers > & aCtx )

privateinherited

Definition at line 1157 of file api_handler_board.cpp.

References FromProtoEnum(), getItemById(), pad, PCB_LAYER_ID_COUNT, PCB_PAD_T, PCB_VIA_T, HANDLER_CONTEXT< RequestMessageType >::Request, BASE_SET::set(), ToProtoEnum(), API_HANDLER_EDITOR::validateDocument(), and via.

Referenced by API_HANDLER_BOARD().

handleClearSelection()

HANDLER_RESULT< Empty > API_HANDLER_BOARD::handleClearSelection ( const HANDLER_CONTEXT< commands::ClearSelection > & aCtx )

privateinherited

Definition at line 815 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), API_HANDLER_EDITOR::m_frame, HANDLER_CONTEXT< RequestMessageType >::Request, TOOL_MANAGER::RunAction(), ACTIONS::selectionClear, toolManager(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_BOARD().

handleCopyVariant()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleCopyVariant ( const HANDLER_CONTEXT< commands::CopyVariant > & aCtx )

private

Definition at line 3251 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), frame(), BOARD_CONTEXT::GetBoard(), GetDefaultVariantName(), onModified(), pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, PCB_EDIT_FRAME::UpdateVariantSelectionCtrl(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleCreateItems()

HANDLER_RESULT< CreateItemsResponse > API_HANDLER_EDITOR::handleCreateItems ( const HANDLER_CONTEXT< commands::CreateItems > & aCtx )

protectedinherited

Definition at line 235 of file api_handler_editor.cpp.

References checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, handleCreateUpdateItemsInternal(), HANDLER_CONTEXT< RequestMessageType >::Request, and result.

Referenced by API_HANDLER_EDITOR().

handleCreateUpdateItemsInternal()

HANDLER_RESULT< ItemRequestStatus > API_HANDLER_BOARD::handleCreateUpdateItemsInternal ( bool aCreate, const std::string & aClientName, const types::ItemHeader & aHeader, const google::protobuf::RepeatedPtrField< google::protobuf::Any > & aItems, std::function< void(commands::ItemStatus, google::protobuf::Any)> aItemHandler )

overrideprotectedvirtualinherited

Implements API_HANDLER_EDITOR.

Definition at line 344 of file api_handler_board.cpp.

References _, COMMIT::Add(), EDA_GROUP::AddItem(), KIID::AsStdString(), board(), COMMIT::Checkpoint(), BOARD_ITEM::CopyFrom(), CreateGeneratorForType(), createItemForType(), SERIALIZABLE::Deserialize(), ensureGeneratorTool(), EDA_GROUP::FinalizeGroupDeserialization(), kiapi::common::GeneratorTypeFromAny(), API_HANDLER_EDITOR::getCurrentCommit(), getDefaultContainer(), getItemById(), BOARD_ITEM::GetParent(), EDA_ITEM::GetParentGroup(), group, API_HANDLER_EDITOR::m_activeClients, COMMIT::Modify(), PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_DIMENSION_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GROUP_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TABLECELL_T, pushCurrentCommit(), RECURSE, regenerateGenerators(), COMMIT::Remove(), BOARD_ITEM::ResetUuid(), BOARD_COMMIT::RevertToCheckpoint(), PCB_TABLECELL::Serialize(), SERIALIZABLE::Serialize(), EDA_ITEM::SetParent(), EDA_ITEM::SetParentGroup(), table, EDA_ITEM::Type(), kiapi::common::TypeNameFromAny(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

handleCrossProbeAnnounce()

HANDLER_RESULT< CrossProbeAnnounceResponse > API_HANDLER_PCB::handleCrossProbeAnnounce ( const HANDLER_CONTEXT< commands::CrossProbeAnnounce > & aCtx )

private

Definition at line 2988 of file api_handler_pcb.cpp.

References CROSS_PROBE_CLIENT::RegisterPeer(), HANDLER_CONTEXT< RequestMessageType >::Request, and traceApi.

Referenced by API_HANDLER_PCB().

handleDeleteItems()

HANDLER_RESULT< DeleteItemsResponse > API_HANDLER_EDITOR::handleDeleteItems ( const HANDLER_CONTEXT< commands::DeleteItems > & aCtx )

protectedinherited

Definition at line 296 of file api_handler_editor.cpp.

References checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, deleteItemsInternal(), HANDLER_CONTEXT< RequestMessageType >::Request, result, and validateItemHeaderDocument().

Referenced by API_HANDLER_EDITOR().

handleDeleteVariant()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleDeleteVariant ( const HANDLER_CONTEXT< commands::DeleteVariant > & aCtx )

private

Definition at line 3156 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), frame(), BOARD_CONTEXT::GetBoard(), GetDefaultVariantName(), name, onModified(), pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, PCB_EDIT_FRAME::UpdateVariantSelectionCtrl(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleEndCommit()

HANDLER_RESULT< EndCommitResponse > API_HANDLER_EDITOR::handleEndCommit ( const HANDLER_CONTEXT< commands::EndCommit > & aCtx )

protectedinherited

Definition at line 88 of file api_handler_editor.cpp.

References checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, m_activeClients, m_commits, pushCurrentCommit(), HANDLER_CONTEXT< RequestMessageType >::Request, and validateItemHeaderDocument().

Referenced by API_HANDLER_EDITOR().

handleExpandTextVariables()

HANDLER_RESULT< ExpandTextVariablesResponse > API_HANDLER_BOARD::handleExpandTextVariables ( const HANDLER_CONTEXT< commands::ExpandTextVariables > & aCtx )

privateinherited

Definition at line 1231 of file api_handler_board.cpp.

References board(), ExpandEnvVarSubstitutions(), ExpandTextVars(), INTERNAL, HANDLER_CONTEXT< RequestMessageType >::Request, text, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

handleFlipItems()

HANDLER_RESULT< FlipItemsResponse > API_HANDLER_BOARD::handleFlipItems ( const HANDLER_CONTEXT< FlipItems > & aCtx )

privateinherited

Definition at line 1308 of file api_handler_board.cpp.

References _, API_HANDLER_EDITOR::checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, BOARD_ITEM::Flip(), FromProtoEnum(), API_HANDLER_EDITOR::getCurrentCommit(), getItemById(), EDA_ITEM::GetPosition(), API_HANDLER_EDITOR::m_activeClients, COMMIT::Modify(), BOARD_ITEM::Normalize(), 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_GENERATOR_T, PCB_GRID_ITEM_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_POINT_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, pushCurrentCommit(), RECURSE, HANDLER_CONTEXT< RequestMessageType >::Request, result, SERIALIZABLE::Serialize(), EDA_ITEM::Type(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_BOARD().

handleFocusOnItems()

HANDLER_RESULT< Empty > API_HANDLER_BOARD::handleFocusOnItems ( const HANDLER_CONTEXT< commands::FocusOnItems > & aCtx )

privateinherited

Definition at line 880 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), getItemById(), TOOL_MANAGER::GetTool(), kiapi::common::MakeResponseStatus(), HANDLER_CONTEXT< RequestMessageType >::Request, toolManager(), kiapi::common::UnpackDistance(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

handleGetActiveLayer()

HANDLER_RESULT< BoardLayerResponse > API_HANDLER_BOARD::handleGetActiveLayer ( const HANDLER_CONTEXT< GetActiveLayer > & aCtx )

privateinherited

Definition at line 1540 of file api_handler_board.cpp.

References checkForHeadless(), PCB_BASE_FRAME::GetActiveLayer(), API_HANDLER_EDITOR::m_frame, HANDLER_CONTEXT< RequestMessageType >::Request, ToProtoEnum(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

handleGetBoardBoundingBox()

HANDLER_RESULT< BoardBoundingBoxResponse > API_HANDLER_BOARD::handleGetBoardBoundingBox ( const HANDLER_CONTEXT< GetBoardBoundingBox > & aCtx )

privateinherited

Definition at line 1096 of file api_handler_board.cpp.

References board(), API_HANDLER_EDITOR::checkForBusy(), BOARD::ComputeBoundingBox(), BOARD::GetBoardEdgesBoundingBox(), kiapi::common::MakeResponseStatus(), kiapi::common::PackBox2(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

handleGetBoardDesignRules()

HANDLER_RESULT< BoardDesignRulesResponse > API_HANDLER_PCB::handleGetBoardDesignRules ( const HANDLER_CONTEXT< GetBoardDesignRules > & aCtx )

private

Definition at line 756 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), BOARD::GetDesignRulesPath(), BOARD::GetDesignSettings(), TEARDROP_PARAMETERS_LIST::GetParameters(), BOARD_DESIGN_SETTINGS::m_AllowSoldermaskBridgesInFPs, TEARDROP_PARAMETERS::m_AllowUseTwoTracks, TEARDROP_PARAMETERS::m_BestLengthRatio, TEARDROP_PARAMETERS::m_BestWidthRatio, BOARD_DESIGN_SETTINGS::m_CapVias, BOARD_DESIGN_SETTINGS::m_CopperEdgeClearance, BOARD_DESIGN_SETTINGS::m_CoverViasBack, BOARD_DESIGN_SETTINGS::m_CoverViasFront, TEARDROP_PARAMETERS::m_CurvedEdges, BOARD_DESIGN_SETTINGS::m_DiffPairDimensionsList, BOARD_DESIGN_SETTINGS::m_DrcExclusions, BOARD_DESIGN_SETTINGS::m_DRCSeverities, TEARDROP_PARAMETERS::m_Enabled, BOARD_DESIGN_SETTINGS::m_FillVias, BOARD_DESIGN_SETTINGS::m_HoleClearance, BOARD_DESIGN_SETTINGS::m_HoleToHoleMin, BOARD_DESIGN_SETTINGS::m_MicroViasMinDrill, BOARD_DESIGN_SETTINGS::m_MicroViasMinSize, BOARD_DESIGN_SETTINGS::m_MinClearance, BOARD_DESIGN_SETTINGS::m_MinConn, BOARD_DESIGN_SETTINGS::m_MinGrooveWidth, BOARD_DESIGN_SETTINGS::m_MinResolvedSpokes, BOARD_DESIGN_SETTINGS::m_MinSilkTextHeight, BOARD_DESIGN_SETTINGS::m_MinSilkTextThickness, BOARD_DESIGN_SETTINGS::m_MinThroughDrill, BOARD_DESIGN_SETTINGS::m_PlugViasBack, BOARD_DESIGN_SETTINGS::m_PlugViasFront, BOARD_DESIGN_SETTINGS::m_SilkClearance, BOARD_DESIGN_SETTINGS::m_SolderMaskExpansion, BOARD_DESIGN_SETTINGS::m_SolderMaskMinWidth, BOARD_DESIGN_SETTINGS::m_SolderMaskToCopperClearance, BOARD_DESIGN_SETTINGS::m_SolderPasteMargin, BOARD_DESIGN_SETTINGS::m_SolderPasteMarginRatio, TEARDROP_PARAMETERS_LIST::m_TargetPTHPads, TEARDROP_PARAMETERS_LIST::m_TargetSMDPads, TEARDROP_PARAMETERS_LIST::m_TargetTrack2Track, TEARDROP_PARAMETERS_LIST::m_TargetVias, TEARDROP_PARAMETERS::m_TdMaxLen, TEARDROP_PARAMETERS::m_TdMaxWidth, TEARDROP_PARAMETERS::m_TdOnPadsInZones, BOARD_DESIGN_SETTINGS::m_TeardropParamsList, BOARD_DESIGN_SETTINGS::m_TentViasBack, BOARD_DESIGN_SETTINGS::m_TentViasFront, BOARD_DESIGN_SETTINGS::m_TrackMinWidth, BOARD_DESIGN_SETTINGS::m_TrackWidthList, TEARDROP_PARAMETERS_LIST::m_UseRoundShapesOnly, BOARD_DESIGN_SETTINGS::m_ViasDimensionsList, BOARD_DESIGN_SETTINGS::m_ViasMinAnnularWidth, BOARD_DESIGN_SETTINGS::m_ViasMinSize, TEARDROP_PARAMETERS::m_WidthtoSizeFilterRatio, DRC_RULES_PARSER::Parse(), HANDLER_CONTEXT< RequestMessageType >::Request, TARGET_ROUND, TARGET_TRACK, DRC_EXCLUSION::ToProto(), ToProtoEnum(), API_HANDLER_EDITOR::validateDocument(), and via.

Referenced by API_HANDLER_PCB(), and handleSetBoardDesignRules().

handleGetBoardEditorAppearanceSettings()

HANDLER_RESULT< BoardEditorAppearanceSettings > API_HANDLER_PCB::handleGetBoardEditorAppearanceSettings ( const HANDLER_CONTEXT< GetBoardEditorAppearanceSettings > & aCtx )

private

Definition at line 1972 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::checkForHeadless(), frame(), PCB_BASE_FRAME::GetDisplayOptions(), PCB_BASE_FRAME::GetPcbNewSettings(), PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay, PCBNEW_SETTINGS::m_Display, PCB_DISPLAY_OPTIONS::m_NetColorMode, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_RatsnestMode, and ToProtoEnum().

Referenced by API_HANDLER_PCB().

handleGetBoardEnabledLayers()

HANDLER_RESULT< BoardEnabledLayersResponse > API_HANDLER_BOARD::handleGetBoardEnabledLayers ( const HANDLER_CONTEXT< GetBoardEnabledLayers > & aCtx )

privateinherited

Definition at line 985 of file api_handler_board.cpp.

References LSET::AllCuMask(), board(), kiapi::board::PackLayerSet(), HANDLER_CONTEXT< RequestMessageType >::Request, Rescue, BASE_SET::reset(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

handleGetBoardLayerByName()

HANDLER_RESULT< BoardLayerResponse > API_HANDLER_PCB::handleGetBoardLayerByName ( const HANDLER_CONTEXT< GetBoardLayerByName > & aCtx )

private

Definition at line 1405 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), BOARD::GetLayerID(), HANDLER_CONTEXT< RequestMessageType >::Request, ToProtoEnum(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleGetBoardLayerName()

HANDLER_RESULT< BoardLayerNameResponse > API_HANDLER_PCB::handleGetBoardLayerName ( const HANDLER_CONTEXT< GetBoardLayerName > & aCtx )

private

Definition at line 1386 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), FromProtoEnum(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleGetBoardOrigin()

HANDLER_RESULT< types::Vector2 > API_HANDLER_PCB::handleGetBoardOrigin ( const HANDLER_CONTEXT< GetBoardOrigin > & aCtx )

private

Definition at line 1274 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), BOARD_DESIGN_SETTINGS::GetAuxOrigin(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetGridOrigin(), kiapi::common::PackVector2(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleGetBoardPlotSettings()

HANDLER_RESULT< BoardPlotSettingsResponse > API_HANDLER_PCB::handleGetBoardPlotSettings ( const HANDLER_CONTEXT< GetBoardPlotSettings > & aCtx )

private

Definition at line 2033 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), PCB_PLOT_PARAMS::GetBlackAndWhite(), PCB_PLOT_PARAMS::GetCrossoutDNPFPsOnFabLayers(), PCB_PLOT_PARAMS::GetDrillMarksType(), PCB_PLOT_PARAMS::GetHideDNPFPsOnFabLayers(), PCB_PLOT_PARAMS::GetLayerSelection(), PCB_PLOT_PARAMS::GetMirror(), PCB_PLOT_PARAMS::GetNegative(), PCB_PLOT_PARAMS::GetPlotFrameRef(), PCB_PLOT_PARAMS::GetPlotOnAllLayersSequence(), BOARD::GetPlotOptions(), PCB_PLOT_PARAMS::GetPlotPadNumbers(), PCB_PLOT_PARAMS::GetPlotReference(), PCB_PLOT_PARAMS::GetPlotValue(), PCB_PLOT_PARAMS::GetScale(), PCB_PLOT_PARAMS::GetSketchDNPFPsOnFabLayers(), PCB_PLOT_PARAMS::GetSketchPadsOnFabLayers(), PCB_PLOT_PARAMS::GetSubtractMaskFromSilk(), PCB_PLOT_PARAMS::GetUseAuxOrigin(), kiapi::board::PackLayerSet(), HANDLER_CONTEXT< RequestMessageType >::Request, ToProtoEnum(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleGetBoundingBox()

HANDLER_RESULT< GetBoundingBoxResponse > API_HANDLER_BOARD::handleGetBoundingBox ( const HANDLER_CONTEXT< commands::GetBoundingBox > & aCtx )

privateinherited

Definition at line 1054 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), EDA_ITEM::GetBoundingBox(), getItemById(), kiapi::common::PackBox2(), PCB_FOOTPRINT_T, HANDLER_CONTEXT< RequestMessageType >::Request, EDA_ITEM::Type(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_BOARD().

handleGetConnectedItems()

HANDLER_RESULT< GetItemsResponse > API_HANDLER_PCB::handleGetConnectedItems ( const HANDLER_CONTEXT< GetConnectedItems > & aCtx )

private

Definition at line 1546 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), BOARD::GetConnectivity(), API_HANDLER_BOARD::getItemById(), API_HANDLER_BOARD::parseRequestedItemTypes(), HANDLER_CONTEXT< RequestMessageType >::Request, source, and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_PCB().

handleGetCurrentVariant()

HANDLER_RESULT< CurrentVariantResponse > API_HANDLER_PCB::handleGetCurrentVariant ( const HANDLER_CONTEXT< commands::GetCurrentVariant > & aCtx )

private

Definition at line 3370 of file api_handler_pcb.cpp.

References pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleGetCustomDesignRules()

HANDLER_RESULT< CustomRulesResponse > API_HANDLER_PCB::handleGetCustomDesignRules ( const HANDLER_CONTEXT< GetCustomDesignRules > & aCtx )

private

Definition at line 1087 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), DRC_RULE_LOADER::ExtractRuleComment(), DRC_RULE_LOADER::ExtractRuleText(), BOARD::GetDesignRulesPath(), LSET::NameToLayer(), DRC_RULES_PARSER::Parse(), PCB_LAYER_ID_COUNT, HANDLER_CONTEXT< RequestMessageType >::Request, text, DRC_CONSTRAINT::ToProto(), ToProtoEnum(), UNDEFINED_LAYER, UNSELECTED_LAYER, API_HANDLER_EDITOR::validateDocument(), and IO_ERROR::What().

Referenced by API_HANDLER_PCB(), and handleSetCustomDesignRules().

handleGetDocumentModifiedState()

HANDLER_RESULT< GetDocumentModifiedStateResponse > API_HANDLER_PCB::handleGetDocumentModifiedState ( const HANDLER_CONTEXT< commands::GetDocumentModifiedState > & aCtx )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1491 of file api_handler_pcb.cpp.

References pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

handleGetEmbeddedFiles()

HANDLER_RESULT< common::types::EmbeddedFiles > API_HANDLER_PCB::handleGetEmbeddedFiles ( const HANDLER_CONTEXT< GetEmbeddedFiles > & aCtx )

private

Definition at line 685 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), kiapi::board::PackEmbeddedFiles(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleGetGraphicsDefaults()

HANDLER_RESULT< GraphicsDefaultsResponse > API_HANDLER_BOARD::handleGetGraphicsDefaults ( const HANDLER_CONTEXT< GetGraphicsDefaults > & aCtx )

privateinherited

Definition at line 1014 of file api_handler_board.cpp.

References board(), BOARD::GetDesignSettings(), LAYER_CLASS_COUNT, BOARD_DESIGN_SETTINGS::m_LineThickness, BOARD_DESIGN_SETTINGS::m_TextItalic, BOARD_DESIGN_SETTINGS::m_TextSize, BOARD_DESIGN_SETTINGS::m_TextThickness, BOARD_DESIGN_SETTINGS::m_TextUpright, HANDLER_CONTEXT< RequestMessageType >::Request, text, API_HANDLER_EDITOR::validateDocument(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by API_HANDLER_BOARD().

handleGetItems()

HANDLER_RESULT< GetItemsResponse > API_HANDLER_PCB::handleGetItems ( const HANDLER_CONTEXT< commands::GetItems > & aCtx )

private

Definition at line 490 of file api_handler_pcb.cpp.

References BaseType(), API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), API_HANDLER_BOARD::parseRequestedItemTypes(), PCB_3D_BODY_T, PCB_ARC_T, PCB_BARCODE_T, PCB_CONSTRAINT_T, PCB_DIMENSION_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GRID_ITEM_T, PCB_GROUP_T, PCB_PAD_T, PCB_POINT_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, HANDLER_CONTEXT< RequestMessageType >::Request, s_allowedBoardTypes, and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_PCB().

handleGetItemsById()

HANDLER_RESULT< GetItemsResponse > API_HANDLER_BOARD::handleGetItemsById ( const HANDLER_CONTEXT< commands::GetItemsById > & aCtx )

privateinherited

Definition at line 727 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), getItemById(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_BOARD().

handleGetItemsByNet()

HANDLER_RESULT< GetItemsResponse > API_HANDLER_PCB::handleGetItemsByNet ( const HANDLER_CONTEXT< GetItemsByNet > & aCtx )

private

Definition at line 1613 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), NETINFO_ITEM::GetNetCode(), NETINFO_LIST::GetNetItem(), API_HANDLER_BOARD::parseRequestedItemTypes(), PCB_ARC_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_PCB().

handleGetItemsByNetClass()

HANDLER_RESULT< GetItemsResponse > API_HANDLER_PCB::handleGetItemsByNetClass ( const HANDLER_CONTEXT< GetItemsByNetClass > & aCtx )

private

Definition at line 1668 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), NETCLASS::ContainsNetclassWithName(), filter, API_HANDLER_BOARD::parseRequestedItemTypes(), PCB_ARC_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_PCB().

handleGetNetClassForNets()

HANDLER_RESULT< NetClassForNetsResponse > API_HANDLER_PCB::handleGetNetClassForNets ( const HANDLER_CONTEXT< GetNetClassForNets > & aCtx )

private

Definition at line 1746 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), NETINFO_ITEM::GetNetClass(), NETINFO_LIST::GetNetItem(), HANDLER_CONTEXT< RequestMessageType >::Request, and NETCLASS::Serialize().

Referenced by API_HANDLER_PCB().

handleGetNets()

HANDLER_RESULT< NetsResponse > API_HANDLER_PCB::handleGetNets ( const HANDLER_CONTEXT< GetNets > & aCtx )

private

Definition at line 1503 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), NETCLASS::ContainsNetclassWithName(), filter, HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleGetOpenDocuments()

HANDLER_RESULT< GetOpenDocumentsResponse > API_HANDLER_PCB::handleGetOpenDocuments ( const HANDLER_CONTEXT< commands::GetOpenDocuments > & aCtx )

private

Definition at line 234 of file api_handler_pcb.cpp.

References pcbContext(), API_HANDLER_BOARD::project(), HANDLER_CONTEXT< RequestMessageType >::Request, and ToStdString().

Referenced by API_HANDLER_PCB().

handleGetPadShapeAsPolygon()

HANDLER_RESULT< PadShapeAsPolygonResponse > API_HANDLER_BOARD::handleGetPadShapeAsPolygon ( const HANDLER_CONTEXT< GetPadShapeAsPolygon > & aCtx )

privateinherited

Definition at line 1122 of file api_handler_board.cpp.

References SHAPE_POLY_SET::COutline(), ERROR_INSIDE, FromProtoEnum(), getItemById(), kiapi::common::PackPolyLine(), pad, PCB_PAD_T, HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

handleGetPageSettings()

HANDLER_RESULT< types::PageSettings > API_HANDLER_EDITOR::handleGetPageSettings ( const HANDLER_CONTEXT< commands::GetPageSettings > & aCtx )

protectedinherited

Definition at line 506 of file api_handler_editor.cpp.

References getDrawingSheetFileName(), getPageSettings(), PAGE_INFO::GetSizeIU(), PAGE_INFO::GetType(), PAGE_INFO::IsCustom(), PAGE_INFO::IsPortrait(), kiapi::common::PackVector2(), pcbIUScale, HANDLER_CONTEXT< RequestMessageType >::Request, ToProtoEnum(), and validateDocument().

Referenced by API_HANDLER_PCB::API_HANDLER_PCB(), and API_HANDLER_SCH::API_HANDLER_SCH().

handleGetSelection()

HANDLER_RESULT< SelectionResponse > API_HANDLER_BOARD::handleGetSelection ( const HANDLER_CONTEXT< commands::GetSelection > & aCtx )

privateinherited

Definition at line 770 of file api_handler_board.cpp.

References checkForHeadless(), filter, PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), parseRequestedItemTypes(), PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_DIMENSION_T, HANDLER_CONTEXT< RequestMessageType >::Request, toolManager(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_BOARD().

handleGetStackup()

HANDLER_RESULT< BoardStackupResponse > API_HANDLER_BOARD::handleGetStackup ( const HANDLER_CONTEXT< GetBoardStackup > & aCtx )

privateinherited

Definition at line 969 of file api_handler_board.cpp.

References board(), kiapi::board::PackBoardStackup(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

handleGetTitleBlockInfo()

HANDLER_RESULT< types::TitleBlockInfo > API_HANDLER_EDITOR::handleGetTitleBlockInfo ( const HANDLER_CONTEXT< commands::GetTitleBlockInfo > & aCtx )

protectedinherited

Definition at line 417 of file api_handler_editor.cpp.

References TITLE_BLOCK::GetComment(), TITLE_BLOCK::GetCompany(), TITLE_BLOCK::GetDate(), TITLE_BLOCK::GetRevision(), TITLE_BLOCK::GetTitle(), getTitleBlock(), HANDLER_CONTEXT< RequestMessageType >::Request, and validateDocument().

Referenced by API_HANDLER_EDITOR().

handleGetVariants()

HANDLER_RESULT< VariantsResponse > API_HANDLER_PCB::handleGetVariants ( const HANDLER_CONTEXT< commands::GetVariants > & aCtx )

private

Definition at line 3090 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), BOARD_ITEM::CopyFrom(), BOARD_CONTEXT::GetBoard(), name, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleGetVisibleLayers()

HANDLER_RESULT< BoardLayers > API_HANDLER_BOARD::handleGetVisibleLayers ( const HANDLER_CONTEXT< GetVisibleLayers > & aCtx )

privateinherited

Definition at line 1484 of file api_handler_board.cpp.

References board(), checkForHeadless(), HANDLER_CONTEXT< RequestMessageType >::Request, ToProtoEnum(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

handleHighlightNets()

HANDLER_RESULT< HighlightNetsResponse > API_HANDLER_PCB::handleHighlightNets ( const HANDLER_CONTEXT< commands::HighlightNets > & aCtx )

private

Definition at line 3058 of file api_handler_pcb.cpp.

References CROSS_PROBING_SETTINGS::auto_highlight, API_HANDLER_BOARD::checkForHeadless(), HANDLER_CONTEXT< RequestMessageType >::ClientName, frame(), PCB_BASE_FRAME::GetPcbNewSettings(), PCB_EDIT_FRAME::HandleRemoteNetHighlight(), kiapi::common::KiwayClientName, APP_SETTINGS_BASE::m_CrossProbing, name, HANDLER_CONTEXT< RequestMessageType >::Request, and kiapi::common::StandaloneCrossProbeClientName.

Referenced by API_HANDLER_PCB().

handleHitTest()

HANDLER_RESULT< HitTestResponse > API_HANDLER_EDITOR::handleHitTest ( const HANDLER_CONTEXT< commands::HitTest > & aCtx )

protectedinherited

Definition at line 345 of file api_handler_editor.cpp.

References checkForBusy(), getItemFromDocument(), getIuScale(), HANDLER_CONTEXT< RequestMessageType >::Request, scale, kiapi::common::UnpackVector2(), and validateItemHeaderDocument().

Referenced by API_HANDLER_EDITOR().

handleImportNetlist()

HANDLER_RESULT< ImportNetlistResponse > API_HANDLER_PCB::handleImportNetlist ( const HANDLER_CONTEXT< ImportNetlist > & aCtx )

private

Definition at line 1857 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), PCB_CONTEXT::MakeNetlistUpdater(), netlist, PCB_CONTEXT::OnNetlistChanged(), pcbContext(), API_HANDLER_BOARD::project(), PCB_CONTEXT::ReadNetlistFromFile(), reporter, HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleImportSpecctraSession()

HANDLER_RESULT< ImportSpecctraSessionResponse > API_HANDLER_PCB::handleImportSpecctraSession ( const HANDLER_CONTEXT< ImportSpecctraSession > & aCtx )

private

Definition at line 1924 of file api_handler_pcb.cpp.

References _, API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, API_HANDLER_EDITOR::getCurrentCommit(), DSN::ImportSpecctraSession(), API_HANDLER_EDITOR::m_activeClients, API_HANDLER_BOARD::project(), API_HANDLER_BOARD::pushCurrentCommit(), reporter, HANDLER_CONTEXT< RequestMessageType >::Request, BOARD_COMMIT::Revert(), API_HANDLER_EDITOR::validateDocument(), and IO_ERROR::What().

Referenced by API_HANDLER_PCB().

handleInjectDrcError()

HANDLER_RESULT< InjectDrcErrorResponse > API_HANDLER_PCB::handleInjectDrcError ( const HANDLER_CONTEXT< InjectDrcError > & aCtx )

private

Definition at line 2132 of file api_handler_pcb.cpp.

References _, COMMIT::Add(), KIID::AsStdString(), API_HANDLER_EDITOR::checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, DRC_ITEM::Create(), DRCE_GENERIC_ERROR, DRCE_GENERIC_WARNING, FromProtoEnum(), API_HANDLER_EDITOR::getCurrentCommit(), PCB_MARKER::GetUUID(), LAYER_DRC_ERROR, LAYER_DRC_WARNING, API_HANDLER_EDITOR::m_activeClients, API_HANDLER_BOARD::pushCurrentCommit(), HANDLER_CONTEXT< RequestMessageType >::Request, RPT_SEVERITY_WARNING, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleInteractiveMoveItems()

HANDLER_RESULT< Empty > API_HANDLER_BOARD::handleInteractiveMoveItems ( const HANDLER_CONTEXT< InteractiveMoveItems > & aCtx )

privateinherited

Definition at line 1263 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), HANDLER_CONTEXT< RequestMessageType >::ClientName, API_HANDLER_EDITOR::getCurrentCommit(), getItemById(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), PCB_ACTIONS::move, TOOL_MANAGER::PostAPIAction(), HANDLER_CONTEXT< RequestMessageType >::Request, TOOL_MANAGER::RunAction(), ACTIONS::selectionClear, ACTIONS::selectItems, SELECTION::SetReferencePoint(), toolManager(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

handleParseAndCreateItemsFromString()

HANDLER_RESULT< CreateItemsResponse > API_HANDLER_BOARD::handleParseAndCreateItemsFromString ( const HANDLER_CONTEXT< commands::ParseAndCreateItemsFromString > & aCtx )

privateinherited

Definition at line 1468 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

handlePlaceFootprintFromLibrary()

HANDLER_RESULT< PlaceFromLibraryResponse > API_HANDLER_PCB::handlePlaceFootprintFromLibrary ( const HANDLER_CONTEXT< kiapi::board::commands::PlaceFootprintFromLibrary > & aCtx )

private

Definition at line 3385 of file api_handler_pcb.cpp.

References _, COMMIT::Add(), API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, F_Cu, LIB_ID::Format(), FromProtoEnum(), API_HANDLER_EDITOR::getCurrentCommit(), IsExternalCopperLayer(), LIB_ID::IsValid(), LoadFootprintFromProject(), API_HANDLER_EDITOR::m_activeClients, API_HANDLER_BOARD::pushCurrentCommit(), RECURSE, HANDLER_CONTEXT< RequestMessageType >::Request, BOARD_ITEM::ResetUuid(), FOOTPRINT::Serialize(), UNDEFINED_LAYER, kiapi::common::UnpackLibId(), kiapi::common::UnpackVector2(), API_HANDLER_EDITOR::validateItemHeaderDocument(), and UTF8::wx_str().

Referenced by API_HANDLER_PCB().

handleRefillZones()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleRefillZones ( const HANDLER_CONTEXT< RefillZones > & aCtx )

private

Definition at line 1769 of file api_handler_pcb.cpp.

References _, API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), alg::contains(), API_HANDLER_BOARD::createCommit(), ZONE_FILLER::Fill(), TOOL_MANAGER::FindTool(), frame(), ZONE::GetIsRuleArea(), API_HANDLER_BOARD::getItemById(), TOOL_MANAGER::GetTool(), onModified(), PCB_ZONE_T, TOOL_MANAGER::RegisterTool(), HANDLER_CONTEXT< RequestMessageType >::Request, TOOL_MANAGER::RunAction(), SKIP_CONNECTIVITY, API_HANDLER_BOARD::toolManager(), API_HANDLER_EDITOR::validateDocument(), ZONE_FILL_OP, ZONE_FILLER_TOOL_NAME, and PCB_ACTIONS::zoneFillAll.

Referenced by API_HANDLER_PCB().

handleRemoveFromSelection()

HANDLER_RESULT< SelectionResponse > API_HANDLER_BOARD::handleRemoveFromSelection ( const HANDLER_CONTEXT< commands::RemoveFromSelection > & aCtx )

privateinherited

Definition at line 929 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), getItemById(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), API_HANDLER_EDITOR::m_frame, SELECTION_TOOL::RemoveItemsFromSel(), HANDLER_CONTEXT< RequestMessageType >::Request, toolManager(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_BOARD().

handleRenameVariant()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleRenameVariant ( const HANDLER_CONTEXT< commands::RenameVariant > & aCtx )

private

Definition at line 3195 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), frame(), BOARD_CONTEXT::GetBoard(), GetDefaultVariantName(), onModified(), pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, PCB_EDIT_FRAME::UpdateVariantSelectionCtrl(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleRevertDocument()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleRevertDocument ( const HANDLER_CONTEXT< commands::RevertDocument > & aCtx )

private

Definition at line 410 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), API_HANDLER_EDITOR::m_commits, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleRunAction()

HANDLER_RESULT< RunActionResponse > API_HANDLER_BOARD::handleRunAction ( const HANDLER_CONTEXT< commands::RunAction > & aCtx )

privateinherited

Definition at line 707 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), HANDLER_CONTEXT< RequestMessageType >::Request, and toolManager().

Referenced by API_HANDLER_BOARD().

handleRunBoardJobExport3D()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExport3D ( const HANDLER_CONTEXT< RunBoardJobExport3D > & aCtx )

private

Definition at line 2306 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_3D::m_3dparams, EXPORTER_STEP_PARAMS::m_BoardOnly, EXPORTER_STEP_PARAMS::m_BoardOutlinesChainingEpsilon, EXPORTER_STEP_PARAMS::m_ComponentFilter, EXPORTER_STEP_PARAMS::m_CutViasInBody, EXPORTER_STEP_PARAMS::m_ExportBoardBody, EXPORTER_STEP_PARAMS::m_ExportComponents, EXPORTER_STEP_PARAMS::m_ExportInnerCopper, EXPORTER_STEP_PARAMS::m_ExportPads, EXPORTER_STEP_PARAMS::m_ExportSilkscreen, EXPORTER_STEP_PARAMS::m_ExportSoldermask, EXPORTER_STEP_PARAMS::m_ExportTracksVias, EXPORTER_STEP_PARAMS::m_ExportZones, EXPORTER_STEP_PARAMS::m_ExtraPadThickness, JOB_EXPORT_PCB_3D::m_filename, EXPORTER_STEP_PARAMS::m_FillAllVias, JOB_EXPORT_PCB_3D::m_format, EXPORTER_STEP_PARAMS::m_FuseShapes, JOB_EXPORT_PCB_3D::m_hasUserOrigin, EXPORTER_STEP_PARAMS::m_IncludeDNP, EXPORTER_STEP_PARAMS::m_IncludeUnspecified, EXPORTER_STEP_PARAMS::m_NetFilter, EXPORTER_STEP_PARAMS::m_OptimizeStep, EXPORTER_STEP_PARAMS::m_Origin, EXPORTER_STEP_PARAMS::m_Overwrite, EXPORTER_STEP_PARAMS::m_SubstModels, EXPORTER_STEP_PARAMS::m_UseDefinedOrigin, EXPORTER_STEP_PARAMS::m_UseDrillOrigin, EXPORTER_STEP_PARAMS::m_UseGridOrigin, EXPORTER_STEP_PARAMS::m_UsePcbCenterOrigin, JOB_EXPORT_PCB_3D::m_variant, JOB_EXPORT_PCB_3D::m_vrmlModelDir, JOB_EXPORT_PCB_3D::m_vrmlRelativePaths, JOB_EXPORT_PCB_3D::m_vrmlUnits, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportDrill()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportDrill ( const HANDLER_CONTEXT< RunBoardJobExportDrill > & aCtx )

private

Definition at line 2629 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_DRILL::m_drillOrigin, JOB_EXPORT_PCB_DRILL::m_drillUnits, JOB_EXPORT_PCB_DRILL::m_excellonCombinePTHNPTH, JOB_EXPORT_PCB_DRILL::m_excellonMinimalHeader, JOB_EXPORT_PCB_DRILL::m_excellonMirrorY, JOB_EXPORT_PCB_DRILL::m_excellonOvalDrillRoute, JOB_EXPORT_PCB_DRILL::m_filename, JOB_EXPORT_PCB_DRILL::m_format, JOB_EXPORT_PCB_DRILL::m_generateMap, JOB_EXPORT_PCB_DRILL::m_generateReport, JOB_EXPORT_PCB_DRILL::m_generateTenting, JOB_EXPORT_PCB_DRILL::m_gerberPrecision, JOB_EXPORT_PCB_DRILL::m_mapFormat, JOB_EXPORT_PCB_DRILL::m_reportPath, JOB_EXPORT_PCB_DRILL::m_zeroFormat, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), API_HANDLER_EDITOR::validateDocument(), and ValidateUnitsInchMm().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportDxf()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportDxf ( const HANDLER_CONTEXT< RunBoardJobExportDxf > & aCtx )

private

Definition at line 2441 of file api_handler_pcb.cpp.

References ApplyBoardPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_DXF::m_dxfUnits, JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_DXF::m_genMode, JOB_EXPORT_PCB_DXF::m_plotGraphicItemsUsingContours, JOB_EXPORT_PCB_DXF::m_polygonMode, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), API_HANDLER_EDITOR::validateDocument(), ValidatePaginationModeForSingleOrPerFile(), and ValidateUnitsInchMm().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportGencad()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportGencad ( const HANDLER_CONTEXT< RunBoardJobExportGencad > & aCtx )

private

Definition at line 2737 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_GENCAD::m_filename, JOB_EXPORT_PCB_GENCAD::m_flipBottomPads, JOB_EXPORT_PCB_GENCAD::m_storeOriginCoords, JOB_EXPORT_PCB_GENCAD::m_useDrillOrigin, JOB_EXPORT_PCB_GENCAD::m_useIndividualShapes, JOB_EXPORT_PCB_GENCAD::m_useUniquePins, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportGerbers()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportGerbers ( const HANDLER_CONTEXT< RunBoardJobExportGerbers > & aCtx )

private

Definition at line 2591 of file api_handler_pcb.cpp.

References ApplyBoardPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_GERBERS::m_createJobsFile, JOB_EXPORT_PCB_GERBER::m_disableApertureMacros, JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_GERBER::m_includeNetlistAttributes, JOB_EXPORT_PCB_GERBER::m_precision, JOB_EXPORT_PCB_GERBERS::m_useBoardPlotParams, JOB_EXPORT_PCB_GERBER::m_useProtelFileExtension, JOB_EXPORT_PCB_GERBER::m_useX2Format, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportIdf()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportIdf ( const HANDLER_CONTEXT< RunBoardJobExportIdf > & aCtx )

private

Definition at line 2937 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_IDF::m_calculateHeightFromModels, JOB_EXPORT_PCB_IDF::m_filename, JOB_EXPORT_PCB_IDF::m_includeDNP, JOB_EXPORT_PCB_IDF::m_includeUnspecified, JOB_EXPORT_PCB_IDF::m_originMode, JOB_EXPORT_PCB_IDF::m_partNumberField, JOB_EXPORT_PCB_IDF::m_units, JOB_EXPORT_PCB_IDF::m_userOrigin, IDF_SETTINGS::MM, pcbContext(), pcbIUScale, HANDLER_CONTEXT< RequestMessageType >::Request, scale, JOB::SetConfiguredOutputPath(), kiapi::common::UnpackVector2(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportIpc2581()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportIpc2581 ( const HANDLER_CONTEXT< RunBoardJobExportIpc2581 > & aCtx )

private

Definition at line 2777 of file api_handler_pcb.cpp.

References ApplyFabExportContent(), API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_IPC2581::m_bomRev, JOB_EXPORT_PCB_FAB::m_checkZonesBeforeExport, JOB_EXPORT_PCB_IPC2581::m_colDist, JOB_EXPORT_PCB_IPC2581::m_colDistPn, JOB_EXPORT_PCB_IPC2581::m_colInternalId, JOB_EXPORT_PCB_IPC2581::m_colMfg, JOB_EXPORT_PCB_FAB::m_colMfgPn, JOB_EXPORT_PCB_IPC2581::m_compress, JOB_EXPORT_PCB_FAB::m_drawingSheet, JOB_EXPORT_PCB_FAB::m_filename, JOB_EXPORT_PCB_FAB::m_precision, JOB_EXPORT_PCB_IPC2581::m_refDes, JOB_EXPORT_PCB_FAB::m_units, JOB_EXPORT_PCB_FAB::m_variantNames, JOB_EXPORT_PCB_IPC2581::m_version, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), API_HANDLER_EDITOR::validateDocument(), and ValidateUnitsInchMm().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportIpcD356()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportIpcD356 ( const HANDLER_CONTEXT< RunBoardJobExportIpcD356 > & aCtx )

private

Definition at line 2823 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_IPCD356::m_filename, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportODB()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportODB ( const HANDLER_CONTEXT< RunBoardJobExportODB > & aCtx )

private

Definition at line 2880 of file api_handler_pcb.cpp.

References ApplyOdbJobRequest(), API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_FAB::m_filename, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), API_HANDLER_EDITOR::validateDocument(), and ValidateUnitsInchMm().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportPdf()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportPdf ( const HANDLER_CONTEXT< RunBoardJobExportPdf > & aCtx )

private

Definition at line 2481 of file api_handler_pcb.cpp.

References ApplyBoardPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_PDF::m_pdfBackFPPropertyPopups, JOB_EXPORT_PCB_PDF::m_pdfBackgroundColor, JOB_EXPORT_PCB_PDF::m_pdfFrontFPPropertyPopups, JOB_EXPORT_PCB_PDF::m_pdfGenMode, JOB_EXPORT_PCB_PDF::m_pdfMetadata, JOB_EXPORT_PCB_PDF::m_pdfSingle, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportPng()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportPng ( const HANDLER_CONTEXT< RunBoardJobExportPng > & aCtx )

private

Definition at line 2545 of file api_handler_pcb.cpp.

References ApplyBoardPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_PNG::m_antialias, JOB_EXPORT_PCB_PNG::m_dpi, JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_PNG::m_genMode, JOB_EXPORT_PCB_PNG::m_useBackgroundColor, MAX_PNG_DPI, MIN_PNG_DPI, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), API_HANDLER_EDITOR::validateDocument(), and ValidatePaginationModeForSingleOrPerFile().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportPosition()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportPosition ( const HANDLER_CONTEXT< RunBoardJobExportPosition > & aCtx )

private

Definition at line 2694 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_POS::m_excludeBOM, JOB_EXPORT_PCB_POS::m_excludeDNP, JOB_EXPORT_PCB_POS::m_excludeFootprintsWithTh, JOB_EXPORT_PCB_POS::m_filename, JOB_EXPORT_PCB_POS::m_format, JOB_EXPORT_PCB_POS::m_gerberBoardEdge, JOB_EXPORT_PCB_POS::m_nakedFilename, JOB_EXPORT_PCB_POS::m_negateBottomX, JOB_EXPORT_PCB_POS::m_side, JOB_EXPORT_PCB_POS::m_singleFile, JOB_EXPORT_PCB_POS::m_smdOnly, JOB_EXPORT_PCB_POS::m_units, JOB_EXPORT_PCB_POS::m_useDrillPlaceFileOrigin, JOB_EXPORT_PCB_POS::m_variant, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), API_HANDLER_EDITOR::validateDocument(), and ValidateUnitsInchMm().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportPs()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportPs ( const HANDLER_CONTEXT< RunBoardJobExportPs > & aCtx )

private

Definition at line 2509 of file api_handler_pcb.cpp.

References ApplyBoardPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_PS::m_forceA4, JOB_EXPORT_PCB_PS::m_genMode, JOB_EXPORT_PCB_PS::m_trackWidthCorrection, JOB_EXPORT_PCB_PS::m_useGlobalSettings, JOB_EXPORT_PCB_PS::m_XScaleAdjust, JOB_EXPORT_PCB_PS::m_YScaleAdjust, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), API_HANDLER_EDITOR::validateDocument(), and ValidatePaginationModeForSingleOrPerFile().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportRender()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportRender ( const HANDLER_CONTEXT< RunBoardJobExportRender > & aCtx )

private

Definition at line 2363 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_CONTEXT::GetCurrentFileName(), JOB_PCB_RENDER::m_antiAlias, JOB_PCB_RENDER::m_appearancePreset, JOB_PCB_RENDER::m_bgStyle, JOB_PCB_RENDER::m_filename, JOB_PCB_RENDER::m_floor, JOB_PCB_RENDER::m_format, JOB_PCB_RENDER::m_height, JOB_PCB_RENDER::m_lightBottomIntensity, JOB_PCB_RENDER::m_lightCameraIntensity, JOB_PCB_RENDER::m_lightSideElevation, JOB_PCB_RENDER::m_lightSideIntensity, JOB_PCB_RENDER::m_lightTopIntensity, JOB_PCB_RENDER::m_pan, JOB_PCB_RENDER::m_perspective, JOB_PCB_RENDER::m_pivot, JOB_PCB_RENDER::m_postProcess, JOB_PCB_RENDER::m_proceduralTextures, JOB_PCB_RENDER::m_quality, JOB_PCB_RENDER::m_rotation, JOB_PCB_RENDER::m_side, JOB_PCB_RENDER::m_useBoardStackupColors, JOB_PCB_RENDER::m_width, JOB_PCB_RENDER::m_zoom, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), kiapi::common::UnpackVector3D(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportSpecctraDsn()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportSpecctraDsn ( const HANDLER_CONTEXT< RunBoardJobExportSpecctraDsn > & aCtx )

private

Definition at line 2760 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_SPECCTRA_DSN::m_filename, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportStats()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportStats ( const HANDLER_CONTEXT< RunBoardJobExportStats > & aCtx )

private

Definition at line 2905 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_STATS::m_excludeFootprintsWithoutPads, JOB_EXPORT_PCB_STATS::m_filename, JOB_EXPORT_PCB_STATS::m_format, JOB_EXPORT_PCB_STATS::m_subtractHolesFromBoardArea, JOB_EXPORT_PCB_STATS::m_subtractHolesFromCopperAreas, JOB_EXPORT_PCB_STATS::m_units, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), API_HANDLER_EDITOR::validateDocument(), and ValidateUnitsInchMm().

Referenced by API_HANDLER_PCB().

handleRunBoardJobExportSvg()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_PCB::handleRunBoardJobExportSvg ( const HANDLER_CONTEXT< RunBoardJobExportSvg > & aCtx )

private

Definition at line 2409 of file api_handler_pcb.cpp.

References ApplyBoardPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_SVG::m_fitPageToBoard, JOB_EXPORT_PCB_SVG::m_genMode, JOB_EXPORT_PCB_SVG::m_precision, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), API_HANDLER_EDITOR::validateDocument(), and ValidatePaginationModeForSingleOrPerFile().

Referenced by API_HANDLER_PCB().

handleSaveCopyOfDocument()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleSaveCopyOfDocument ( const HANDLER_CONTEXT< commands::SaveCopyOfDocument > & aCtx )

private

Definition at line 338 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), BOARD::GetFileName(), FILEEXT::KiCadPcbFileExtension, pcbContext(), API_HANDLER_BOARD::project(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleSaveDocument()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleSaveDocument ( const HANDLER_CONTEXT< commands::SaveDocument > & aCtx )

private

Definition at line 261 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleSaveDocumentAs()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleSaveDocumentAs ( const HANDLER_CONTEXT< commands::SaveDocumentAs > & aCtx )

private

Definition at line 290 of file api_handler_pcb.cpp.

References API_HANDLER::apiServer(), API_HANDLER_EDITOR::checkForBusy(), FILEEXT::KiCadPcbFileExtension, pcbContext(), Pgm(), HANDLER_CONTEXT< RequestMessageType >::Request, thisDocumentType(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleSaveDocumentToString()

HANDLER_RESULT< SavedDocumentResponse > API_HANDLER_BOARD::handleSaveDocumentToString ( const HANDLER_CONTEXT< commands::SaveDocumentToString > & aCtx )

privateinherited

Definition at line 1418 of file api_handler_board.cpp.

References board(), HANDLER_CONTEXT< RequestMessageType >::Request, CLIPBOARD_IO::SaveBoard(), CLIPBOARD_IO::SetWriter(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

handleSaveSelectionToString()

HANDLER_RESULT< SavedSelectionResponse > API_HANDLER_BOARD::handleSaveSelectionToString ( const HANDLER_CONTEXT< commands::SaveSelectionToString > & aCtx )

privateinherited

Definition at line 1442 of file api_handler_board.cpp.

References board(), checkForHeadless(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), CLIPBOARD_IO::SaveSelection(), CLIPBOARD_IO::SetBoard(), CLIPBOARD_IO::SetWriter(), API_HANDLER_EDITOR::thisDocumentType(), and toolManager().

Referenced by API_HANDLER_BOARD().

handleSetActiveLayer()

HANDLER_RESULT< Empty > API_HANDLER_BOARD::handleSetActiveLayer ( const HANDLER_CONTEXT< SetActiveLayer > & aCtx )

privateinherited

Definition at line 1561 of file api_handler_board.cpp.

References board(), API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), FromProtoEnum(), API_HANDLER_EDITOR::m_frame, HANDLER_CONTEXT< RequestMessageType >::Request, PCB_BASE_FRAME::SetActiveLayer(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

handleSetBoardDesignRules()

HANDLER_RESULT< BoardDesignRulesResponse > API_HANDLER_PCB::handleSetBoardDesignRules ( const HANDLER_CONTEXT< SetBoardDesignRules > & aCtx )

private

Definition at line 901 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), HANDLER_CONTEXT< RequestMessageType >::ClientName, BOARD_DESIGN_SETTINGS::VALIDATION_ERROR::error_message, DRC_EXCLUSION::FromProto(), FromProtoEnum(), TEARDROP_PARAMETERS_LIST::GetParameters(), handleGetBoardDesignRules(), BOARD_DESIGN_SETTINGS::m_AllowSoldermaskBridgesInFPs, TEARDROP_PARAMETERS::m_AllowUseTwoTracks, TEARDROP_PARAMETERS::m_BestLengthRatio, TEARDROP_PARAMETERS::m_BestWidthRatio, BOARD_DESIGN_SETTINGS::m_CapVias, BOARD_DESIGN_SETTINGS::m_CopperEdgeClearance, BOARD_DESIGN_SETTINGS::m_CoverViasBack, BOARD_DESIGN_SETTINGS::m_CoverViasFront, TEARDROP_PARAMETERS::m_CurvedEdges, BOARD_DESIGN_SETTINGS::m_DiffPairDimensionsList, BOARD_DESIGN_SETTINGS::m_DrcExclusions, BOARD_DESIGN_SETTINGS::m_DRCSeverities, TEARDROP_PARAMETERS::m_Enabled, BOARD_DESIGN_SETTINGS::m_FillVias, BOARD_DESIGN_SETTINGS::m_HoleClearance, BOARD_DESIGN_SETTINGS::m_HoleToHoleMin, BOARD_DESIGN_SETTINGS::m_MicroViasMinDrill, BOARD_DESIGN_SETTINGS::m_MicroViasMinSize, BOARD_DESIGN_SETTINGS::m_MinClearance, BOARD_DESIGN_SETTINGS::m_MinConn, BOARD_DESIGN_SETTINGS::m_MinGrooveWidth, BOARD_DESIGN_SETTINGS::m_MinResolvedSpokes, BOARD_DESIGN_SETTINGS::m_MinSilkTextHeight, BOARD_DESIGN_SETTINGS::m_MinSilkTextThickness, BOARD_DESIGN_SETTINGS::m_MinThroughDrill, BOARD_DESIGN_SETTINGS::m_PlugViasBack, BOARD_DESIGN_SETTINGS::m_PlugViasFront, BOARD_DESIGN_SETTINGS::m_SilkClearance, BOARD_DESIGN_SETTINGS::m_SolderMaskExpansion, BOARD_DESIGN_SETTINGS::m_SolderMaskMinWidth, BOARD_DESIGN_SETTINGS::m_SolderMaskToCopperClearance, BOARD_DESIGN_SETTINGS::m_SolderPasteMargin, BOARD_DESIGN_SETTINGS::m_SolderPasteMarginRatio, TEARDROP_PARAMETERS_LIST::m_TargetPTHPads, TEARDROP_PARAMETERS_LIST::m_TargetSMDPads, TEARDROP_PARAMETERS_LIST::m_TargetTrack2Track, TEARDROP_PARAMETERS_LIST::m_TargetVias, TEARDROP_PARAMETERS::m_TdMaxLen, TEARDROP_PARAMETERS::m_TdMaxWidth, TEARDROP_PARAMETERS::m_TdOnPadsInZones, BOARD_DESIGN_SETTINGS::m_TeardropParamsList, BOARD_DESIGN_SETTINGS::m_TentViasBack, BOARD_DESIGN_SETTINGS::m_TentViasFront, BOARD_DESIGN_SETTINGS::m_TrackMinWidth, BOARD_DESIGN_SETTINGS::m_TrackWidthList, TEARDROP_PARAMETERS_LIST::m_UseRoundShapesOnly, BOARD_DESIGN_SETTINGS::m_ViasDimensionsList, BOARD_DESIGN_SETTINGS::m_ViasMinAnnularWidth, BOARD_DESIGN_SETTINGS::m_ViasMinSize, TEARDROP_PARAMETERS::m_WidthtoSizeFilterRatio, onModified(), HANDLER_CONTEXT< RequestMessageType >::Request, RPT_SEVERITY_ERROR, RPT_SEVERITY_IGNORE, RPT_SEVERITY_WARNING, BOARD::SetDesignSettings(), BOARD_DESIGN_SETTINGS::VALIDATION_ERROR::setting_name, TARGET_UNKNOWN, BOARD_DESIGN_SETTINGS::ValidateDesignRules(), API_HANDLER_EDITOR::validateDocument(), and via.

Referenced by API_HANDLER_PCB().

handleSetBoardEditorAppearanceSettings()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings ( const HANDLER_CONTEXT< SetBoardEditorAppearanceSettings > & aCtx )

private

Definition at line 2002 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), API_HANDLER_BOARD::checkForHeadless(), frame(), FromProtoEnum(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetDisplayOptions(), PCB_BASE_FRAME::GetPcbNewSettings(), PCB_DRAW_PANEL_GAL::GetView(), PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay, PCBNEW_SETTINGS::m_Display, PCB_DISPLAY_OPTIONS::m_FlipBoardView, PCB_DISPLAY_OPTIONS::m_NetColorMode, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_RatsnestMode, EDA_DRAW_PANEL_GAL::Refresh(), HANDLER_CONTEXT< RequestMessageType >::Request, PCB_BASE_FRAME::SetDisplayOptions(), and KIGFX::VIEW::UpdateAllLayersColor().

Referenced by API_HANDLER_PCB().

handleSetBoardEnabledLayers()

HANDLER_RESULT< BoardEnabledLayersResponse > API_HANDLER_PCB::handleSetBoardEnabledLayers ( const HANDLER_CONTEXT< SetBoardEnabledLayers > & aCtx )

private

Definition at line 616 of file api_handler_pcb.cpp.

References LSET::AllCuMask(), B_CrtYd, API_HANDLER_BOARD::board(), Edge_Cuts, F_CrtYd, Margin, MAX_CU_LAYERS, onModified(), kiapi::board::PackLayerSet(), HANDLER_CONTEXT< RequestMessageType >::Request, TOOL_MANAGER::RunAction(), ACTIONS::selectionClear, API_HANDLER_BOARD::toolManager(), kiapi::board::UnpackLayerSet(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleSetBoardOrigin()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleSetBoardOrigin ( const HANDLER_CONTEXT< SetBoardOrigin > & aCtx )

private

Definition at line 1311 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), PCB_ACTIONS::drillSetOrigin, frame(), BOARD::GetDesignSettings(), TOOLS_HOLDER::GetToolManager(), ACTIONS::gridSetOrigin, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, TOOL_MANAGER::RunAction(), BOARD_DESIGN_SETTINGS::SetAuxOrigin(), PCB_CONTEXT::SetContentModified(), BOARD_DESIGN_SETTINGS::SetGridOrigin(), kiapi::common::UnpackVector2(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleSetBoardPlotSettings()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleSetBoardPlotSettings ( const HANDLER_CONTEXT< SetBoardPlotSettings > & aCtx )

private

Definition at line 2071 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), FromProtoEnum(), BOARD::GetPlotOptions(), IsPcbLayer(), onModified(), HANDLER_CONTEXT< RequestMessageType >::Request, PCB_PLOT_PARAMS::SetBlackAndWhite(), PCB_PLOT_PARAMS::SetCrossoutDNPFPsOnFabLayers(), PCB_PLOT_PARAMS::SetDrillMarksType(), PCB_PLOT_PARAMS::SetHideDNPFPsOnFabLayers(), PCB_PLOT_PARAMS::SetLayerSelection(), PCB_PLOT_PARAMS::SetMirror(), PCB_PLOT_PARAMS::SetNegative(), PCB_PLOT_PARAMS::SetPlotFrameRef(), PCB_PLOT_PARAMS::SetPlotOnAllLayersSequence(), BOARD::SetPlotOptions(), PCB_PLOT_PARAMS::SetPlotPadNumbers(), PCB_PLOT_PARAMS::SetPlotReference(), PCB_PLOT_PARAMS::SetPlotValue(), PCB_PLOT_PARAMS::SetScale(), PCB_PLOT_PARAMS::SetSketchDNPFPsOnFabLayers(), PCB_PLOT_PARAMS::SetSketchPadsOnFabLayers(), PCB_PLOT_PARAMS::SetSubtractMaskFromSilk(), PCB_PLOT_PARAMS::SetUseAuxOrigin(), kiapi::board::UnpackLayerSet(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleSetCurrentVariant()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleSetCurrentVariant ( const HANDLER_CONTEXT< commands::SetCurrentVariant > & aCtx )

private

Definition at line 3337 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), frame(), BOARD_CONTEXT::GetBoard(), name, pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, PCB_EDIT_FRAME::SetCurrentVariant(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleSetCustomDesignRules()

HANDLER_RESULT< CustomRulesResponse > API_HANDLER_PCB::handleSetCustomDesignRules ( const HANDLER_CONTEXT< SetCustomDesignRules > & aCtx )

private

Definition at line 1179 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), HANDLER_CONTEXT< RequestMessageType >::ClientName, DRC_RULE::FormatRuleFromProto(), BOARD::GetDesignRulesPath(), handleGetCustomDesignRules(), DRC_RULES_PARSER::Parse(), HANDLER_CONTEXT< RequestMessageType >::Request, API_HANDLER_EDITOR::validateDocument(), and IO_ERROR::What().

Referenced by API_HANDLER_PCB().

handleSetEmbeddedFiles()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleSetEmbeddedFiles ( const HANDLER_CONTEXT< SetEmbeddedFiles > & aCtx )

private

Definition at line 737 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), onModified(), HANDLER_CONTEXT< RequestMessageType >::Request, result, unpackEmbeddedFiles(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleSetPageSettings()

HANDLER_RESULT< types::PageSettings > API_HANDLER_EDITOR::handleSetPageSettings ( const HANDLER_CONTEXT< commands::SetPageSettings > & aCtx )

protectedinherited

Definition at line 540 of file api_handler_editor.cpp.

References FromProtoEnum(), getDrawingSheetFileName(), getPageSettings(), PAGE_INFO::GetSizeIU(), PAGE_INFO::GetType(), PAGE_INFO::IsCustom(), PAGE_INFO::IsPortrait(), onModified(), kiapi::common::PackVector2(), pcbIUScale, HANDLER_CONTEXT< RequestMessageType >::Request, PAGE_INFO::SetCustomHeightMils(), PAGE_INFO::SetCustomWidthMils(), setDrawingSheetFileName(), setPageSettings(), PAGE_INFO::SetType(), ToProtoEnum(), kiapi::common::UnpackVector2(), User, validateDocument(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by API_HANDLER_PCB::API_HANDLER_PCB(), and API_HANDLER_SCH::API_HANDLER_SCH().

handleSetTitleBlockInfo()

HANDLER_RESULT< google::protobuf::Empty > API_HANDLER_EDITOR::handleSetTitleBlockInfo ( const HANDLER_CONTEXT< commands::SetTitleBlockInfo > & aCtx )

protectedinherited

Definition at line 457 of file api_handler_editor.cpp.

References getTitleBlock(), onModified(), HANDLER_CONTEXT< RequestMessageType >::Request, TITLE_BLOCK::SetComment(), TITLE_BLOCK::SetCompany(), TITLE_BLOCK::SetDate(), TITLE_BLOCK::SetRevision(), TITLE_BLOCK::SetTitle(), and validateDocument().

Referenced by API_HANDLER_EDITOR().

handleSetVariantDescription()

HANDLER_RESULT< Empty > API_HANDLER_PCB::handleSetVariantDescription ( const HANDLER_CONTEXT< commands::SetVariantDescription > & aCtx )

private

Definition at line 3309 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), BOARD_CONTEXT::GetBoard(), GetDefaultVariantName(), name, onModified(), pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

handleSetVisibleLayers()

HANDLER_RESULT< Empty > API_HANDLER_BOARD::handleSetVisibleLayers ( const HANDLER_CONTEXT< SetVisibleLayers > & aCtx )

privateinherited

Definition at line 1504 of file api_handler_board.cpp.

References board(), API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), LSET::Contains(), FromProtoEnum(), PCB_BASE_EDIT_FRAME::GetAppearancePanel(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetEnabledLayers(), API_HANDLER_EDITOR::m_frame, APPEARANCE_CONTROLS::OnBoardChanged(), HANDLER_CONTEXT< RequestMessageType >::Request, BASE_SET::set(), BOARD::SetVisibleLayers(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

handleSyncSelection()

HANDLER_RESULT< SyncSelectionResponse > API_HANDLER_PCB::handleSyncSelection ( const HANDLER_CONTEXT< commands::SyncSelection > & aCtx )

private

Definition at line 3003 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_BOARD::checkForHeadless(), kiapi::board::FindItemsFromSyncSelection(), CROSS_PROBING_SETTINGS::flash_selection, frame(), PCB_BASE_FRAME::GetPcbNewSettings(), TOOLS_HOLDER::GetToolManager(), APP_SETTINGS_BASE::m_CrossProbing, PCB_EDIT_FRAME::m_ProbingSchToPcb, CROSS_PROBING_SETTINGS::on_selection, HANDLER_CONTEXT< RequestMessageType >::Request, TOOL_MANAGER::RunAction(), PCB_EDIT_FRAME::StartCrossProbeFlash(), PCB_ACTIONS::syncSelection, PCB_ACTIONS::syncSelectionWithNets, traceCrossProbeFlash, and PCB_BASE_FRAME::Update3DView().

Referenced by API_HANDLER_PCB().

handleUpdateItems()

HANDLER_RESULT< UpdateItemsResponse > API_HANDLER_EDITOR::handleUpdateItems ( const HANDLER_CONTEXT< commands::UpdateItems > & aCtx )

protectedinherited

Definition at line 269 of file api_handler_editor.cpp.

References checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, handleCreateUpdateItemsInternal(), HANDLER_CONTEXT< RequestMessageType >::Request, and result.

Referenced by API_HANDLER_EDITOR().

onModified()

void API_HANDLER_PCB::onModified ( )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1460 of file api_handler_pcb.cpp.

References frame(), PCB_EDIT_FRAME::OnModify(), pcbContext(), PCB_CONTEXT::SetContentModified(), and PCB_EDIT_FRAME::UpdateUserInterface().

Referenced by handleAddEmbeddedFiles(), handleAddVariant(), handleCopyVariant(), handleDeleteVariant(), handleRefillZones(), handleRenameVariant(), handleSetBoardDesignRules(), handleSetBoardEnabledLayers(), handleSetBoardPlotSettings(), handleSetEmbeddedFiles(), and handleSetVariantDescription().

onNetSettingsChanged()

void API_HANDLER_PCB::onNetSettingsChanged ( )

overrideprotectedvirtual

Called on all registered handlers after project net settings (netclasses or netclass assignments) have been changed via the API.

Reimplemented from API_HANDLER.

Definition at line 1473 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), frame(), EVENTS::SelectedItemsModified, API_HANDLER_BOARD::toolManager(), and PCB_EDIT_FRAME::UpdateUserInterface().

parseRequestedItemTypes()

std::vector< KICAD_T > API_HANDLER_BOARD::parseRequestedItemTypes ( const google::protobuf::RepeatedField< int > & aTypes )

protectedinherited

Definition at line 689 of file api_handler_board.cpp.

References FromProtoEnum(), and TYPE_NOT_INIT.

Referenced by API_HANDLER_PCB::handleGetConnectedItems(), API_HANDLER_FOOTPRINT::handleGetItems(), API_HANDLER_PCB::handleGetItems(), API_HANDLER_PCB::handleGetItemsByNet(), API_HANDLER_PCB::handleGetItemsByNetClass(), and handleGetSelection().

pcbContext()

PCB_CONTEXT * API_HANDLER_PCB::pcbContext ( ) const

inlineprivate

Definition at line 243 of file api_handler_pcb.h.

References API_HANDLER_BOARD::context().

Referenced by handleAddVariant(), handleCopyVariant(), handleDeleteVariant(), handleGetCurrentVariant(), handleGetDocumentModifiedState(), handleGetOpenDocuments(), handleGetVariants(), handleImportNetlist(), handleRenameVariant(), handleRevertDocument(), handleRunBoardJobExport3D(), handleRunBoardJobExportDrill(), handleRunBoardJobExportDxf(), handleRunBoardJobExportGencad(), handleRunBoardJobExportGerbers(), handleRunBoardJobExportIdf(), handleRunBoardJobExportIpc2581(), handleRunBoardJobExportIpcD356(), handleRunBoardJobExportODB(), handleRunBoardJobExportPdf(), handleRunBoardJobExportPng(), handleRunBoardJobExportPosition(), handleRunBoardJobExportPs(), handleRunBoardJobExportRender(), handleRunBoardJobExportSpecctraDsn(), handleRunBoardJobExportStats(), handleRunBoardJobExportSvg(), handleSaveCopyOfDocument(), handleSaveDocument(), handleSaveDocumentAs(), handleSetBoardOrigin(), handleSetCurrentVariant(), handleSetVariantDescription(), onModified(), and validateDocumentInternal().

project()

PROJECT & API_HANDLER_BOARD::project ( ) const

inlineprotectedinherited

Definition at line 81 of file api_handler_board.h.

References context(), and BOARD_CONTEXT::Prj().

Referenced by API_HANDLER_FOOTPRINT::handleGetOpenDocuments(), API_HANDLER_PCB::handleGetOpenDocuments(), API_HANDLER_PCB::handleImportNetlist(), API_HANDLER_PCB::handleImportSpecctraSession(), and API_HANDLER_PCB::handleSaveCopyOfDocument().

pushCurrentCommit()

void API_HANDLER_BOARD::pushCurrentCommit ( const std::string & aClientName, const wxString & aMessage )

overrideprotectedvirtualinherited

Reimplemented from API_HANDLER_EDITOR.

Definition at line 130 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::onModified(), and API_HANDLER_EDITOR::pushCurrentCommit().

Referenced by deleteItemsInternal(), handleCreateUpdateItemsInternal(), handleFlipItems(), API_HANDLER_PCB::handleImportSpecctraSession(), API_HANDLER_PCB::handleInjectDrcError(), and API_HANDLER_PCB::handlePlaceFootprintFromLibrary().

regenerateGenerators()

void API_HANDLER_BOARD::regenerateGenerators ( GENERATOR_TOOL * aTool, BOARD_COMMIT * aCommit, const std::vector< PCB_GENERATOR * > & aGenerators, std::function< void(const KIID &, commands::ItemStatus)> aResultHandler ) const

protectedinherited

Definition at line 301 of file api_handler_board.cpp.

References board().

Referenced by handleCreateUpdateItemsInternal().

registerHandler()

template<class RequestType, class ResponseType, class HandlerType>

void API_HANDLER::registerHandler ( HANDLER_RESULT< ResponseType >(HandlerType::* aHandler )(const HANDLER_CONTEXT< RequestType > &) )

inlineprotectedinherited

Registers an API command handler for the given message types.

When an API request matching the given type comes in, the handler will be called and its response will be packed into an envelope for sending back to the API client.

If the given message does not unpack into the request type, an envelope is returned with status AS_BAD_REQUEST, which probably indicates corruption in the message.

Template Parameters

RequestType	is a protobuf message type containing a command
ResponseType	is a protobuf message type containing a command response
HandlerType	is the implied type of the API_HANDLER subclass

Parameters

aHandler

is the handler function for the given request and response types

Definition at line 114 of file api_handler.h.

References HANDLER_CONTEXT< RequestMessageType >::ClientName, m_handlers, HANDLER_CONTEXT< RequestMessageType >::Request, and tryUnpack().

Referenced by API_HANDLER_BOARD::API_HANDLER_BOARD(), API_HANDLER_COMMON::API_HANDLER_COMMON(), API_HANDLER_EDITOR::API_HANDLER_EDITOR(), API_HANDLER_FOOTPRINT::API_HANDLER_FOOTPRINT(), API_HANDLER_LIBRARIES::API_HANDLER_LIBRARIES(), API_HANDLER_PCB::API_HANDLER_PCB(), API_HANDLER_SCH::API_HANDLER_SCH(), and API_HANDLER_SYMBOL::API_HANDLER_SYMBOL().

requestNetSettingsNotification()

void API_HANDLER::requestNetSettingsNotification ( )

inlineinherited

Definition at line 78 of file api_handler.h.

References m_notifyNetSettings.

Referenced by API_HANDLER_COMMON::handleSetNetClassAssignments(), and API_HANDLER_COMMON::handleSetNetClasses().

setApiServer()

void API_HANDLER::setApiServer ( KICAD_API_SERVER * aServer )

inlineinherited

Set by KICAD_API_SERVER::RegisterHandler; null when the handler is not registered.

Definition at line 89 of file api_handler.h.

References m_apiServer.

Referenced by KICAD_API_SERVER::DeregisterHandler(), and KICAD_API_SERVER::RegisterHandler().

setDrawingSheetFileName()

void API_HANDLER_PCB::setDrawingSheetFileName ( const wxString & aFileName )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1448 of file api_handler_pcb.cpp.

References frame(), PROJECT::GetProjectFile(), PCB_EDIT_FRAME::LoadDrawingSheet(), PROJECT_FILE::m_BoardDrawingSheetFile, BASE_SCREEN::m_DrawingSheetFileName, and KIWAY_HOLDER::Prj().

setPageSettings()

bool API_HANDLER_PCB::setPageSettings ( const DocumentSpecifier & aDocument, const PAGE_INFO & aPageInfo )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1435 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::context(), BOARD_CONTEXT::GetBoard(), and BOARD::SetPageSettings().

thisDocumentType()

kiapi::common::types::DocumentType API_HANDLER_PCB::thisDocumentType ( ) const

inlineoverrideprotectedvirtual

Override this to specify which document type this editor handles.

Implements API_HANDLER_EDITOR.

Definition at line 218 of file api_handler_pcb.h.

Referenced by handleSaveDocumentAs().

toolManager()

TOOL_MANAGER * API_HANDLER_BOARD::toolManager ( ) const

inlineprotectedinherited

Definition at line 83 of file api_handler_board.h.

References context(), and BOARD_CONTEXT::GetToolManager().

Referenced by createCommit(), deleteItemsInternal(), ensureGeneratorTool(), handleAddToSelection(), handleClearSelection(), handleFocusOnItems(), handleGetSelection(), handleInteractiveMoveItems(), API_HANDLER_PCB::handleRefillZones(), handleRemoveFromSelection(), handleRunAction(), handleSaveSelectionToString(), API_HANDLER_PCB::handleSetBoardEnabledLayers(), and API_HANDLER_PCB::onNetSettingsChanged().

tryUnpack()

template<typename MessageType>

bool API_HANDLER::tryUnpack ( ApiRequest & aRequest, ApiResponse & aReply, MessageType & aDest )

inlineprivateinherited

Definition at line 161 of file api_handler.h.

Referenced by registerHandler().

validateDocument()

HANDLER_RESULT< bool > API_HANDLER_EDITOR::validateDocument ( const DocumentSpecifier & aDocument )

protectedinherited

Definition at line 180 of file api_handler_editor.cpp.

References validateDocumentInternal().

Referenced by API_HANDLER_BOARD::getItemFromDocument(), API_HANDLER_SCH::getItemFromDocument(), API_HANDLER_SYMBOL::getItemFromDocument(), API_HANDLER_PCB::handleAddEmbeddedFiles(), API_HANDLER_PCB::handleAddVariant(), API_HANDLER_SCH::handleAddVariant(), API_HANDLER_BOARD::handleCheckPadstackPresenceOnLayers(), API_HANDLER_PCB::handleCopyVariant(), API_HANDLER_SCH::handleCopyVariant(), API_HANDLER_PCB::handleDeleteVariant(), API_HANDLER_SCH::handleDeleteVariant(), API_HANDLER_BOARD::handleExpandTextVariables(), API_HANDLER_SCH::handleExpandTextVariables(), API_HANDLER_BOARD::handleFocusOnItems(), API_HANDLER_SCH::handleFocusOnItems(), API_HANDLER_BOARD::handleGetActiveLayer(), API_HANDLER_BOARD::handleGetBoardBoundingBox(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_BOARD::handleGetBoardEnabledLayers(), API_HANDLER_PCB::handleGetBoardLayerByName(), API_HANDLER_PCB::handleGetBoardLayerName(), API_HANDLER_PCB::handleGetBoardOrigin(), API_HANDLER_PCB::handleGetBoardPlotSettings(), API_HANDLER_PCB::handleGetCurrentVariant(), API_HANDLER_SCH::handleGetCurrentVariant(), API_HANDLER_PCB::handleGetCustomDesignRules(), handleGetDocumentModifiedState(), API_HANDLER_PCB::handleGetDocumentModifiedState(), API_HANDLER_SCH::handleGetDocumentModifiedState(), API_HANDLER_SYMBOL::handleGetDocumentModifiedState(), API_HANDLER_PCB::handleGetEmbeddedFiles(), API_HANDLER_BOARD::handleGetGraphicsDefaults(), API_HANDLER_PCB::handleGetNets(), API_HANDLER_BOARD::handleGetPadShapeAsPolygon(), handleGetPageSettings(), API_HANDLER_SCH::handleGetSchematicHierarchy(), API_HANDLER_SCH::handleGetSchematicNetlist(), API_HANDLER_BOARD::handleGetStackup(), handleGetTitleBlockInfo(), API_HANDLER_PCB::handleGetVariants(), API_HANDLER_SCH::handleGetVariants(), API_HANDLER_BOARD::handleGetVisibleLayers(), API_HANDLER_PCB::handleImportNetlist(), API_HANDLER_PCB::handleImportSpecctraSession(), API_HANDLER_PCB::handleInjectDrcError(), API_HANDLER_BOARD::handleInteractiveMoveItems(), API_HANDLER_BOARD::handleParseAndCreateItemsFromString(), API_HANDLER_PCB::handleRefillZones(), API_HANDLER_PCB::handleRenameVariant(), API_HANDLER_SCH::handleRenameVariant(), API_HANDLER_FOOTPRINT::handleRevertDocument(), API_HANDLER_PCB::handleRevertDocument(), API_HANDLER_SCH::handleRevertDocument(), API_HANDLER_SYMBOL::handleRevertDocument(), API_HANDLER_PCB::handleRunBoardJobExport3D(), API_HANDLER_PCB::handleRunBoardJobExportDrill(), API_HANDLER_PCB::handleRunBoardJobExportDxf(), API_HANDLER_PCB::handleRunBoardJobExportGencad(), API_HANDLER_PCB::handleRunBoardJobExportGerbers(), API_HANDLER_PCB::handleRunBoardJobExportIdf(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), API_HANDLER_PCB::handleRunBoardJobExportIpcD356(), API_HANDLER_PCB::handleRunBoardJobExportODB(), API_HANDLER_PCB::handleRunBoardJobExportPdf(), API_HANDLER_PCB::handleRunBoardJobExportPng(), API_HANDLER_PCB::handleRunBoardJobExportPosition(), API_HANDLER_PCB::handleRunBoardJobExportPs(), API_HANDLER_PCB::handleRunBoardJobExportRender(), API_HANDLER_PCB::handleRunBoardJobExportSpecctraDsn(), API_HANDLER_PCB::handleRunBoardJobExportStats(), API_HANDLER_PCB::handleRunBoardJobExportSvg(), API_HANDLER_SCH::handleRunSchematicJobExportBOM(), API_HANDLER_SCH::handleRunSchematicJobExportDxf(), API_HANDLER_SCH::handleRunSchematicJobExportNetlist(), API_HANDLER_SCH::handleRunSchematicJobExportPdf(), API_HANDLER_SCH::handleRunSchematicJobExportPng(), API_HANDLER_SCH::handleRunSchematicJobExportPs(), API_HANDLER_SCH::handleRunSchematicJobExportSvg(), API_HANDLER_PCB::handleSaveCopyOfDocument(), API_HANDLER_SCH::handleSaveCopyOfDocument(), API_HANDLER_SYMBOL::handleSaveCopyOfDocument(), API_HANDLER_PCB::handleSaveDocument(), API_HANDLER_SCH::handleSaveDocument(), API_HANDLER_SYMBOL::handleSaveDocument(), API_HANDLER_PCB::handleSaveDocumentAs(), API_HANDLER_SCH::handleSaveDocumentAs(), API_HANDLER_BOARD::handleSaveDocumentToString(), API_HANDLER_SCH::handleSaveDocumentToString(), API_HANDLER_BOARD::handleSetActiveLayer(), API_HANDLER_PCB::handleSetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardEnabledLayers(), API_HANDLER_PCB::handleSetBoardOrigin(), API_HANDLER_PCB::handleSetBoardPlotSettings(), API_HANDLER_PCB::handleSetCurrentVariant(), API_HANDLER_SCH::handleSetCurrentVariant(), API_HANDLER_PCB::handleSetCustomDesignRules(), API_HANDLER_PCB::handleSetEmbeddedFiles(), handleSetPageSettings(), handleSetTitleBlockInfo(), API_HANDLER_PCB::handleSetVariantDescription(), API_HANDLER_SCH::handleSetVariantDescription(), API_HANDLER_BOARD::handleSetVisibleLayers(), API_HANDLER_FOOTPRINT::validateAndGetFootprint(), and validateItemHeaderDocument().

validateDocumentInternal()

tl::expected< bool, ApiResponseStatus > API_HANDLER_PCB::validateDocumentInternal ( const DocumentSpecifier & aDocument ) const

overrideprotectedvirtual

Returns

true if the given document is valid for this editor and is currently open

Implements API_HANDLER_EDITOR.

Definition at line 442 of file api_handler_pcb.cpp.

References pcbContext().

validateItemHeaderDocument()

HANDLER_RESULT< std::optional< KIID > > API_HANDLER_EDITOR::validateItemHeaderDocument ( const kiapi::common::types::ItemHeader & aHeader )

protectedinherited

If the header is valid, returns the item container.

Definition at line 189 of file api_handler_editor.cpp.

References result, thisDocumentType(), validateDocument(), and validateDocumentInternal().

Referenced by API_HANDLER_BOARD::handleAddToSelection(), API_HANDLER_SCH::handleAddToSelection(), handleBeginCommit(), API_HANDLER_BOARD::handleClearSelection(), API_HANDLER_SCH::handleClearSelection(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_SYMBOL::handleCreateUpdateItemsInternal(), handleDeleteItems(), handleEndCommit(), API_HANDLER_BOARD::handleFlipItems(), API_HANDLER_BOARD::handleGetBoundingBox(), API_HANDLER_PCB::handleGetConnectedItems(), API_HANDLER_FOOTPRINT::handleGetItems(), API_HANDLER_PCB::handleGetItems(), API_HANDLER_SCH::handleGetItems(), API_HANDLER_SYMBOL::handleGetItems(), API_HANDLER_BOARD::handleGetItemsById(), API_HANDLER_SCH::handleGetItemsById(), API_HANDLER_SYMBOL::handleGetItemsById(), API_HANDLER_PCB::handleGetItemsByNet(), API_HANDLER_PCB::handleGetItemsByNetClass(), API_HANDLER_BOARD::handleGetSelection(), API_HANDLER_SCH::handleGetSelection(), handleHitTest(), API_HANDLER_PCB::handlePlaceFootprintFromLibrary(), API_HANDLER_SCH::handlePlaceSymbolFromLibrary(), API_HANDLER_BOARD::handleRemoveFromSelection(), and API_HANDLER_SCH::handleRemoveFromSelection().

Member Data Documentation

m_activeClients

std::set<std::string> API_HANDLER_EDITOR::m_activeClients

protectedinherited

Definition at line 150 of file api_handler_editor.h.

Referenced by API_HANDLER_BOARD::deleteItemsInternal(), API_HANDLER_SCH::deleteItemsInternal(), API_HANDLER_SYMBOL::deleteItemsInternal(), handleBeginCommit(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_SYMBOL::handleCreateUpdateItemsInternal(), handleEndCommit(), API_HANDLER_BOARD::handleFlipItems(), API_HANDLER_PCB::handleImportSpecctraSession(), API_HANDLER_PCB::handleInjectDrcError(), API_HANDLER_PCB::handlePlaceFootprintFromLibrary(), API_HANDLER_SCH::handlePlaceSymbolFromLibrary(), and pushCurrentCommit().

m_apiServer

KICAD_API_SERVER* API_HANDLER::m_apiServer = nullptr

protectedinherited

Definition at line 154 of file api_handler.h.

Referenced by apiServer(), and setApiServer().

m_commits

std::map<std::string, std::pair<KIID, std::unique_ptr<COMMIT> > > API_HANDLER_EDITOR::m_commits

protectedinherited

Definition at line 148 of file api_handler_editor.h.

Referenced by getCurrentCommit(), handleBeginCommit(), handleEndCommit(), API_HANDLER_PCB::handleRevertDocument(), API_HANDLER_SCH::handleRevertDocument(), and pushCurrentCommit().

m_context

std::shared_ptr<BOARD_CONTEXT> API_HANDLER_BOARD::m_context

privateinherited

Definition at line 176 of file api_handler_board.h.

Referenced by API_HANDLER_BOARD(), and context().

m_defaultCommitMessage

const wxString API_HANDLER::m_defaultCommitMessage = _( "Modification from API" )

staticprotectedinherited

Definition at line 156 of file api_handler.h.

Referenced by API_HANDLER_EDITOR::pushCurrentCommit().

m_frame

EDA_BASE_FRAME* API_HANDLER_EDITOR::m_frame

protectedinherited

Definition at line 152 of file api_handler_editor.h.

Referenced by API_HANDLER_EDITOR(), checkForBusy(), API_HANDLER_BOARD::checkForHeadless(), API_HANDLER_SCH::checkForHeadless(), API_HANDLER_BOARD::createCommit(), API_HANDLER_SCH::createCommit(), API_HANDLER_SYMBOL::createCommit(), API_HANDLER_SYMBOL::deleteItemsInternal(), API_HANDLER_FOOTPRINT::frame(), API_HANDLER_PCB::frame(), API_HANDLER_SCH::frame(), API_HANDLER_SYMBOL::frame(), API_HANDLER_BOARD::handleAddToSelection(), API_HANDLER_SCH::handleAddVariant(), API_HANDLER_BOARD::handleClearSelection(), API_HANDLER_SCH::handleCopyVariant(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_SYMBOL::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleDeleteVariant(), API_HANDLER_BOARD::handleGetActiveLayer(), handleGetDocumentModifiedState(), API_HANDLER_SCH::handleGetSchematicNetlist(), API_HANDLER_BOARD::handleRemoveFromSelection(), API_HANDLER_SCH::handleRenameVariant(), API_HANDLER_BOARD::handleSetActiveLayer(), API_HANDLER_SCH::handleSetCurrentVariant(), API_HANDLER_SCH::handleSetVariantDescription(), API_HANDLER_BOARD::handleSetVisibleLayers(), API_HANDLER_SCH::onModified(), API_HANDLER_SCH::onNetSettingsChanged(), and API_HANDLER_SCH::setDrawingSheetFileName().

m_handlers

std::map<std::string, REQUEST_HANDLER> API_HANDLER::m_handlers

protectedinherited

Maps type name (without the URL prefix) to a handler method.

Definition at line 150 of file api_handler.h.

Referenced by Handle(), and registerHandler().

m_notifyNetSettings

bool API_HANDLER::m_notifyNetSettings = false

protectedinherited

Definition at line 152 of file api_handler.h.

Referenced by clearNetSettingsNotification(), and requestNetSettingsNotification().

---

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

• api_handler_pcb.h
• api_handler_pcb.cpp