KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
API_HANDLER_PCB Class Reference

#include <api_handler_pcb.h>

Inheritance diagram for API_HANDLER_PCB:
API_HANDLER_EDITOR API_HANDLER

Public Member Functions

 API_HANDLER_PCB (PCB_EDIT_FRAME *aFrame)
 
 API_HANDLER_PCB (std::shared_ptr< BOARD_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.
 

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

std::unique_ptr< COMMIT > createCommit () override
 Override this to create an appropriate COMMIT subclass for the frame in question.
 
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
 
void deleteItemsInternal (std::map< KIID, ItemDeletionStatus > &aItemsToDelete, const std::string &aClientName) override
 
std::optional< EDA_ITEM * > getItemFromDocument (const DocumentSpecifier &aDocument, const KIID &aId) override
 
std::optional< TITLE_BLOCK * > getTitleBlock () override
 
std::optional< PAGE_INFO > getPageSettings () override
 
bool setPageSettings (const PAGE_INFO &aPageInfo) override
 
wxString getDrawingSheetFileName () override
 
void setDrawingSheetFileName (const wxString &aFileName) override
 
void onModified () override
 
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 std::vector< KICAD_T > parseRequestedItemTypes (const google::protobuf::RepeatedField< int > &aTypes)
 

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.
 

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::RunActionResponse > handleRunAction (const HANDLER_CONTEXT< commands::RunAction > &aCtx)
 
HANDLER_RESULT< commands::GetOpenDocumentsResponse > handleGetOpenDocuments (const HANDLER_CONTEXT< commands::GetOpenDocuments > &aCtx)
 
HANDLER_RESULT< Empty > handleSaveDocument (const HANDLER_CONTEXT< commands::SaveDocument > &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< 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< BoardStackupResponse > handleGetStackup (const HANDLER_CONTEXT< GetBoardStackup > &aCtx)
 
HANDLER_RESULT< BoardEnabledLayersResponse > handleGetBoardEnabledLayers (const HANDLER_CONTEXT< GetBoardEnabledLayers > &aCtx)
 
HANDLER_RESULT< BoardEnabledLayersResponse > handleSetBoardEnabledLayers (const HANDLER_CONTEXT< SetBoardEnabledLayers > &aCtx)
 
HANDLER_RESULT< GraphicsDefaultsResponse > handleGetGraphicsDefaults (const HANDLER_CONTEXT< GetGraphicsDefaults > &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< 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< commands::GetBoundingBoxResponse > handleGetBoundingBox (const HANDLER_CONTEXT< commands::GetBoundingBox > &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< 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< 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)
 
HANDLER_RESULT< BoardEditorAppearanceSettings > handleGetBoardEditorAppearanceSettings (const HANDLER_CONTEXT< GetBoardEditorAppearanceSettings > &aCtx)
 
HANDLER_RESULT< Empty > handleSetBoardEditorAppearanceSettings (const HANDLER_CONTEXT< SetBoardEditorAppearanceSettings > &aCtx)
 
HANDLER_RESULT< InjectDrcErrorResponse > handleInjectDrcError (const HANDLER_CONTEXT< InjectDrcError > &aCtx)
 
HANDLER_RESULT< types::RunJobResponse > handleRunBoardJobExport3D (const HANDLER_CONTEXT< RunBoardJobExport3D > &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 > 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 > 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 > handleRunBoardJobExportStats (const HANDLER_CONTEXT< RunBoardJobExportStats > &aCtx)
 
BOARD_CONTEXT * context () const
 
BOARD * board () const
 
PROJECT & project () const
 
TOOL_MANAGER * toolManager () const
 
PCB_EDIT_FRAME * frame () const
 
bool isHeadless () const
 
std::optional< ApiResponseStatus > checkForHeadless (const std::string &aCommandName) const
 
void pushCurrentCommit (const std::string &aClientName, const wxString &aMessage) override
 
std::optional< BOARD_ITEM * > getItemById (const KIID &aId) const
 
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
 
template<typename MessageType>
bool tryUnpack (ApiRequest &aRequest, ApiResponse &aReply, MessageType &aDest)
 

Static Private Member Functions

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

Private Attributes

std::shared_ptr< BOARD_CONTEXT > m_context
 

Detailed Description

Definition at line 55 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 62 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 76 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 87 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< BOARD_CONTEXT > aContext,
PCB_EDIT_FRAME * aFrame = nullptr )

Definition at line 93 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::API_HANDLER_EDITOR(), handleAddToSelection(), handleCheckPadstackPresenceOnLayers(), handleClearSelection(), handleExpandTextVariables(), handleGetActiveLayer(), handleGetBoardDesignRules(), handleGetBoardEditorAppearanceSettings(), handleGetBoardEnabledLayers(), handleGetBoardLayerName(), handleGetBoardOrigin(), handleGetBoundingBox(), handleGetConnectedItems(), handleGetCustomDesignRules(), handleGetGraphicsDefaults(), handleGetItems(), handleGetItemsById(), handleGetItemsByNet(), handleGetItemsByNetClass(), handleGetNetClassForNets(), handleGetNets(), handleGetOpenDocuments(), handleGetPadShapeAsPolygon(), API_HANDLER_EDITOR::handleGetPageSettings(), handleGetSelection(), handleGetStackup(), handleGetVisibleLayers(), handleInjectDrcError(), handleInteractiveMoveItems(), handleParseAndCreateItemsFromString(), handleRefillZones(), handleRemoveFromSelection(), handleRevertDocument(), handleRunAction(), handleRunBoardJobExport3D(), handleRunBoardJobExportDrill(), handleRunBoardJobExportDxf(), handleRunBoardJobExportGencad(), handleRunBoardJobExportGerbers(), handleRunBoardJobExportIpc2581(), handleRunBoardJobExportIpcD356(), handleRunBoardJobExportODB(), handleRunBoardJobExportPdf(), handleRunBoardJobExportPosition(), handleRunBoardJobExportPs(), handleRunBoardJobExportRender(), handleRunBoardJobExportStats(), handleRunBoardJobExportSvg(), handleSaveCopyOfDocument(), handleSaveDocument(), handleSaveDocumentToString(), handleSaveSelectionToString(), handleSetActiveLayer(), handleSetBoardDesignRules(), handleSetBoardEditorAppearanceSettings(), handleSetBoardEnabledLayers(), handleSetBoardOrigin(), handleSetCustomDesignRules(), API_HANDLER_EDITOR::handleSetPageSettings(), handleSetVisibleLayers(), m_context, move, and API_HANDLER::registerHandler().

Member Function Documentation

◆ board()

BOARD * API_HANDLER_PCB::board ( ) const
inlineprivate

Definition at line 256 of file api_handler_pcb.h.

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

Referenced by deleteItemsInternal(), getItemById(), handleCreateUpdateItemsInternal(), handleExpandTextVariables(), handleGetBoardDesignRules(), handleGetBoardEnabledLayers(), handleGetBoardLayerName(), handleGetBoardOrigin(), handleGetConnectedItems(), handleGetGraphicsDefaults(), handleGetItems(), handleGetItemsByNet(), handleGetItemsByNetClass(), handleGetNetClassForNets(), handleGetNets(), handleGetStackup(), handleGetVisibleLayers(), handleRevertDocument(), handleSaveCopyOfDocument(), handleSaveDocumentToString(), handleSaveSelectionToString(), handleSetActiveLayer(), handleSetBoardDesignRules(), handleSetBoardEnabledLayers(), and handleSetVisibleLayers().

◆ 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 222 of file api_handler_editor.cpp.

References m_frame.

Referenced by API_HANDLER_PCB::handleAddToSelection(), handleBeginCommit(), API_HANDLER_PCB::handleClearSelection(), handleCreateItems(), handleDeleteItems(), handleEndCommit(), API_HANDLER_PCB::handleGetBoundingBox(), API_HANDLER_PCB::handleGetConnectedItems(), API_HANDLER_PCB::handleGetItems(), API_HANDLER_SCH::handleGetItems(), API_HANDLER_PCB::handleGetItemsById(), API_HANDLER_SCH::handleGetItemsById(), API_HANDLER_PCB::handleGetItemsByNet(), API_HANDLER_PCB::handleGetItemsByNetClass(), API_HANDLER_SCH::handleGetSchematicNetlist(), handleHitTest(), API_HANDLER_PCB::handleInjectDrcError(), API_HANDLER_PCB::handleInteractiveMoveItems(), API_HANDLER_PCB::handleParseAndCreateItemsFromString(), API_HANDLER_PCB::handleRefillZones(), API_HANDLER_PCB::handleRemoveFromSelection(), API_HANDLER_PCB::handleRevertDocument(), API_HANDLER_PCB::handleRunAction(), API_HANDLER_PCB::handleRunBoardJobExport3D(), API_HANDLER_PCB::handleRunBoardJobExportDrill(), API_HANDLER_PCB::handleRunBoardJobExportDxf(), API_HANDLER_PCB::handleRunBoardJobExportGencad(), API_HANDLER_PCB::handleRunBoardJobExportGerbers(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), API_HANDLER_PCB::handleRunBoardJobExportIpcD356(), API_HANDLER_PCB::handleRunBoardJobExportODB(), API_HANDLER_PCB::handleRunBoardJobExportPdf(), API_HANDLER_PCB::handleRunBoardJobExportPosition(), API_HANDLER_PCB::handleRunBoardJobExportPs(), API_HANDLER_PCB::handleRunBoardJobExportRender(), 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::handleRunSchematicJobExportPs(), API_HANDLER_SCH::handleRunSchematicJobExportSvg(), API_HANDLER_PCB::handleSaveCopyOfDocument(), API_HANDLER_PCB::handleSaveDocument(), API_HANDLER_PCB::handleSetActiveLayer(), API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), API_HANDLER_PCB::handleSetBoardOrigin(), API_HANDLER_PCB::handleSetVisibleLayers(), and handleUpdateItems().

◆ checkForHeadless()

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

Definition at line 204 of file api_handler_pcb.cpp.

References frame().

Referenced by handleAddToSelection(), handleClearSelection(), handleGetActiveLayer(), handleGetBoardEditorAppearanceSettings(), handleGetSelection(), handleGetVisibleLayers(), handleInteractiveMoveItems(), handleRemoveFromSelection(), handleRevertDocument(), handleRunAction(), handleSaveSelectionToString(), handleSetActiveLayer(), handleSetBoardEditorAppearanceSettings(), and handleSetVisibleLayers().

◆ context()

BOARD_CONTEXT * API_HANDLER_PCB::context ( ) const
inlineprivate

Definition at line 254 of file api_handler_pcb.h.

References m_context.

Referenced by board(), getPageSettings(), getTitleBlock(), handleGetBoardDesignRules(), handleGetCustomDesignRules(), handleGetOpenDocuments(), handleRunBoardJobExport3D(), handleRunBoardJobExportDrill(), handleRunBoardJobExportDxf(), handleRunBoardJobExportGencad(), handleRunBoardJobExportGerbers(), handleRunBoardJobExportIpc2581(), handleRunBoardJobExportIpcD356(), handleRunBoardJobExportODB(), handleRunBoardJobExportPdf(), handleRunBoardJobExportPosition(), handleRunBoardJobExportPs(), handleRunBoardJobExportRender(), handleRunBoardJobExportStats(), handleRunBoardJobExportSvg(), handleSaveCopyOfDocument(), handleSaveDocument(), handleSetCustomDesignRules(), project(), setPageSettings(), toolManager(), and validateDocumentInternal().

◆ createCommit()

std::unique_ptr< COMMIT > API_HANDLER_PCB::createCommit ( )
overrideprotectedvirtual

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 372 of file api_handler_pcb.cpp.

References frame(), and toolManager().

◆ createItemForType()

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

Definition at line 417 of file api_handler_pcb.cpp.

References CreateItemForType(), EDA_ITEM::GetFriendlyName(), PCB_FOOTPRINT_T, and PCB_PAD_T.

Referenced by handleCreateUpdateItemsInternal().

◆ deleteItemsInternal()

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

Implements API_HANDLER_EDITOR.

Definition at line 868 of file api_handler_pcb.cpp.

References _, board(), API_HANDLER_EDITOR::getCurrentCommit(), API_HANDLER_EDITOR::m_activeClients, pushCurrentCommit(), and COMMIT::Remove().

◆ frame()

PCB_EDIT_FRAME * API_HANDLER_PCB::frame ( ) const
private

Definition at line 198 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::m_frame.

Referenced by checkForHeadless(), createCommit(), handleAddToSelection(), handleClearSelection(), handleGetActiveLayer(), handleGetBoardEditorAppearanceSettings(), handleRefillZones(), handleRemoveFromSelection(), handleRevertDocument(), handleSetActiveLayer(), handleSetBoardDesignRules(), handleSetBoardEditorAppearanceSettings(), handleSetBoardEnabledLayers(), handleSetBoardOrigin(), handleSetVisibleLayers(), isHeadless(), onModified(), pushCurrentCommit(), and setDrawingSheetFileName().

◆ getCurrentCommit()

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

Definition at line 152 of file api_handler_editor.cpp.

References createCommit(), and m_commits.

Referenced by API_HANDLER_PCB::deleteItemsInternal(), API_HANDLER_SCH::deleteItemsInternal(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handleInjectDrcError(), and API_HANDLER_PCB::handleInteractiveMoveItems().

◆ getDrawingSheetFileName()

wxString API_HANDLER_PCB::getDrawingSheetFileName ( )
overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 2036 of file api_handler_pcb.cpp.

References BASE_SCREEN::m_DrawingSheetFileName.

◆ getItemById()

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

Definition at line 381 of file api_handler_pcb.cpp.

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

Referenced by getItemFromDocument(), handleAddToSelection(), handleCheckPadstackPresenceOnLayers(), handleCreateUpdateItemsInternal(), handleGetBoundingBox(), handleGetConnectedItems(), handleGetItemsById(), handleGetPadShapeAsPolygon(), handleInteractiveMoveItems(), and handleRemoveFromSelection().

◆ getItemFromDocument()

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

Implements API_HANDLER_EDITOR.

Definition at line 896 of file api_handler_pcb.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.

Definition at line 116 of file api_handler_editor.h.

References pcbIUScale.

Referenced by handleHitTest().

◆ getPageSettings()

std::optional< PAGE_INFO > API_HANDLER_PCB::getPageSettings ( )
overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 2023 of file api_handler_pcb.cpp.

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

◆ getTitleBlock()

std::optional< TITLE_BLOCK * > API_HANDLER_PCB::getTitleBlock ( )
overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 2017 of file api_handler_pcb.cpp.

References 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
aMsgis 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.

◆ handleAddToSelection()

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

Definition at line 965 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleBeginCommit()

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

Definition at line 48 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_PCB::handleCheckPadstackPresenceOnLayers ( const HANDLER_CONTEXT< CheckPadstackPresenceOnLayers > & aCtx)
private

Definition at line 1950 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleClearSelection()

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

Definition at line 940 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleCreateItems()

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

Definition at line 239 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_PCB::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 )
overrideprivatevirtual

Implements API_HANDLER_EDITOR.

Definition at line 460 of file api_handler_pcb.cpp.

References _, COMMIT::Add(), EDA_GROUP::AddItem(), KIID::AsStdString(), board(), BOARD_ITEM::CopyFrom(), createItemForType(), API_HANDLER_EDITOR::getCurrentCommit(), getItemById(), EDA_ITEM::GetParentGroup(), 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_GROUP_T, pushCurrentCommit(), RECURSE, COMMIT::Remove(), BOARD_ITEM::ResetUuid(), SERIALIZABLE::Serialize(), EDA_ITEM::Type(), kiapi::common::TypeNameFromAny(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

◆ handleDeleteItems()

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

Definition at line 293 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().

◆ handleEndCommit()

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

Definition at line 86 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_PCB::handleExpandTextVariables ( const HANDLER_CONTEXT< commands::ExpandTextVariables > & aCtx)
private

Definition at line 2062 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleGetActiveLayer()

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

Definition at line 2555 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleGetBoardDesignRules()

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

Definition at line 1218 of file api_handler_pcb.cpp.

References PROJECT::AbsolutePath(), board(), context(), FILEEXT::DesignRulesFileExtension, BOARD_CONTEXT::GetBoard(), BOARD::GetDesignSettings(), BOARD::GetFileName(), 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_DrcExclusionComments, 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(), BOARD_CONTEXT::Prj(), HANDLER_CONTEXT< RequestMessageType >::Request, TARGET_ROUND, TARGET_TRACK, 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 2604 of file api_handler_pcb.cpp.

References 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_PCB::handleGetBoardEnabledLayers ( const HANDLER_CONTEXT< GetBoardEnabledLayers > & aCtx)
private

Definition at line 1076 of file api_handler_pcb.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_PCB().

◆ handleGetBoardLayerName()

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

Definition at line 1855 of file api_handler_pcb.cpp.

References 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 1760 of file api_handler_pcb.cpp.

References 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().

◆ handleGetBoundingBox()

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

Definition at line 1874 of file api_handler_pcb.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_PCB().

◆ handleGetConnectedItems()

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

Definition at line 2180 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleGetCustomDesignRules()

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

Definition at line 1569 of file api_handler_pcb.cpp.

References PROJECT::AbsolutePath(), context(), FILEEXT::DesignRulesFileExtension, DRC_RULE_LOADER::ExtractRuleComment(), DRC_RULE_LOADER::ExtractRuleText(), BOARD_CONTEXT::GetBoard(), BOARD::GetFileName(), LSET::NameToLayer(), DRC_RULES_PARSER::Parse(), PCB_LAYER_ID_COUNT, BOARD_CONTEXT::Prj(), 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().

◆ handleGetGraphicsDefaults()

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

Definition at line 1178 of file api_handler_pcb.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_PCB().

◆ handleGetItems()

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

Definition at line 661 of file api_handler_pcb.cpp.

References board(), API_HANDLER_EDITOR::checkForBusy(), API_HANDLER_EDITOR::parseRequestedItemTypes(), 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_DIMENSION_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_PAD_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_PCB().

◆ handleGetItemsById()

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

Definition at line 826 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleGetItemsByNet()

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

Definition at line 2247 of file api_handler_pcb.cpp.

References board(), API_HANDLER_EDITOR::checkForBusy(), NETINFO_ITEM::GetNetCode(), NETINFO_LIST::GetNetItem(), API_HANDLER_EDITOR::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 2302 of file api_handler_pcb.cpp.

References board(), API_HANDLER_EDITOR::checkForBusy(), NETCLASS::ContainsNetclassWithName(), filter, API_HANDLER_EDITOR::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 2380 of file api_handler_pcb.cpp.

References 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 2135 of file api_handler_pcb.cpp.

References 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 236 of file api_handler_pcb.cpp.

References context(), project(), and HANDLER_CONTEXT< RequestMessageType >::Request.

Referenced by API_HANDLER_PCB().

◆ handleGetPadShapeAsPolygon()

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

Definition at line 1915 of file api_handler_pcb.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_PCB().

◆ handleGetPageSettings()

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

Definition at line 488 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_PCB::handleGetSelection ( const HANDLER_CONTEXT< commands::GetSelection > & aCtx)
private

Definition at line 906 of file api_handler_pcb.cpp.

References checkForHeadless(), filter, PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), API_HANDLER_EDITOR::parseRequestedItemTypes(), HANDLER_CONTEXT< RequestMessageType >::Request, toolManager(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_PCB().

◆ handleGetStackup()

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

Definition at line 1045 of file api_handler_pcb.cpp.

References board(), FromProtoEnum(), BOARD::GetStackupOrDefault(), HANDLER_CONTEXT< RequestMessageType >::Request, BOARD_STACKUP::Serialize(), UNDEFINED_LAYER, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

◆ handleGetTitleBlockInfo()

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

Definition at line 399 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().

◆ handleGetVisibleLayers()

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

Definition at line 2501 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleHitTest()

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

Definition at line 342 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().

◆ handleInjectDrcError()

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

Definition at line 2672 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, COMMIT::Push(), HANDLER_CONTEXT< RequestMessageType >::Request, RPT_SEVERITY_WARNING, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

◆ handleInteractiveMoveItems()

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

Definition at line 2090 of file api_handler_pcb.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_PCB().

◆ handleParseAndCreateItemsFromString()

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

Definition at line 2485 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleRefillZones()

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

Definition at line 2405 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), frame(), HANDLER_CONTEXT< RequestMessageType >::Request, TOOL_MANAGER::RunAction(), toolManager(), API_HANDLER_EDITOR::validateDocument(), and PCB_ACTIONS::zoneFillAll.

Referenced by API_HANDLER_PCB().

◆ handleRemoveFromSelection()

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

Definition at line 1005 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleRevertDocument()

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

Definition at line 339 of file api_handler_pcb.cpp.

References PROJECT::AbsolutePath(), board(), API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), frame(), PCB_BASE_FRAME::GetScreen(), KICTL_REVERT, PCB_EDIT_FRAME::OpenProjectFiles(), project(), EDA_DRAW_FRAME::ReleaseFile(), HANDLER_CONTEXT< RequestMessageType >::Request, BASE_SCREEN::SetContentModified(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

◆ handleRunAction()

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

Definition at line 216 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleRunBoardJobExport3D()

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

Definition at line 2846 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), FromProtoEnum(), BOARD_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, 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 3140 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), FromProtoEnum(), BOARD_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, 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 2987 of file api_handler_pcb.cpp.

References ApplyBoardPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), FromProtoEnum(), BOARD_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, 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 3252 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), BOARD_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, 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 3096 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), FromProtoEnum(), BOARD_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_PLOT::m_plotLayerSequence, HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), UNDEFINED_LAYER, 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 3277 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), FromProtoEnum(), BOARD_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_IPC2581::m_bomRev, 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_IPC2581::m_colMfgPn, JOB_EXPORT_PCB_IPC2581::m_compress, JOB_EXPORT_PCB_IPC2581::m_drawingSheet, JOB_EXPORT_PCB_IPC2581::m_filename, JOB_EXPORT_PCB_IPC2581::m_precision, JOB_EXPORT_PCB_IPC2581::m_units, JOB_EXPORT_PCB_IPC2581::m_variant, JOB_EXPORT_PCB_IPC2581::m_version, 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 3318 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), BOARD_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_IPCD356::m_filename, 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 3337 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), FromProtoEnum(), BOARD_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_ODB::m_compressionMode, JOB_EXPORT_PCB_ODB::m_drawingSheet, JOB_EXPORT_PCB_ODB::m_filename, JOB_EXPORT_PCB_ODB::m_precision, JOB_EXPORT_PCB_ODB::m_units, JOB_EXPORT_PCB_ODB::m_variant, 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 3029 of file api_handler_pcb.cpp.

References ApplyBoardPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), FromProtoEnum(), BOARD_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, HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_PCB().

◆ handleRunBoardJobExportPosition()

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

Definition at line 3207 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), FromProtoEnum(), BOARD_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, 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 3059 of file api_handler_pcb.cpp.

References ApplyBoardPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), FromProtoEnum(), BOARD_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, 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 2905 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), FromProtoEnum(), BOARD_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, HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), kiapi::common::UnpackVector3D(), 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 3370 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), FromProtoEnum(), BOARD_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, 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 2953 of file api_handler_pcb.cpp.

References ApplyBoardPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), context(), ExecuteBoardJob(), FromProtoEnum(), BOARD_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, 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 279 of file api_handler_pcb.cpp.

References board(), API_HANDLER_EDITOR::checkForBusy(), context(), BOARD::GetFileName(), FILEEXT::KiCadPcbFileExtension, project(), HANDLER_CONTEXT< RequestMessageType >::Request, BOARD_CONTEXT::SaveBoard(), BOARD_CONTEXT::SavePcbCopy(), 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 263 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleSaveDocumentToString()

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

Definition at line 2435 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleSaveSelectionToString()

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

Definition at line 2459 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleSetActiveLayer()

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

Definition at line 2574 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleSetBoardDesignRules()

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

