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 | Private Attributes | List of all members
API_HANDLER_PCB Class Reference

#include <api_handler_pcb.h>

Inheritance diagram for API_HANDLER_PCB:
API_HANDLER_BOARD API_HANDLER_EDITOR API_HANDLER

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.
 

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

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 > 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< 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< 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< 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)
 
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< 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< 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< 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 38 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 45 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 86 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 92 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::API_HANDLER_BOARD(), handleGetBoardDesignRules(), handleGetBoardEditorAppearanceSettings(), handleGetBoardLayerName(), handleGetBoardOrigin(), handleGetConnectedItems(), handleGetCustomDesignRules(), handleGetItems(), handleGetItemsByNet(), handleGetItemsByNetClass(), handleGetNetClassForNets(), handleGetNets(), handleGetOpenDocuments(), API_HANDLER_EDITOR::handleGetPageSettings(), handleInjectDrcError(), handleRefillZones(), handleRevertDocument(), handleRunBoardJobExport3D(), handleRunBoardJobExportDrill(), handleRunBoardJobExportDxf(), handleRunBoardJobExportGencad(), handleRunBoardJobExportGerbers(), handleRunBoardJobExportIpc2581(), handleRunBoardJobExportIpcD356(), handleRunBoardJobExportODB(), handleRunBoardJobExportPdf(), handleRunBoardJobExportPosition(), handleRunBoardJobExportPs(), handleRunBoardJobExportRender(), handleRunBoardJobExportStats(), handleRunBoardJobExportSvg(), handleSaveCopyOfDocument(), handleSaveDocument(), handleSetBoardDesignRules(), handleSetBoardEditorAppearanceSettings(), handleSetBoardEnabledLayers(), handleSetBoardOrigin(), handleSetCustomDesignRules(), API_HANDLER_EDITOR::handleSetPageSettings(), move, and API_HANDLER::registerHandler().

Member Function Documentation

◆ board()

BOARD * API_HANDLER_BOARD::board ( ) const
inlineprotectedinherited

Definition at line 78 of file api_handler_board.h.

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

Referenced by deleteItemsInternal(), getDefaultContainer(), API_HANDLER_FOOTPRINT::getDefaultContainer(), getItemById(), handleCreateUpdateItemsInternal(), handleExpandTextVariables(), API_HANDLER_PCB::handleGetBoardDesignRules(), handleGetBoardEnabledLayers(), API_HANDLER_PCB::handleGetBoardLayerName(), API_HANDLER_PCB::handleGetBoardOrigin(), API_HANDLER_PCB::handleGetConnectedItems(), 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(), handleGetStackup(), handleGetVisibleLayers(), API_HANDLER_PCB::handleRevertDocument(), API_HANDLER_PCB::handleSaveCopyOfDocument(), handleSaveDocumentToString(), handleSaveSelectionToString(), handleSetActiveLayer(), API_HANDLER_PCB::handleSetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardEnabledLayers(), handleSetVisibleLayers(), and API_HANDLER_FOOTPRINT::validateAndGetFootprint().

◆ 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_BOARD::handleAddToSelection(), handleBeginCommit(), API_HANDLER_BOARD::handleClearSelection(), handleCreateItems(), handleDeleteItems(), handleEndCommit(), API_HANDLER_BOARD::handleGetBoundingBox(), API_HANDLER_PCB::handleGetConnectedItems(), API_HANDLER_FOOTPRINT::handleGetItems(), API_HANDLER_PCB::handleGetItems(), API_HANDLER_SCH::handleGetItems(), API_HANDLER_BOARD::handleGetItemsById(), API_HANDLER_SCH::handleGetItemsById(), API_HANDLER_PCB::handleGetItemsByNet(), API_HANDLER_PCB::handleGetItemsByNetClass(), API_HANDLER_SCH::handleGetSchematicNetlist(), handleHitTest(), API_HANDLER_PCB::handleInjectDrcError(), API_HANDLER_BOARD::handleInteractiveMoveItems(), API_HANDLER_BOARD::handleParseAndCreateItemsFromString(), API_HANDLER_PCB::handleRefillZones(), API_HANDLER_BOARD::handleRemoveFromSelection(), API_HANDLER_FOOTPRINT::handleRevertDocument(), API_HANDLER_PCB::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::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_BOARD::handleSetActiveLayer(), API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), API_HANDLER_PCB::handleSetBoardOrigin(), 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 97 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::m_frame.

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

