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

#include <design_block.h>

Public Member Functions

void SetLibId (const LIB_ID &aName)
 
const LIB_ID & GetLibId () const
 
const wxString & GetLibDescription () const
 
void SetLibDescription (const wxString &aDesc)
 
const wxString & GetKeywords () const
 
void SetKeywords (const wxString &aKeywords)
 
const wxString & GetSchematicFile () const
 
void SetSchematicFile (const wxString &aFile)
 
const wxString & GetBoardFile () const
 
void SetBoardFile (const wxString &aFile)
 
const nlohmann::ordered_map< wxString, wxString > & GetFields () const
 
nlohmann::ordered_map< wxString, wxString > & GetFields ()
 
 DESIGN_BLOCK ()=default
 
 DESIGN_BLOCK (DESIGN_BLOCK &&aOther)=delete
 This is the only way to get m_fields to compile as a class member.
 

Private Attributes

LIB_ID m_lib_id
 
wxString m_schematicFile
 File name and path for schematic file.
 
wxString m_boardFile
 File name and path for board file.
 
wxString m_libDescription
 File name and path for documentation file.
 
wxString m_keywords
 Search keywords to find design block in library.
 
nlohmann::ordered_map< wxString, wxString > m_fields
 

Detailed Description

Definition at line 33 of file design_block.h.

Constructor & Destructor Documentation

◆ DESIGN_BLOCK() [1/2]

DESIGN_BLOCK::DESIGN_BLOCK ( )
default

Referenced by DESIGN_BLOCK().

◆ DESIGN_BLOCK() [2/2]

DESIGN_BLOCK::DESIGN_BLOCK ( DESIGN_BLOCK && aOther)
delete

This is the only way to get m_fields to compile as a class member.

References DESIGN_BLOCK().

Member Function Documentation

◆ GetBoardFile()

const wxString & DESIGN_BLOCK::GetBoardFile ( ) const
inline

Definition at line 48 of file design_block.h.

References m_boardFile.

Referenced by DESIGN_BLOCK_IO::DesignBlockSave(), and PCB_DESIGN_BLOCK_PREVIEW_WIDGET::DisplayDesignBlock().

◆ GetFields() [1/2]

nlohmann::ordered_map< wxString, wxString > & DESIGN_BLOCK::GetFields ( )
inline

Definition at line 52 of file design_block.h.

References m_fields.

◆ GetFields() [2/2]

const nlohmann::ordered_map< wxString, wxString > & DESIGN_BLOCK::GetFields ( ) const
inline

Definition at line 51 of file design_block.h.

References m_fields.

Referenced by DESIGN_BLOCK_IO::DesignBlockLoad(), DESIGN_BLOCK_IO::DesignBlockSave(), DESIGN_BLOCK_TREE_MODEL_ADAPTER::GenerateInfo(), and SCH_EDIT_FRAME::SaveSheetAsDesignBlock().

◆ GetKeywords()

const wxString & DESIGN_BLOCK::GetKeywords ( ) const
inline

Definition at line 42 of file design_block.h.

References m_keywords.

Referenced by DESIGN_BLOCK_IO::DesignBlockSave(), and DESIGN_BLOCK_TREE_MODEL_ADAPTER::GenerateInfo().

◆ GetLibDescription()

const wxString & DESIGN_BLOCK::GetLibDescription ( ) const
inline

Definition at line 39 of file design_block.h.

References m_libDescription.

Referenced by DESIGN_BLOCK_IO::DesignBlockSave(), and DESIGN_BLOCK_TREE_MODEL_ADAPTER::GenerateInfo().

◆ GetLibId()

const LIB_ID & DESIGN_BLOCK::GetLibId ( ) const
inline

Definition at line 37 of file design_block.h.

References m_lib_id.

Referenced by PCB_CONTROL::AppendBoard(), DESIGN_BLOCK_IO::DesignBlockSave(), DESIGN_BLOCK_LIB_TABLE::DesignBlockSave(), PCB_EDIT_FRAME::SaveBoardAsDesignBlock(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_EDIT_FRAME::saveSelectionToDesignBlock(), SCH_EDIT_FRAME::SaveSheetAsDesignBlock(), and setLibNickname().

◆ GetSchematicFile()

const wxString & DESIGN_BLOCK::GetSchematicFile ( ) const
inline

Definition at line 45 of file design_block.h.

References m_schematicFile.

Referenced by DESIGN_BLOCK_IO::DesignBlockSave(), and SCH_DESIGN_BLOCK_PREVIEW_WIDGET::DisplayDesignBlock().

◆ SetBoardFile()

void DESIGN_BLOCK::SetBoardFile ( const wxString & aFile)
inline

Definition at line 49 of file design_block.h.

References m_boardFile.

Referenced by DESIGN_BLOCK_IO::DesignBlockLoad(), PCB_EDIT_FRAME::SaveBoardAsDesignBlock(), and PCB_EDIT_FRAME::saveSelectionToDesignBlock().

◆ SetKeywords()

void DESIGN_BLOCK::SetKeywords ( const wxString & aKeywords)
inline

Definition at line 43 of file design_block.h.

References m_keywords.

Referenced by DESIGN_BLOCK_IO::DesignBlockLoad().

◆ SetLibDescription()

void DESIGN_BLOCK::SetLibDescription ( const wxString & aDesc)
inline

Definition at line 40 of file design_block.h.

References m_libDescription.

Referenced by DESIGN_BLOCK_IO::DesignBlockLoad().

◆ SetLibId()

void DESIGN_BLOCK::SetLibId ( const LIB_ID & aName)
inline

Definition at line 36 of file design_block.h.

References m_lib_id.

Referenced by DESIGN_BLOCK_IO::DesignBlockLoad(), PCB_EDIT_FRAME::SaveBoardAsDesignBlock(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), and SCH_EDIT_FRAME::SaveSheetAsDesignBlock().

◆ SetSchematicFile()

void DESIGN_BLOCK::SetSchematicFile ( const wxString & aFile)
inline

Definition at line 46 of file design_block.h.

References m_schematicFile.

Referenced by DESIGN_BLOCK_IO::DesignBlockLoad(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), and SCH_EDIT_FRAME::SaveSheetAsDesignBlock().

Member Data Documentation

◆ m_boardFile

wxString DESIGN_BLOCK::m_boardFile
private

File name and path for board file.

Definition at line 62 of file design_block.h.

Referenced by GetBoardFile(), and SetBoardFile().

◆ m_fields

nlohmann::ordered_map<wxString, wxString> DESIGN_BLOCK::m_fields
private

Definition at line 66 of file design_block.h.

Referenced by GetFields(), and GetFields().

◆ m_keywords

wxString DESIGN_BLOCK::m_keywords
private

Search keywords to find design block in library.

Definition at line 64 of file design_block.h.

Referenced by GetKeywords(), and SetKeywords().

◆ m_lib_id

LIB_ID DESIGN_BLOCK::m_lib_id
private

Definition at line 60 of file design_block.h.

Referenced by GetLibId(), and SetLibId().

◆ m_libDescription

wxString DESIGN_BLOCK::m_libDescription
private

File name and path for documentation file.

Definition at line 63 of file design_block.h.

Referenced by GetLibDescription(), and SetLibDescription().

◆ m_schematicFile

wxString DESIGN_BLOCK::m_schematicFile
private

File name and path for schematic file.

Definition at line 61 of file design_block.h.

Referenced by GetSchematicFile(), and SetSchematicFile().

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