KiCad PCB EDA Suite
CADSTAR_ARCHIVE_PARSER::PARSER_CONTEXT Struct Reference

#include <cadstar_archive_parser.h>

Public Attributes

std::map< wxString, wxString > FilenamesToTextMap
 CADSTAR doesn't have user defined text fields but does allow loading text from a file. More...
 
std::map< wxString, wxString > TextToHyperlinksMap
 KiCad doesn't support hyperlinks but we use this map to display warning messages after import. More...
 
std::map< TEXT_FIELD_NAME, wxString > TextFieldToValuesMap
 Values for the text field elements used in the CADSTAR design extracted from the text element instances. More...
 
std::set< TEXT_FIELD_NAMEInconsistentTextFields
 Text fields need to be updated in CADSTAR and it is possible that they are not consistent across text elements. More...
 
std::function< void()> CheckPointCallback = []() {}
 Callback function to report progress. More...
 

Detailed Description

Definition at line 167 of file cadstar_archive_parser.h.

Member Data Documentation

◆ CheckPointCallback

◆ FilenamesToTextMap

std::map<wxString, wxString> CADSTAR_ARCHIVE_PARSER::PARSER_CONTEXT::FilenamesToTextMap

CADSTAR doesn't have user defined text fields but does allow loading text from a file.

This map stores all the text items that exist in the original CADSTAR design. They will be replaced by a text variable of the form ${FROM_FILE_[filename]_[extension]}

Definition at line 174 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), CADSTAR_PCB_ARCHIVE_LOADER::loadTextVariables(), and CADSTAR_ARCHIVE_PARSER::ParseTextFields().

◆ InconsistentTextFields

std::set<TEXT_FIELD_NAME> CADSTAR_ARCHIVE_PARSER::PARSER_CONTEXT::InconsistentTextFields

Text fields need to be updated in CADSTAR and it is possible that they are not consistent across text elements.

Definition at line 192 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), CADSTAR_PCB_ARCHIVE_LOADER::loadTextVariables(), and CADSTAR_ARCHIVE_PARSER::ParseTextFields().

◆ TextFieldToValuesMap

std::map<TEXT_FIELD_NAME, wxString> CADSTAR_ARCHIVE_PARSER::PARSER_CONTEXT::TextFieldToValuesMap

Values for the text field elements used in the CADSTAR design extracted from the text element instances.

Definition at line 186 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), CADSTAR_PCB_ARCHIVE_LOADER::loadTextVariables(), and CADSTAR_ARCHIVE_PARSER::ParseTextFields().

◆ TextToHyperlinksMap

std::map<wxString, wxString> CADSTAR_ARCHIVE_PARSER::PARSER_CONTEXT::TextToHyperlinksMap

KiCad doesn't support hyperlinks but we use this map to display warning messages after import.

First element = Display Text. Second element = Hyperlink

Definition at line 180 of file cadstar_archive_parser.h.

Referenced by CADSTAR_ARCHIVE_PARSER::ParseTextFields().


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