◆ context()

BOARD_CONTEXT * API_HANDLER_BOARD::context ( ) const
inlineprotectedinherited

Definition at line 76 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 126 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::m_frame, and toolManager().

◆ createItemForType()

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

Definition at line 146 of file api_handler_board.cpp.

References CreateItemForType(), EDA_ITEM::GetFriendlyName(), PCB_FOOTPRINT_T, and PCB_PAD_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 189 of file api_handler_board.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 161 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::m_frame.

Referenced by handleGetBoardEditorAppearanceSettings(), handleRefillZones(), handleRevertDocument(), handleSetBoardDesignRules(), handleSetBoardEditorAppearanceSettings(), handleSetBoardEnabledLayers(), handleSetBoardOrigin(), onModified(), 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_BOARD::deleteItemsInternal(), API_HANDLER_SCH::deleteItemsInternal(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handleInjectDrcError(), and API_HANDLER_BOARD::handleInteractiveMoveItems().

◆ getDefaultContainer()

BOARD_ITEM_CONTAINER * API_HANDLER_BOARD::getDefaultContainer ( )
protectedvirtualinherited

Reimplemented in API_HANDLER_FOOTPRINT.

Definition at line 110 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 1232 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 135 of file api_handler_board.cpp.

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

Referenced by getItemFromDocument(), handleAddToSelection(), handleCheckPadstackPresenceOnLayers(), handleCreateUpdateItemsInternal(), handleGetBoundingBox(), API_HANDLER_PCB::handleGetConnectedItems(), handleGetItemsById(), handleGetPadShapeAsPolygon(), handleInteractiveMoveItems(), 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 217 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.

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 1219 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 ( )
overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1213 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
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_BOARD::handleAddToSelection ( const HANDLER_CONTEXT< commands::AddToSelection > & aCtx)
privateinherited

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

◆ 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_BOARD::handleCheckPadstackPresenceOnLayers ( const HANDLER_CONTEXT< CheckPadstackPresenceOnLayers > & aCtx)
privateinherited

Definition at line 824 of file api_handler_board.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_BOARD().

◆ handleClearSelection()

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

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

◆ 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_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 227 of file api_handler_board.cpp.

References _, COMMIT::Add(), EDA_GROUP::AddItem(), KIID::AsStdString(), board(), BOARD_ITEM::CopyFrom(), createItemForType(), API_HANDLER_EDITOR::getCurrentCommit(), getDefaultContainer(), 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_BOARD::handleExpandTextVariables ( const HANDLER_CONTEXT< commands::ExpandTextVariables > & aCtx)
privateinherited

Definition at line 891 of file api_handler_board.cpp.

References board(), ExpandTextVars(), HANDLER_CONTEXT< RequestMessageType >::Request, text, 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 1086 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().

◆ handleGetBoardDesignRules()

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

Definition at line 557 of file api_handler_pcb.cpp.

References PROJECT::AbsolutePath(), API_HANDLER_BOARD::board(), 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(), pcbContext(), 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 1558 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 679 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().

◆ handleGetBoardLayerName()

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

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

◆ handleGetBoundingBox()

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

Definition at line 748 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 1303 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, 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 908 of file api_handler_pcb.cpp.

References PROJECT::AbsolutePath(), 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, pcbContext(), 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_BOARD::handleGetGraphicsDefaults ( const HANDLER_CONTEXT< GetGraphicsDefaults > & aCtx)
privateinherited

Definition at line 708 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 319 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), API_HANDLER_BOARD::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_BOARD::handleGetItemsById ( const HANDLER_CONTEXT< commands::GetItemsById > & aCtx)
privateinherited

Definition at line 466 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 1370 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 1425 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 1503 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 1258 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 167 of file api_handler_pcb.cpp.

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

Referenced by API_HANDLER_PCB().

◆ handleGetPadShapeAsPolygon()

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