Definition at line 1373 of file api_handler_pcb.cpp.

References board(), HANDLER_CONTEXT< RequestMessageType >::ClientName, BOARD_DESIGN_SETTINGS::VALIDATION_ERROR::error_message, frame(), 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_DrcExclusionComments, 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, PCB_EDIT_FRAME::OnModify(), HANDLER_CONTEXT< RequestMessageType >::Request, RPT_SEVERITY_ERROR, RPT_SEVERITY_IGNORE, RPT_SEVERITY_WARNING, BOARD::SetDesignSettings(), BOARD_DESIGN_SETTINGS::VALIDATION_ERROR::setting_name, PCB_EDIT_FRAME::UpdateUserInterface(), 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 2634 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), frame(), FromProtoEnum(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetDisplayOptions(), PCB_BASE_FRAME::GetPcbNewSettings(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::IsMirroredX(), KIGFX::VIEW::IsMirroredY(), PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay, PCBNEW_SETTINGS::m_Display, PCB_DISPLAY_OPTIONS::m_NetColorMode, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_RatsnestMode, KIGFX::VIEW::RecacheAllItems(), EDA_DRAW_PANEL_GAL::Refresh(), HANDLER_CONTEXT< RequestMessageType >::Request, PCB_BASE_FRAME::SetDisplayOptions(), KIGFX::VIEW::SetMirror(), 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 1105 of file api_handler_pcb.cpp.

References LSET::AllCuMask(), B_CrtYd, board(), Edge_Cuts, F_CrtYd, frame(), Margin, MAX_CU_LAYERS, PCB_EDIT_FRAME::OnModify(), kiapi::board::PackLayerSet(), HANDLER_CONTEXT< RequestMessageType >::Request, TOOL_MANAGER::RunAction(), ACTIONS::selectionClear, toolManager(), kiapi::board::UnpackLayerSet(), PCB_EDIT_FRAME::UpdateUserInterface(), 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 1797 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), PCB_ACTIONS::drillSetOrigin, frame(), TOOLS_HOLDER::GetToolManager(), ACTIONS::gridSetOrigin, HANDLER_CONTEXT< RequestMessageType >::Request, TOOL_MANAGER::RunAction(), kiapi::common::UnpackVector2(), 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 1663 of file api_handler_pcb.cpp.

References PROJECT::AbsolutePath(), HANDLER_CONTEXT< RequestMessageType >::ClientName, context(), FILEEXT::DesignRulesFileExtension, DRC_RULE::FormatRuleFromProto(), BOARD_CONTEXT::GetBoard(), BOARD::GetFileName(), handleGetCustomDesignRules(), DRC_RULES_PARSER::Parse(), BOARD_CONTEXT::Prj(), HANDLER_CONTEXT< RequestMessageType >::Request, API_HANDLER_EDITOR::validateDocument(), and IO_ERROR::What().

Referenced by API_HANDLER_PCB().

◆ handleSetPageSettings()

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

Definition at line 522 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 439 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().

◆ handleSetVisibleLayers()

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

Definition at line 2521 of file api_handler_pcb.cpp.

References board(), API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), LSET::Contains(), frame(), FromProtoEnum(), PCB_BASE_EDIT_FRAME::GetAppearancePanel(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetEnabledLayers(), 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_PCB().

◆ handleUpdateItems()

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

Definition at line 266 of file api_handler_editor.cpp.

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

Referenced by API_HANDLER_EDITOR().

◆ isHeadless()

bool API_HANDLER_PCB::isHeadless ( ) const
inlineprivate

Definition at line 264 of file api_handler_pcb.h.

References frame().

◆ onModified()

void API_HANDLER_PCB::onModified ( )
overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 2051 of file api_handler_pcb.cpp.

References frame(), PCB_EDIT_FRAME::OnModify(), and PCB_EDIT_FRAME::UpdateUserInterface().

◆ parseRequestedItemTypes()

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

Definition at line 382 of file api_handler_editor.cpp.

References FromProtoEnum(), and TYPE_NOT_INIT.

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

◆ project()

PROJECT & API_HANDLER_PCB::project ( ) const
inlineprivate

Definition at line 258 of file api_handler_pcb.h.

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

Referenced by handleGetOpenDocuments(), handleRevertDocument(), and handleSaveCopyOfDocument().

◆ pushCurrentCommit()

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

Reimplemented from API_HANDLER_EDITOR.

Definition at line 363 of file api_handler_pcb.cpp.

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

Referenced by deleteItemsInternal(), and 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
RequestTypeis a protobuf message type containing a command
ResponseTypeis a protobuf message type containing a command response
HandlerTypeis the implied type of the API_HANDLER subclass
Parameters
aHandleris the handler function for the given request and response types

Definition at line 93 of file api_handler.h.

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

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

◆ setDrawingSheetFileName()

void API_HANDLER_PCB::setDrawingSheetFileName ( const wxString & aFileName)
overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 2042 of file api_handler_pcb.cpp.

References frame(), PCB_EDIT_FRAME::LoadDrawingSheet(), and BASE_SCREEN::m_DrawingSheetFileName.

◆ setPageSettings()

bool API_HANDLER_PCB::setPageSettings ( const PAGE_INFO & aPageInfo)
overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 2029 of file api_handler_pcb.cpp.

References 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 229 of file api_handler_pcb.h.

◆ toolManager()

TOOL_MANAGER * API_HANDLER_PCB::toolManager ( ) const
inlineprivate

Definition at line 260 of file api_handler_pcb.h.

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

Referenced by createCommit(), handleAddToSelection(), handleClearSelection(), handleGetSelection(), handleInteractiveMoveItems(), handleRefillZones(), handleRemoveFromSelection(), handleRunAction(), handleSaveSelectionToString(), and handleSetBoardEnabledLayers().

◆ tryUnpack()

template<typename MessageType>
bool API_HANDLER::tryUnpack ( ApiRequest & aRequest,
ApiResponse & aReply,
MessageType & aDest )
inlineprivateinherited

Definition at line 136 of file api_handler.h.

Referenced by registerHandler().

◆ validateDocument()

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

Definition at line 178 of file api_handler_editor.cpp.

References validateDocumentInternal().

Referenced by API_HANDLER_PCB::getItemFromDocument(), API_HANDLER_SCH::getItemFromDocument(), API_HANDLER_PCB::handleCheckPadstackPresenceOnLayers(), API_HANDLER_PCB::handleExpandTextVariables(), API_HANDLER_PCB::handleGetActiveLayer(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleGetBoardEnabledLayers(), API_HANDLER_PCB::handleGetBoardLayerName(), API_HANDLER_PCB::handleGetBoardOrigin(), API_HANDLER_PCB::handleGetCustomDesignRules(), API_HANDLER_PCB::handleGetGraphicsDefaults(), API_HANDLER_PCB::handleGetNets(), API_HANDLER_PCB::handleGetPadShapeAsPolygon(), handleGetPageSettings(), API_HANDLER_SCH::handleGetSchematicHierarchy(), API_HANDLER_SCH::handleGetSchematicNetlist(), API_HANDLER_PCB::handleGetStackup(), handleGetTitleBlockInfo(), API_HANDLER_PCB::handleGetVisibleLayers(), API_HANDLER_PCB::handleInjectDrcError(), API_HANDLER_PCB::handleInteractiveMoveItems(), API_HANDLER_PCB::handleParseAndCreateItemsFromString(), API_HANDLER_PCB::handleRefillZones(), API_HANDLER_PCB::handleRevertDocument(), API_HANDLER_PCB::handleRunBoardJobExport3D(), API_HANDLER_PCB::handleRunBoardJobExportDrill(), API_HANDLER_PCB::handleRunBoardJobExportDxf(), API_HANDLER_PCB::handleRunBoardJobExportGencad(), API_HANDLER_PCB::handleRunBoardJobExportGerbers(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), API_HANDLER_PCB::handleRunBoardJobExportIpcD356(), API_HANDLER_PCB::handleRunBoardJobExportODB(), API_HANDLER_PCB::handleRunBoardJobExportPdf(), API_HANDLER_PCB::handleRunBoardJobExportPosition(), API_HANDLER_PCB::handleRunBoardJobExportPs(), API_HANDLER_PCB::handleRunBoardJobExportRender(), 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::handleRunSchematicJobExportPs(), API_HANDLER_SCH::handleRunSchematicJobExportSvg(), API_HANDLER_PCB::handleSaveCopyOfDocument(), API_HANDLER_PCB::handleSaveDocument(), API_HANDLER_PCB::handleSaveDocumentToString(), API_HANDLER_PCB::handleSetActiveLayer(), API_HANDLER_PCB::handleSetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardEnabledLayers(), API_HANDLER_PCB::handleSetBoardOrigin(), API_HANDLER_PCB::handleSetCustomDesignRules(), handleSetPageSettings(), handleSetTitleBlockInfo(), API_HANDLER_PCB::handleSetVisibleLayers(), 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 392 of file api_handler_pcb.cpp.

References context().

◆ 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 193 of file api_handler_editor.cpp.

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

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

Member Data Documentation

◆ m_activeClients

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

Definition at line 147 of file api_handler_editor.h.

Referenced by API_HANDLER_PCB::deleteItemsInternal(), API_HANDLER_SCH::deleteItemsInternal(), handleBeginCommit(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), handleEndCommit(), and pushCurrentCommit().

◆ m_commits

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

Definition at line 145 of file api_handler_editor.h.

Referenced by getCurrentCommit(), handleBeginCommit(), handleEndCommit(), and pushCurrentCommit().

◆ m_context

std::shared_ptr<BOARD_CONTEXT> API_HANDLER_PCB::m_context
private

Definition at line 279 of file api_handler_pcb.h.

Referenced by API_HANDLER_PCB(), and context().

◆ m_defaultCommitMessage

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

Definition at line 131 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 149 of file api_handler_editor.h.

Referenced by API_HANDLER_EDITOR(), checkForBusy(), and API_HANDLER_PCB::frame().

◆ 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 129 of file api_handler.h.

Referenced by Handle(), and registerHandler().

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