Definition at line 789 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 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_BOARD::handleGetSelection ( const HANDLER_CONTEXT< commands::GetSelection > & aCtx)
privateinherited

Definition at line 509 of file api_handler_board.cpp.

References checkForHeadless(), filter, PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), parseRequestedItemTypes(), 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 648 of file api_handler_board.cpp.

References board(), FromProtoEnum(), BOARD::GetStackupOrDefault(), HANDLER_CONTEXT< RequestMessageType >::Request, BOARD_STACKUP::Serialize(), UNDEFINED_LAYER, 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 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_BOARD::handleGetVisibleLayers ( const HANDLER_CONTEXT< GetVisibleLayers > & aCtx)
privateinherited

Definition at line 1030 of file api_handler_board.cpp.

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

Referenced by API_HANDLER_BOARD().

◆ 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 1626 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_BOARD::handleInteractiveMoveItems ( const HANDLER_CONTEXT< InteractiveMoveItems > & aCtx)
privateinherited

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

◆ handleRefillZones()

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

Definition at line 1528 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), frame(), HANDLER_CONTEXT< RequestMessageType >::Request, TOOL_MANAGER::RunAction(), API_HANDLER_BOARD::toolManager(), API_HANDLER_EDITOR::validateDocument(), 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 608 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().

◆ handleRevertDocument()

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

Definition at line 270 of file api_handler_pcb.cpp.

References PROJECT::AbsolutePath(), API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), API_HANDLER_BOARD::checkForHeadless(), frame(), PCB_BASE_FRAME::GetScreen(), KICTL_REVERT, PCB_EDIT_FRAME::OpenProjectFiles(), API_HANDLER_BOARD::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_BOARD::handleRunAction ( const HANDLER_CONTEXT< commands::RunAction > & aCtx)
privateinherited

Definition at line 446 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 1800 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 2094 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 1941 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 2206 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 2050 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_CONTEXT::GetCurrentFileName(), JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_PLOT::m_plotLayerSequence, pcbContext(), 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 2231 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_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, 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 2272 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 2291 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteBoardJob(), FromProtoEnum(), PCB_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, 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 1983 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().

◆ handleRunBoardJobExportPosition()

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

Definition at line 2161 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 2013 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 1859 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().

◆ handleRunBoardJobExportStats()

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

Definition at line 2324 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 1907 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 210 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, PCB_CONTEXT::SaveBoard(), PCB_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 194 of file api_handler_pcb.cpp.

References API_HANDLER_EDITOR::checkForBusy(), pcbContext(), HANDLER_CONTEXT< RequestMessageType >::Request, PCB_CONTEXT::SaveBoard(), 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 964 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 988 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(), and toolManager().

Referenced by API_HANDLER_BOARD().

◆ handleSetActiveLayer()

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

Definition at line 1107 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 712 of file api_handler_pcb.cpp.

References API_HANDLER_BOARD::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 1588 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(), 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 484 of file api_handler_pcb.cpp.

References LSET::AllCuMask(), B_CrtYd, API_HANDLER_BOARD::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, API_HANDLER_BOARD::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 1136 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 1002 of file api_handler_pcb.cpp.

References PROJECT::AbsolutePath(), HANDLER_CONTEXT< RequestMessageType >::ClientName, FILEEXT::DesignRulesFileExtension, DRC_RULE::FormatRuleFromProto(), BOARD_CONTEXT::GetBoard(), BOARD::GetFileName(), handleGetCustomDesignRules(), DRC_RULES_PARSER::Parse(), pcbContext(), 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_BOARD::handleSetVisibleLayers ( const HANDLER_CONTEXT< SetVisibleLayers > & aCtx)
privateinherited

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

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

◆ onModified()

void API_HANDLER_PCB::onModified ( )
overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1247 of file api_handler_pcb.cpp.

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

◆ parseRequestedItemTypes()

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

Definition at line 428 of file api_handler_board.cpp.

References FromProtoEnum(), and TYPE_NOT_INIT.

Referenced by API_HANDLER_PCB::handleGetConnectedItems(), 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 172 of file api_handler_pcb.h.

References API_HANDLER_BOARD::context().

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

◆ project()

PROJECT & API_HANDLER_BOARD::project ( ) const
inlineprotectedinherited

Definition at line 80 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::handleRevertDocument(), 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 116 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::m_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_BOARD::API_HANDLER_BOARD(), API_HANDLER_COMMON::API_HANDLER_COMMON(), API_HANDLER_EDITOR::API_HANDLER_EDITOR(), API_HANDLER_FOOTPRINT::API_HANDLER_FOOTPRINT(), 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 1238 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 1225 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 152 of file api_handler_pcb.h.

◆ toolManager()

TOOL_MANAGER * API_HANDLER_BOARD::toolManager ( ) const
inlineprotectedinherited

Definition at line 82 of file api_handler_board.h.

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

Referenced by createCommit(), handleAddToSelection(), handleClearSelection(), handleGetSelection(), handleInteractiveMoveItems(), API_HANDLER_PCB::handleRefillZones(), handleRemoveFromSelection(), handleRunAction(), handleSaveSelectionToString(), and API_HANDLER_PCB::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_BOARD::getItemFromDocument(), API_HANDLER_SCH::getItemFromDocument(), API_HANDLER_BOARD::handleCheckPadstackPresenceOnLayers(), API_HANDLER_BOARD::handleExpandTextVariables(), API_HANDLER_BOARD::handleGetActiveLayer(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_BOARD::handleGetBoardEnabledLayers(), API_HANDLER_PCB::handleGetBoardLayerName(), API_HANDLER_PCB::handleGetBoardOrigin(), API_HANDLER_PCB::handleGetCustomDesignRules(), 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_BOARD::handleGetVisibleLayers(), API_HANDLER_PCB::handleInjectDrcError(), API_HANDLER_BOARD::handleInteractiveMoveItems(), API_HANDLER_BOARD::handleParseAndCreateItemsFromString(), API_HANDLER_PCB::handleRefillZones(), API_HANDLER_FOOTPRINT::handleRevertDocument(), 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_BOARD::handleSaveDocumentToString(), API_HANDLER_BOARD::handleSetActiveLayer(), API_HANDLER_PCB::handleSetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardEnabledLayers(), API_HANDLER_PCB::handleSetBoardOrigin(), API_HANDLER_PCB::handleSetCustomDesignRules(), handleSetPageSettings(), handleSetTitleBlockInfo(), 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 294 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 193 of file api_handler_editor.cpp.

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

Referenced by API_HANDLER_BOARD::handleAddToSelection(), handleBeginCommit(), API_HANDLER_BOARD::handleClearSelection(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), handleDeleteItems(), handleEndCommit(), API_HANDLER_BOARD::handleGetBoundingBox(), API_HANDLER_PCB::handleGetConnectedItems(), API_HANDLER_FOOTPRINT::handleGetItems(), API_HANDLER_PCB::handleGetItems(), API_HANDLER_SCH::handleGetItems(), API_HANDLER_BOARD::handleGetItemsById(), API_HANDLER_SCH::handleGetItemsById(), API_HANDLER_PCB::handleGetItemsByNet(), API_HANDLER_PCB::handleGetItemsByNetClass(), API_HANDLER_BOARD::handleGetSelection(), handleHitTest(), and API_HANDLER_BOARD::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_BOARD::deleteItemsInternal(), API_HANDLER_SCH::deleteItemsInternal(), handleBeginCommit(), API_HANDLER_BOARD::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_BOARD::m_context
privateinherited

Definition at line 160 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 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(), API_HANDLER_BOARD::checkForHeadless(), API_HANDLER_BOARD::createCommit(), API_HANDLER_FOOTPRINT::frame(), API_HANDLER_PCB::frame(), API_HANDLER_BOARD::handleAddToSelection(), API_HANDLER_BOARD::handleClearSelection(), API_HANDLER_BOARD::handleGetActiveLayer(), API_HANDLER_BOARD::handleRemoveFromSelection(), API_HANDLER_BOARD::handleSetActiveLayer(), API_HANDLER_BOARD::handleSetVisibleLayers(), and API_HANDLER_BOARD::pushCurrentCommit().

◆ 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: