SCH_IO_ALTIUM Class Reference

#include <sch_io_altium.h>

Inheritance diagram for SCH_IO_ALTIUM:

Public Member Functions
	SCH_IO_ALTIUM ()
	~SCH_IO_ALTIUM ()
const IO_BASE::IO_FILE_DESC	GetSchematicFileDesc () const override
	Returns schematic file description for the SCH_IO.
const IO_BASE::IO_FILE_DESC	GetLibraryDesc () const override
	Get the descriptor for the library container that this IO plugin operates on.
bool	CanReadSchematicFile (const wxString &aFileName) const override
	Checks if this SCH_IO can read the specified schematic file.
bool	CanReadLibrary (const wxString &aFileName) const override
	Checks if this IO object can read the specified library file/directory.
int	GetModifyHash () const override
	Return the modification hash from the library cache.
SCH_SHEET *	LoadSchematicFile (const wxString &aFileName, SCHEMATIC *aSchematic, SCH_SHEET *aAppendToMe=nullptr, const std::map< std::string, UTF8 > *aProperties=nullptr) override
	Load information from some input file format that this SCH_IO implementation knows about, into either a new SCH_SHEET or an existing one.
void	EnumerateSymbolLib (wxArrayString &aSymbolNameList, const wxString &aLibraryPath, const std::map< std::string, UTF8 > *aProperties=nullptr) override
	Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath.
void	EnumerateSymbolLib (std::vector< LIB_SYMBOL * > &aSymbolList, const wxString &aLibraryPath, const std::map< std::string, UTF8 > *aProperties=nullptr) override
	Populate a list of LIB_SYMBOL aliases contained within the library aLibraryPath.
LIB_SYMBOL *	LoadSymbol (const wxString &aLibraryPath, const wxString &aAliasName, const std::map< std::string, UTF8 > *aProperties=nullptr) override
	Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this SCH_IO knows about.
bool	IsLibraryWritable (const wxString &aLibraryPath) override
	Return true if the library at aLibraryPath is writable.
wxString	getLibName ()
wxFileName	getLibFileName ()
void	ParseAltiumSch (const wxString &aFileName)
void	ParseStorage (const ALTIUM_COMPOUND_FILE &aAltiumSchFile)
void	ParseAdditional (const ALTIUM_COMPOUND_FILE &aAltiumSchFile)
void	ParseFileHeader (const ALTIUM_COMPOUND_FILE &aAltiumSchFile)
void	ParseASCIISchematic (const wxString &aFileName)
void	ParseRecord (int index, std::map< wxString, wxString > &properties, const wxString &aSectionName)
virtual void	SaveLibrary (const wxString &aFileName, const std::map< std::string, UTF8 > *aProperties=nullptr)
virtual void	SaveSchematicFile (const wxString &aFileName, SCH_SHEET *aSheet, SCHEMATIC *aSchematic, const std::map< std::string, UTF8 > *aProperties=nullptr)
	Write aSchematic to a storage file in a format that this SCH_IO implementation knows about, or it can be used to write a portion of aSchematic to a special kind of export file.
virtual void	SaveSymbol (const wxString &aLibraryPath, const LIB_SYMBOL *aSymbol, const std::map< std::string, UTF8 > *aProperties=nullptr)
	Write aSymbol to an existing library located at aLibraryPath.
virtual void	DeleteSymbol (const wxString &aLibraryPath, const wxString &aSymbolName, const std::map< std::string, UTF8 > *aProperties=nullptr)
	Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath.
virtual void	GetLibraryOptions (std::map< std::string, UTF8 > *aListToAppendTo) const override
	Append supported SCH_IO options to aListToAppenTo along with internationalized descriptions.
virtual bool	SupportsSubLibraries () const
virtual void	GetSubLibraryNames (std::vector< wxString > &aNames)
	Retrieves a list of sub-libraries in this library.
virtual wxString	GetSubLibraryDescription (const wxString &aName)
	Gets a description of a sublibrary.
virtual void	GetAvailableSymbolFields (std::vector< wxString > &aNames)
	Retrieves a list of (custom) field names that are present on symbols in this library.
virtual void	GetDefaultSymbolFields (std::vector< wxString > &aNames)
	Retrieves a list of (custom) field names that should be shown by default for this library in the symbol chooser.
virtual const wxString &	GetError () const
	Return an error string to the caller.
virtual void	SetLibTable (SYMBOL_LIB_TABLE *aTable)
	Some library plugins need to have access to their parent library table.
const wxString &	GetName () const
	Return a brief hard coded name for this IO interface.
virtual void	SetReporter (REPORTER *aReporter)
	Set an optional reporter for warnings/errors.
virtual void	SetProgressReporter (PROGRESS_REPORTER *aReporter)
	Set an optional progress reporter.
virtual const IO_FILE_DESC	GetLibraryFileDesc () const
	Get the descriptor for the individual library elements that this IO plugin operates on.
virtual void	CreateLibrary (const wxString &aLibraryPath, const std::map< std::string, UTF8 > *aProperties=nullptr)
	Create a new empty library at aLibraryPath empty.
virtual bool	DeleteLibrary (const wxString &aLibraryPath, const std::map< std::string, UTF8 > *aProperties=nullptr)
	Delete an existing library and returns true, or if library does not exist returns false, or throws an exception if library exists but is read only or cannot be deleted for some other reason.
virtual void	Report (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
virtual void	AdvanceProgressPhase ()

Protected Attributes
wxString	m_name
	Name of the IO loader.
REPORTER *	m_reporter
	Reporter to log errors/warnings to, may be nullptr.
PROGRESS_REPORTER *	m_progressReporter
	Progress reporter to track the progress of the operation, may be nullptr.

Private Member Functions
SCH_SCREEN *	getCurrentScreen ()
SCH_SHEET *	getCurrentSheet ()
bool	ShouldPutItemOnSheet (int aOwnerindex)
bool	IsComponentPartVisible (const ASCH_OWNER_INTERFACE &aElem) const
const ASCH_STORAGE_FILE *	GetFileFromStorage (const wxString &aFilename) const
void	AddTextBox (const ASCH_TEXT_FRAME *aElem)
void	AddLibTextBox (const ASCH_TEXT_FRAME *aElem, std::vector< LIB_SYMBOL * > &aSymbol=nullsym, std::vector< int > &aFontSize=nullint)
void	ParseComponent (int aIndex, const std::map< wxString, wxString > &aProperties)
void	ParseTemplate (int aIndex, const std::map< wxString, wxString > &aProperties)
void	ParsePin (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParseLabel (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym, std::vector< int > &aFontSize=nullint)
void	ParseTextFrame (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym, std::vector< int > &aFontSize=nullint)
void	ParseNote (const std::map< wxString, wxString > &aProperties)
void	ParseBezier (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParsePolyline (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParsePolygon (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParseRoundRectangle (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParseArc (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParseEllipticalArc (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParseEllipse (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParseCircle (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParseLine (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParseSignalHarness (const std::map< wxString, wxString > &aProperties)
void	ParseHarnessConnector (int aIndex, const std::map< wxString, wxString > &aProperties)
void	ParseHarnessEntry (const std::map< wxString, wxString > &aProperties)
void	ParseHarnessType (const std::map< wxString, wxString > &aProperties)
void	ParseHarnessPort (const ASCH_PORT &aElem)
void	ParseHyperlink (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParsePieChart (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParseRectangle (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParseSheetSymbol (int aIndex, const std::map< wxString, wxString > &aProperties)
void	ParseSheetEntry (const std::map< wxString, wxString > &aProperties)
void	ParsePowerPort (const std::map< wxString, wxString > &aProperties)
void	ParsePort (const ASCH_PORT &aElem)
void	ParseNoERC (const std::map< wxString, wxString > &aProperties)
void	ParseNetLabel (const std::map< wxString, wxString > &aProperties)
void	ParseBus (const std::map< wxString, wxString > &aProperties)
void	ParseWire (const std::map< wxString, wxString > &aProperties)
void	ParseJunction (const std::map< wxString, wxString > &aProperties)
void	ParseImage (const std::map< wxString, wxString > &aProperties)
void	ParseSheet (const std::map< wxString, wxString > &aProperties)
void	ParseSheetName (const std::map< wxString, wxString > &aProperties)
void	ParseFileName (const std::map< wxString, wxString > &aProperties)
void	ParseDesignator (const std::map< wxString, wxString > &aProperties)
void	ParseLibDesignator (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym, std::vector< int > &aFontSize=nullint)
void	ParseBusEntry (const std::map< wxString, wxString > &aProperties)
void	ParseParameter (const std::map< wxString, wxString > &aProperties)
void	ParseLibParameter (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym, std::vector< int > &aFontSize=nullint)
void	ParseImplementationList (int aIndex, const std::map< wxString, wxString > &aProperties)
void	ParseImplementation (const std::map< wxString, wxString > &aProperties, std::vector< LIB_SYMBOL * > &aSymbol=nullsym)
void	ParseLibHeader (const ALTIUM_COMPOUND_FILE &aAltiumSchFile, std::vector< int > &aFontSizes)
std::map< wxString, LIB_SYMBOL * >	ParseLibFile (const ALTIUM_COMPOUND_FILE &aAltiumSchFile)
std::vector< LIB_SYMBOL * >	ParseLibComponent (const std::map< wxString, wxString > &aProperties)
void	doEnumerateSymbolLib (const wxString &aLibraryPath, const std::map< std::string, UTF8 > *aProperties, std::function< void(const wxString &, LIB_SYMBOL *)> aInserter)
void	fixupSymbolPinNameNumbers (SYMBOL *aSymbol)
void	ensureLoadedLibrary (const wxString &aLibraryPath, const std::map< std::string, UTF8 > *aProperties)
long long	getLibraryTimestamp (const wxString &aLibraryPath) const

Static Private Member Functions
static bool	isBinaryFile (const wxString &aFileName)
static bool	isASCIIFile (const wxString &aFileName)
static bool	checkFileHeader (const wxString &aFileName)

Private Attributes
SCH_SHEET *	m_rootSheet
SCH_SHEET_PATH	m_sheetPath
SCHEMATIC *	m_schematic
wxString	m_libName
bool	m_isIntLib
IO_RELEASER< SCH_IO >	m_pi
std::unique_ptr< std::map< std::string, UTF8 > >	m_properties
std::unique_ptr< TITLE_BLOCK >	m_currentTitleBlock
VECTOR2I	m_sheetOffset
std::unique_ptr< ASCH_SHEET >	m_altiumSheet
std::map< int, SCH_SYMBOL * >	m_symbols
std::map< int, SCH_SHEET * >	m_sheets
std::map< int, LIB_SYMBOL * >	m_libSymbols
std::map< wxString, LIB_SYMBOL * >	m_powerSymbols
std::vector< ASCH_STORAGE_FILE >	m_altiumStorage
std::vector< ASCH_ADDITIONAL_FILE >	m_altiumAdditional
std::map< int, ASCH_SYMBOL >	m_altiumComponents
std::map< int, ASCH_TEMPLATE >	m_altiumTemplates
std::map< int, int >	m_altiumImplementationList
std::vector< ASCH_PORT >	m_altiumPortsCurrentSheet
std::vector< ASCH_PORT >	m_altiumHarnessPortsCurrentSheet
int	m_harnessOwnerIndexOffset
int	m_harnessEntryParent
std::map< wxString, long long >	m_timestamps
std::map< wxString, std::map< wxString, LIB_SYMBOL * > >	m_libCache
std::vector< std::pair< wxString, int > >	m_fonts

Detailed Description

Definition at line 56 of file sch_io_altium.h.

Constructor & Destructor Documentation

SCH_IO_ALTIUM()

SCH_IO_ALTIUM::SCH_IO_ALTIUM

(

)

Definition at line 244 of file sch_io_altium.cpp.

References WXLOG_REPORTER::GetInstance(), m_harnessEntryParent, m_harnessOwnerIndexOffset, m_isIntLib, IO_BASE::m_reporter, m_rootSheet, and m_schematic.

~SCH_IO_ALTIUM()

SCH_IO_ALTIUM::~SCH_IO_ALTIUM

(

)

Definition at line 257 of file sch_io_altium.cpp.

References m_libCache, and name.

Member Function Documentation

AddLibTextBox()

void SCH_IO_ALTIUM::AddLibTextBox ( const ASCH_TEXT_FRAME *  aElem, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym, std::vector< int > &  aFontSize = nullint  )

private

Handle text frames that are in a library symbol, not on schematic

Definition at line 1711 of file sch_io_altium.cpp.

References LIB_SYMBOL::AddDrawItem(), ASCH_TEXT_FRAME::Alignment, ASCH_TEXT_FRAME::AreaColor, ASCH_TEXT_FRAME::BorderColor, ASCH_TEXT_FRAME::BottomLeft, ASCH_TEXT_FRAME::FontID, GetColorFromInt(), GetRelativePosition(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, ASCH_TEXT_FRAME::isSolid, LAYER_DEVICE, m_libSymbols, IO_BASE::m_reporter, m_sheetOffset, m_symbols, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, REPORTER::Report(), RPT_SEVERITY_DEBUG, EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillColor(), SCH_SHAPE::SetFilled(), EDA_SHAPE::SetFillMode(), EDA_TEXT::SetHorizJustify(), EDA_SHAPE::SetStart(), SCH_SHAPE::SetStroke(), EDA_TEXT::SetText(), EDA_TEXT::SetTextSize(), SCH_ITEM::SetUnit(), ASCH_TEXT_FRAME::ShowBorder, ASCH_TEXT_FRAME::Text, and ASCH_TEXT_FRAME::TopRight.

Referenced by ParseTextFrame().

AddTextBox()

void SCH_IO_ALTIUM::AddTextBox ( const ASCH_TEXT_FRAME *  aElem )

private

Definition at line 1649 of file sch_io_altium.cpp.

References ASCH_TEXT_FRAME::Alignment, SCH_SCREEN::Append(), ASCH_TEXT_FRAME::AreaColor, ASCH_SHEET_FONT::Bold, ASCH_TEXT_FRAME::BorderColor, ASCH_TEXT_FRAME::BottomLeft, ASCH_TEXT_FRAME::FontID, fonts, GetColorFromInt(), getCurrentScreen(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, IS_NEW, ASCH_TEXT_FRAME::isSolid, ASCH_SHEET_FONT::Italic, m_altiumSheet, m_sheetOffset, EDA_TEXT::SetBold(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillColor(), SCH_SHAPE::SetFilled(), EDA_SHAPE::SetFillMode(), EDA_ITEM::SetFlags(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), EDA_SHAPE::SetStart(), SCH_SHAPE::SetStroke(), EDA_TEXT::SetText(), EDA_TEXT::SetTextSize(), ASCH_TEXT_FRAME::ShowBorder, ASCH_SHEET_FONT::Size, ASCH_TEXT_FRAME::Text, and ASCH_TEXT_FRAME::TopRight.

Referenced by ParseNote(), and ParseTextFrame().

AdvanceProgressPhase()

void IO_BASE::AdvanceProgressPhase ( )

virtualinherited

Definition at line 133 of file io_base.cpp.

References _, PROGRESS_REPORTER::AdvancePhase(), PROGRESS_REPORTER::KeepRefreshing(), IO_BASE::m_progressReporter, and THROW_IO_ERROR.

Referenced by EAGLE_BASE::AdvanceProgressPhase().

CanReadLibrary()

bool SCH_IO_ALTIUM::CanReadLibrary ( const wxString &  aFileName ) const

overridevirtual

Checks if this IO object can read the specified library file/directory.

If not overridden, extension check is used.

Note

This is not a check that the file system object is readable by the user, but a check that this IO object can parse the given library.

Reimplemented from IO_BASE.

Definition at line 302 of file sch_io_altium.cpp.

References IO_BASE::CanReadLibrary(), and checkFileHeader().

CanReadSchematicFile()

bool SCH_IO_ALTIUM::CanReadSchematicFile ( const wxString &  aFileName ) const

overridevirtual

Checks if this SCH_IO can read the specified schematic file.

If not overriden, extension check is used.

Reimplemented from SCH_IO.

Definition at line 293 of file sch_io_altium.cpp.

References SCH_IO::CanReadSchematicFile(), and checkFileHeader().

checkFileHeader()

bool SCH_IO_ALTIUM::checkFileHeader ( const wxString &  aFileName )

staticprivate

Definition at line 287 of file sch_io_altium.cpp.

References isASCIIFile(), and isBinaryFile().

Referenced by CanReadLibrary(), and CanReadSchematicFile().

CreateLibrary()

void IO_BASE::CreateLibrary ( const wxString &  aLibraryPath, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

virtualinherited

Create a new empty library at aLibraryPath empty.

It is an error to attempt to create an existing library or to attempt to create on a "read only" location.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several elements.
aProperties	is an associative array that can be used to tell the library create function anything special, because it can take any number of additional named tuning arguments that the IO is known to support. The caller continues to own this object (IO may not delete it), and IOs should expect it to be optionally NULL.

Exceptions

IO_ERROR

if there is a problem finding the library, or creating it.

Reimplemented in DESIGN_BLOCK_IO, SCH_IO_KICAD_LEGACY, SCH_IO_KICAD_SEXPR, and PCB_IO_KICAD_SEXPR.

Definition at line 46 of file io_base.cpp.

References NOT_IMPLEMENTED.

DeleteLibrary()

bool IO_BASE::DeleteLibrary ( const wxString &  aLibraryPath, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

virtualinherited

Delete an existing library and returns true, or if library does not exist returns false, or throws an exception if library exists but is read only or cannot be deleted for some other reason.

Parameters

aLibraryPath	is a locator for the "library", usually a directory or file which will contain several elements.
aProperties	is an associative array that can be used to tell the library delete implementation function anything special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Returns

true if library deleted, false if library did not exist.

Exceptions

IO_ERROR

if there is a problem deleting an existing library.

Reimplemented in DESIGN_BLOCK_IO, SCH_IO_KICAD_LEGACY, SCH_IO_KICAD_SEXPR, PCB_IO_GEDA, PCB_IO_KICAD_LEGACY, and PCB_IO_KICAD_SEXPR.

Definition at line 53 of file io_base.cpp.

References NOT_IMPLEMENTED.

DeleteSymbol()

void SCH_IO::DeleteSymbol ( const wxString &  aLibraryPath, const wxString &  aSymbolName, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

virtualinherited

Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several symbols.
aSymbolName	is the name of a LIB_SYMBOL associated with it's root LIB_SYMBOL object to delete from the specified library.
aProperties	is an associative array that can be used to tell the library delete function anything special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Exceptions

IO_ERROR

if there is a problem finding the alias or the library or deleting it.

Reimplemented in SCH_IO_KICAD_LEGACY, and SCH_IO_KICAD_SEXPR.

Definition at line 116 of file sch_io.cpp.

References NOT_IMPLEMENTED.

Referenced by LIB_BUFFER::SaveBuffer().

doEnumerateSymbolLib()

void SCH_IO_ALTIUM::doEnumerateSymbolLib ( const wxString &  aLibraryPath, const std::map< std::string, UTF8 > *  aProperties, std::function< void(const wxString &, LIB_SYMBOL *)>  aInserter  )

private

Definition at line 4622 of file sch_io_altium.cpp.

References ensureLoadedLibrary(), m_libCache, and SYMBOL_LIB_TABLE::PropPowerSymsOnly.

Referenced by EnumerateSymbolLib().

ensureLoadedLibrary()

void SCH_IO_ALTIUM::ensureLoadedLibrary ( const wxString &  aLibraryPath, const std::map< std::string, UTF8 > *  aProperties  )

private

Definition at line 4512 of file sch_io_altium.cpp.

References getLibraryTimestamp(), m_isIntLib, m_libCache, m_libName, m_timestamps, ParseLibFile(), fontconfig::FONTCONFIG::SetReporter(), and THROW_IO_ERROR.

Referenced by doEnumerateSymbolLib(), and LoadSymbol().

EnumerateSymbolLib() [1/2]

void SCH_IO_ALTIUM::EnumerateSymbolLib ( std::vector< LIB_SYMBOL * > &  aSymbolList, const wxString &  aLibraryPath, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

overridevirtual

Populate a list of LIB_SYMBOL aliases contained within the library aLibraryPath.

Note

It is the responsibility of the caller to delete the returned object from the heap. Failure to do this will result in memory leaks.

Parameters

aSymbolList	is an array to populate with the LIB_SYMBOL pointers associated with the library.
aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing one or more LIB_SYMBOL objects.
aProperties	is an associative array that can be used to tell the plugin anything needed about how to perform with respect to aLibraryPath. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Exceptions

IO_ERROR

if the library cannot be found, the part library cannot be loaded.

Reimplemented from SCH_IO.

Definition at line 4659 of file sch_io_altium.cpp.

References doEnumerateSymbolLib().

EnumerateSymbolLib() [2/2]

void SCH_IO_ALTIUM::EnumerateSymbolLib ( wxArrayString &  aSymbolNameList, const wxString &  aLibraryPath, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

overridevirtual

Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath.

Parameters

aSymbolNameList	is an array to populate with the LIB_SYMBOL names associated with the library.
aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing one or more LIB_SYMBOL objects.
aProperties	is an associative array that can be used to tell the plugin anything needed about how to perform with respect to aLibraryPath. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Exceptions

IO_ERROR

if the library cannot be found, the part library cannot be loaded.

Reimplemented from SCH_IO.

Definition at line 4647 of file sch_io_altium.cpp.

References doEnumerateSymbolLib().

fixupSymbolPinNameNumbers()

void SCH_IO_ALTIUM::fixupSymbolPinNameNumbers ( SYMBOL *  aSymbol )

private

Definition at line 311 of file sch_io_altium.cpp.

References DEFAULT_PINNAME_SIZE, DEFAULT_PINNUM_SIZE, SYMBOL::GetPins(), EDA_IU_SCALE::MilsToIU(), pin, schIUScale, SYMBOL::SetShowPinNames(), and SYMBOL::SetShowPinNumbers().

Referenced by ParseASCIISchematic(), ParseFileHeader(), and ParseLibFile().

GetAvailableSymbolFields()

virtual void SCH_IO::GetAvailableSymbolFields ( std::vector< wxString > &  aNames )

inlinevirtualinherited

Retrieves a list of (custom) field names that are present on symbols in this library.

The plugin is responsible for guaranteeing that this list contains the set of unique custom field names present on any symbols contained in the library.

The required KiCad fields are not included in this list.

Parameters

aNames

will be filled with any custom fields present in this library.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE, SCH_IO_DATABASE, SCH_IO_HTTP_LIB, and SCH_IO_KICAD_SEXPR.

Definition at line 324 of file sch_io.h.

Referenced by SCH_IO::GetDefaultSymbolFields().

getCurrentScreen()

SCH_SCREEN * SCH_IO_ALTIUM::getCurrentScreen ( )

private

Definition at line 508 of file sch_io_altium.cpp.

References SCH_SHEET_PATH::LastScreen(), and m_sheetPath.

Referenced by AddTextBox(), ParseAltiumSch(), ParseArc(), ParseASCIISchematic(), ParseBezier(), ParseBus(), ParseBusEntry(), ParseCircle(), ParseComponent(), ParseDesignator(), ParseEllipse(), ParseEllipticalArc(), ParseFileHeader(), ParseHarnessConnector(), ParseHarnessPort(), ParseImage(), ParseJunction(), ParseLabel(), ParseLine(), ParseNetLabel(), ParseNoERC(), ParsePieChart(), ParsePolygon(), ParsePolyline(), ParsePort(), ParsePowerPort(), ParseRectangle(), ParseRoundRectangle(), ParseSheet(), ParseSheetSymbol(), ParseSignalHarness(), and ParseWire().

getCurrentSheet()

SCH_SHEET * SCH_IO_ALTIUM::getCurrentSheet ( )

private

Definition at line 514 of file sch_io_altium.cpp.

References SCH_SHEET_PATH::Last(), and m_sheetPath.

Referenced by ParseASCIISchematic(), ParseFileHeader(), ParseHarnessConnector(), and ParseSheetSymbol().

GetDefaultSymbolFields()

virtual void SCH_IO::GetDefaultSymbolFields ( std::vector< wxString > &  aNames )

inlinevirtualinherited

Retrieves a list of (custom) field names that should be shown by default for this library in the symbol chooser.

This list should be a subset of the result returned by GetAvailableSymbolFields().

The preference for which fields to hide and show for a given library is stored on a per-library basis in a user's preferences (or in the project local settings for a project- local library). The set of fields returned by GetDefaultSymbolFields() will be used if this preference is missing.

Parameters

aNames

will be filled with the custom field names that should be shown by default

Reimplemented in SCH_IO_DATABASE, SCH_IO_HTTP_LIB, and SCH_IO_KICAD_SEXPR.

Definition at line 338 of file sch_io.h.

References SCH_IO::GetAvailableSymbolFields().

GetError()

const wxString & SCH_IO::GetError ( ) const

virtualinherited

Return an error string to the caller.

This is useful for schematic loaders that can load partial schematics where throwing an exception would be problematic such as the KiCad legacy plugin.

Returns

an unformatted string containing errors if any.

Reimplemented in SCH_IO_HTTP_LIB, SCH_IO_KICAD_LEGACY, and SCH_IO_KICAD_SEXPR.

Definition at line 139 of file sch_io.cpp.

References NOT_IMPLEMENTED.

GetFileFromStorage()

const ASCH_STORAGE_FILE * SCH_IO_ALTIUM::GetFileFromStorage ( const wxString &  aFilename ) const

private

Definition at line 1141 of file sch_io_altium.cpp.

References m_altiumStorage.

Referenced by ParseImage().

getLibFileName()

wxFileName SCH_IO_ALTIUM::getLibFileName

(

)

Definition at line 369 of file sch_io_altium.cpp.

References getLibName(), PROJECT::GetProjectPath(), FILEEXT::KiCadSymbolLibFileExtension, m_schematic, and SCHEMATIC::Prj().

Referenced by LoadSchematicFile(), ParseASCIISchematic(), ParseFileHeader(), and ParsePowerPort().

getLibName()

wxString SCH_IO_ALTIUM::getLibName

(

)

Definition at line 345 of file sch_io_altium.cpp.

References LIB_ID::FixIllegalChars(), SCH_SHEET::GetFileName(), PROJECT::GetProjectName(), m_libName, m_rootSheet, m_schematic, SCHEMATIC::Prj(), and UTF8::wx_str().

Referenced by getLibFileName(), LoadSchematicFile(), ParseComponent(), ParseLibComponent(), and ParsePowerPort().

GetLibraryDesc()

const IO_BASE::IO_FILE_DESC SCH_IO_ALTIUM::GetLibraryDesc ( ) const

inlineoverridevirtual

Get the descriptor for the library container that this IO plugin operates on.

Returns

File descriptor for the container of the library elements

Implements IO_BASE.

Definition at line 67 of file sch_io_altium.h.

References _HKI.

GetLibraryFileDesc()

virtual const IO_FILE_DESC IO_BASE::GetLibraryFileDesc ( ) const

inlinevirtualinherited

Get the descriptor for the individual library elements that this IO plugin operates on.

For libraries where all the elements are in a single container (e.g. all elements in a single file), then this will return the descriptor from IO_BASE::GetLibraryDesc().

Returns

File descriptor for the library elements

Reimplemented in PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_GEDA, and PCB_IO_KICAD_SEXPR.

Definition at line 112 of file io_base.h.

Referenced by PCB_IO::CanReadFootprint().

GetLibraryOptions()

void SCH_IO::GetLibraryOptions ( std::map< std::string, UTF8 > *  aListToAppendTo ) const

overridevirtualinherited

Append supported SCH_IO options to aListToAppenTo along with internationalized descriptions.

Options are typically appended so that a derived SCH_IO can call its base class function by the same name first, thus inheriting options declared there. (Some base class options could pertain to all Symbol*() functions in all derived SCH_IOs.) Note that since aListToAppendTo is a PROPERTIES object, all options will be unique and last guy wins.

Parameters

aListToAppendTo

holds a tuple of option This eventually is what shows up into the fp-lib-table "options" field, possibly combined with others. internationalized description The internationalized description is displayed in DIALOG_PLUGIN_OPTIONS. It may be multi-line and be quite explanatory of the option. In the future perhaps aListToAppendTo evolves to something capable of also holding a wxValidator for the cells in said dialog: http://forums.wxwidgets.org/viewtopic.php?t=23277&p=104180. This would require a 3 column list, and introducing wx GUI knowledge to SCH_IO, which has been avoided to date.

Reimplemented from IO_BASE.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE.

Definition at line 124 of file sch_io.cpp.

References IO_BASE::GetLibraryOptions().

getLibraryTimestamp()

long long SCH_IO_ALTIUM::getLibraryTimestamp ( const wxString &  aLibraryPath ) const

private

Definition at line 4501 of file sch_io_altium.cpp.

Referenced by ensureLoadedLibrary().

GetModifyHash()

int SCH_IO_ALTIUM::GetModifyHash ( ) const

overridevirtual

Return the modification hash from the library cache.

Note

This is temporary until the new s-expr file format is implement. The new file format will embed symbols instead of referencing them from the library. This function can be removed when the new file format is implemented.

Returns

the modification hash of the library cache.

Implements SCH_IO.

Definition at line 267 of file sch_io_altium.cpp.

GetName()

const wxString & IO_BASE::GetName ( ) const

inlineinherited

Return a brief hard coded name for this IO interface.

Definition at line 79 of file io_base.h.

Referenced by ParseLibFile().

GetSchematicFileDesc()

const IO_BASE::IO_FILE_DESC SCH_IO_ALTIUM::GetSchematicFileDesc ( ) const

inlineoverridevirtual

Returns schematic file description for the SCH_IO.

Reimplemented from SCH_IO.

Definition at line 62 of file sch_io_altium.h.

References _HKI.

GetSubLibraryDescription()

virtual wxString SCH_IO::GetSubLibraryDescription ( const wxString &  aName )

inlinevirtualinherited

Gets a description of a sublibrary.

Has no effect if SupportsSubLibraries() returns false.

Parameters

aName

contains the name of the sublibrary for which the description is retrieved

Returns

the description of the sublibrary

Reimplemented in SCH_IO_HTTP_LIB.

Definition at line 313 of file sch_io.h.

GetSubLibraryNames()

virtual void SCH_IO::GetSubLibraryNames ( std::vector< wxString > &  aNames )

inlinevirtualinherited

Retrieves a list of sub-libraries in this library.

Some types of symbol library support sub-libraries, which are a single-level organizational hierarchy that is implementation-defined per plugin. Most of KiCad ignores sub-libraries and treats the hierarchy between library and symbol as flat, but the sub-libraries are used for sorting and grouping symbols in the symbol chooser.

Has no effect if SupportsSubLibraries() returns false.

Parameters

aNames

will be filled with a list of sub-libraries within this symbol library

Reimplemented in SCH_IO_DATABASE, and SCH_IO_HTTP_LIB.

Definition at line 302 of file sch_io.h.

isASCIIFile()

bool SCH_IO_ALTIUM::isASCIIFile ( const wxString &  aFileName )

staticprivate

Definition at line 280 of file sch_io_altium.cpp.

References IO_UTILS::fileStartsWithPrefix().

Referenced by checkFileHeader().

isBinaryFile()

bool SCH_IO_ALTIUM::isBinaryFile ( const wxString &  aFileName )

staticprivate

Definition at line 273 of file sch_io_altium.cpp.

References IO_UTILS::COMPOUND_FILE_HEADER, and IO_UTILS::fileStartsWithBinaryHeader().

Referenced by checkFileHeader(), and ParseAltiumSch().

IsComponentPartVisible()

bool SCH_IO_ALTIUM::IsComponentPartVisible ( const ASCH_OWNER_INTERFACE &  aElem ) const

private

Definition at line 1126 of file sch_io_altium.cpp.

References m_altiumComponents, m_altiumTemplates, ASCH_OWNER_INTERFACE::ownerindex, and ASCH_OWNER_INTERFACE::ownerpartdisplaymode.

Referenced by ParseArc(), ParseBezier(), ParseEllipticalArc(), ParseLine(), ParsePieChart(), ParsePin(), ParsePolygon(), ParsePolyline(), ParseRectangle(), and ParseRoundRectangle().

IsLibraryWritable()

bool SCH_IO_ALTIUM::IsLibraryWritable ( const wxString &  aLibraryPath )

inlineoverridevirtual

Return true if the library at aLibraryPath is writable.

The system libraries are typically read only because of where they are installed..

Parameters

aLibraryPath

is a locator for the "library", usually a directory, file, or URL containing several footprints.

Exceptions

IO_ERROR

if no library at aLibraryPath exists.

Reimplemented from IO_BASE.

Definition at line 110 of file sch_io_altium.h.

LoadSchematicFile()

SCH_SHEET * SCH_IO_ALTIUM::LoadSchematicFile ( const wxString &  aFileName, SCHEMATIC *  aSchematic, SCH_SHEET *  aAppendToMe = nullptr, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

overridevirtual

Load information from some input file format that this SCH_IO implementation knows about, into either a new SCH_SHEET or an existing one.

This may be used to load an entire new SCH_SHEET, or to augment an existing one if aAppendToMe is not NULL.

Parameters

aFileName	is the name of the file to use as input and may be foreign in nature or native in nature.
aKiway	is the KIWAY object used to access the symbol libraries loaded by the project.
aAppendToMe	is an existing SCH_SHEET to append to, but if NULL then this means "do not append, rather load anew".
aProperties	is an associative array that can be used to tell the loader how to load the file, because it can take any number of additional named arguments that the plugin is known to support. These are tuning parameters for the import or load. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Returns

the successfully loaded schematic, or the same one as aAppendToMe if aAppendToMe was not NULL, and the caller owns it.

Exceptions

IO_ERROR

if there is a problem loading, and its contents should say what went wrong, using line number and character offsets of the input file if possible.

Note

No check is being done here to see if the existing symbol library exists so this will overwrite the existing one.

Reimplemented from SCH_IO.

Definition at line 378 of file sch_io_altium.cpp.

References SCH_SCREENS::ClearEditFlags(), SYMBOL_LIB_TABLE::Format(), SCH_SCREENS::GetFirst(), WXLOG_REPORTER::GetInstance(), getLibFileName(), getLibName(), SCH_LINE::GetLineWidth(), SCH_SCREENS::GetNext(), PROJECT::GetProjectFile(), PROJECT::GetProjectPath(), SCH_SHEET::GetScreen(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), SCH_SCREEN::GetUuid(), LIB_TABLE::HasLibrary(), LIB_TABLE::InsertRow(), SCH_LINE::IsBus(), SCHEMATIC::IsValid(), SCH_LINE::IsWire(), FILEEXT::KiCadSchematicFileExtension, SCH_SHEET_INSTANCE::m_PageNumber, SCH_SHEET_INSTANCE::m_Path, m_pi, m_rootSheet, m_schematic, SCH_SCREEN::m_sheetInstances, m_sheetPath, EDA_ITEM::m_Uuid, PROJECT_FILE::NetSettings(), ParseAltiumSch(), SCH_SHEET_PATH::Path(), SCHEMATIC::Prj(), SCH_SHEET_PATH::push_back(), SCHEMATIC::Root(), SCH_LINE_T, PROJECT_SCH::SchSymbolLibTable(), PROJECT::SetElem(), SCH_SCREEN::SetFileName(), SCH_SHEET::SetFileName(), SCH_SHEET_PATH::SetPageNumber(), fontconfig::FONTCONFIG::SetReporter(), SCHEMATIC::SetRoot(), SCH_SHEET::SetScreen(), PROJECT::SYMBOL_LIB_TABLE, and SCH_SCREENS::UpdateSymbolLinks().

LoadSymbol()

LIB_SYMBOL * SCH_IO_ALTIUM::LoadSymbol ( const wxString &  aLibraryPath, const wxString &  aPartName, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

overridevirtual

Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this SCH_IO knows about.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several symbols.
aPartName	is the name of the LIB_SYMBOL to load.
aProperties	is an associative array that can be used to tell the loader implementation to do something special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Returns

the part created on the heap if found caller shares it or NULL if not found.

Exceptions

IO_ERROR

if the library cannot be found or read. No exception is thrown in the case where aAliasName cannot be found.

Reimplemented from SCH_IO.

Definition at line 4671 of file sch_io_altium.cpp.

References ensureLoadedLibrary(), and m_libCache.

ParseAdditional()

void SCH_IO_ALTIUM::ParseAdditional

(

const ALTIUM_COMPOUND_FILE &

aAltiumSchFile

)

Definition at line 666 of file sch_io_altium.cpp.

References ALTIUM_COMPOUND_FILE::FindStream(), ALTIUM_BINARY_PARSER::GetRemainingBytes(), ALTIUM_BINARY_PARSER::HasParsingError(), m_altiumHarnessPortsCurrentSheet, ParseHarnessPort(), ParseRecord(), ALTIUM_PROPS_UTILS::ReadInt(), ALTIUM_BINARY_PARSER::ReadProperties(), and THROW_IO_ERROR.

Referenced by ParseAltiumSch().

ParseAltiumSch()

void SCH_IO_ALTIUM::ParseAltiumSch

(

const wxString &

aFileName

)

Definition at line 520 of file sch_io_altium.cpp.

References _, getCurrentScreen(), SCH_SHEET::GetFileName(), SCH_SHEET::GetName(), PROJECT::GetProjectPath(), SCH_SHEET::GetScreen(), isBinaryFile(), SCH_SCREEN::Items(), FILEEXT::KiCadSchematicFileExtension, IO_BASE::m_reporter, m_rootSheet, m_schematic, m_sheetPath, EE_RTREE::OfType(), ParseAdditional(), ParseAltiumSch(), ParseASCIISchematic(), ParseFileHeader(), ParseStorage(), SCH_SHEET_PATH::pop_back(), SCHEMATIC::Prj(), SCH_SHEET_PATH::push_back(), REPORTER::Report(), SCH_SHEET_T, SCH_SHEET::SearchHierarchy(), SCH_SCREEN::SetFileName(), SCH_SHEET::SetFileName(), SCH_SHEET::SetName(), SCH_SHEET::SetScreen(), THROW_IO_ERROR, and traceAltiumSch.

Referenced by LoadSchematicFile(), and ParseAltiumSch().

ParseArc()

void SCH_IO_ALTIUM::ParseArc ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

Definition at line 2211 of file sch_io_altium.cpp.

References LIB_SYMBOL::AddDrawItem(), SCH_SCREEN::Append(), center, ASCH_BORDER_INTERFACE::Color, EDA_ANGLE::Cos(), DEGREES_T, getCurrentScreen(), SCH_SHAPE::GetPosition(), GetRelativePosition(), IsComponentPartVisible(), KiROUND(), LAYER_DEVICE, ASCH_ARC::m_Center, ASCH_ARC::m_EndAngle, m_libSymbols, ASCH_ARC::m_Radius, IO_BASE::m_reporter, m_sheetOffset, ASCH_ARC::m_StartAngle, m_symbols, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, REPORTER::Report(), RPT_SEVERITY_DEBUG, EDA_SHAPE::SetCenter(), EDA_SHAPE::SetEnd(), SetLibShapeFillAndColor(), SetLibShapeLine(), SCH_SHAPE::SetPosition(), SetSchShapeFillAndColor(), SetSchShapeLine(), EDA_SHAPE::SetStart(), SCH_ITEM::SetUnit(), ShouldPutItemOnSheet(), and EDA_ANGLE::Sin().

Referenced by ParseLibFile(), ParsePieChart(), and ParseRecord().

ParseASCIISchematic()

void SCH_IO_ALTIUM::ParseASCIISchematic

(

const wxString &

aFileName

)

Definition at line 805 of file sch_io_altium.cpp.

References _, ALTIUM_ASCII_PARSER::CanRead(), fixupSymbolPinNameNumbers(), getCurrentScreen(), getCurrentSheet(), getLibFileName(), ALTIUM_ASCII_PARSER::HasParsingError(), m_altiumComponents, m_altiumHarnessPortsCurrentSheet, m_altiumImplementationList, m_altiumPortsCurrentSheet, m_altiumStorage, m_altiumTemplates, m_currentTitleBlock, m_libSymbols, m_pi, m_properties, m_symbols, ParseHarnessPort(), ParsePort(), ParseRecord(), ALTIUM_ASCII_PARSER::ReadProperties(), ALTIUM_PROPS_UTILS::ReadString(), EDA_ITEM::SetModified(), SCH_SCREEN::SetTitleBlock(), and THROW_IO_ERROR.

Referenced by ParseAltiumSch().

ParseBezier()

void SCH_IO_ALTIUM::ParseBezier ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

Definition at line 1790 of file sch_io_altium.cpp.

References _, LIB_SYMBOL::AddDrawItem(), SCH_SHAPE::AddPoint(), SCH_SCREEN::Append(), getCurrentScreen(), BEZIER_POLY::GetPoly(), GetRelativePosition(), EDA_SHAPE::GetWidth(), IS_NEW, IsComponentPartVisible(), LAYER_DEVICE, ASCH_BORDER_INTERFACE::LineWidth, m_libSymbols, IO_BASE::m_reporter, m_sheetOffset, m_symbols, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, ASCH_BEZIER::points, EDA_SHAPE::RebuildBezierToSegmentsPointsList(), REPORTER::Report(), RPT_SEVERITY_DEBUG, RPT_SEVERITY_WARNING, EDA_SHAPE::SetBezierC1(), EDA_SHAPE::SetBezierC2(), EDA_SHAPE::SetEnd(), SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), EDA_SHAPE::SetStart(), SCH_LINE::SetStroke(), SCH_SHAPE::SetStroke(), SCH_ITEM::SetUnit(), and ShouldPutItemOnSheet().

Referenced by ParseLibFile(), and ParseRecord().

ParseBus()

void SCH_IO_ALTIUM::ParseBus ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3680 of file sch_io_altium.cpp.

References SCH_SCREEN::Append(), getCurrentScreen(), IS_NEW, ASCH_BUS::lineWidth, m_sheetOffset, ASCH_BUS::points, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), and SCH_LINE::SetLineWidth().

Referenced by ParseRecord().

ParseBusEntry()

void SCH_IO_ALTIUM::ParseBusEntry ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3978 of file sch_io_altium.cpp.

References SCH_SCREEN::Append(), ASCH_BUS_ENTRY::corner, getCurrentScreen(), IS_NEW, ASCH_BUS_ENTRY::location, m_sheetOffset, EDA_ITEM::SetFlags(), SCH_BUS_ENTRY_BASE::SetSize(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseRecord().

ParseCircle()

void SCH_IO_ALTIUM::ParseCircle ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

Definition at line 2650 of file sch_io_altium.cpp.

References LIB_SYMBOL::AddDrawItem(), SCH_SCREEN::Append(), ASCH_FILL_INTERFACE::AreaColor, ASCH_ELLIPSE::Center, center, ASCH_BORDER_INTERFACE::Color, GetColorFromInt(), getCurrentScreen(), SCH_SHAPE::GetPosition(), GetRelativePosition(), ASCH_FILL_INTERFACE::IsSolid, LAYER_DEVICE, m_libSymbols, IO_BASE::m_reporter, m_sheetOffset, m_symbols, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, ASCH_ELLIPSE::Radius, REPORTER::Report(), RPT_SEVERITY_DEBUG, EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillColor(), SCH_SHAPE::SetFilled(), EDA_SHAPE::SetFillMode(), SetLibShapeFillAndColor(), SetLibShapeLine(), SCH_SHAPE::SetPosition(), SCH_SHAPE::SetStroke(), SCH_ITEM::SetUnit(), and ShouldPutItemOnSheet().

Referenced by ParseEllipse(), and ParseEllipticalArc().

ParseComponent()

void SCH_IO_ALTIUM::ParseComponent ( int  aIndex, const std::map< wxString, wxString > &  aProperties  )

private

Definition at line 1158 of file sch_io_altium.cpp.

References _, AltiumToKiCadLibID(), SCH_SCREEN::Append(), ASCH_SYMBOL::componentdescription, ASCH_SYMBOL::currentpartid, DESCRIPTION_FIELD, ASCH_SYMBOL::displaymode, ASCH_SYMBOL::displaymodecount, getCurrentScreen(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetFields(), getLibName(), SCH_SHEET::GetName(), ASCH_SYMBOL::isMirrored, SCH_SHEET_PATH::Last(), ASCH_SYMBOL::libreference, ASCH_SYMBOL::location, m_altiumComponents, m_libSymbols, IO_BASE::m_reporter, m_sheetOffset, m_sheetPath, m_symbols, name, ASCH_SYMBOL::orientation, REPORTER::Report(), RPT_SEVERITY_ERROR, LIB_SYMBOL::SetDescription(), LIB_SYMBOL::SetLibId(), SCH_SYMBOL::SetLibId(), LIB_SYMBOL::SetName(), SCH_SYMBOL::SetPosition(), SCH_FIELD::SetText(), and SCH_ITEM::SetUnit().

Referenced by ParseRecord().

ParseDesignator()

void SCH_IO_ALTIUM::ParseDesignator ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3911 of file sch_io_altium.cpp.

References getCurrentScreen(), SCH_SYMBOL::GetField(), ASCH_DESIGNATOR::justification, ASCH_DESIGNATOR::location, m_libSymbols, IO_BASE::m_reporter, m_sheetOffset, m_sheetPath, m_symbols, ASCH_DESIGNATOR::orientation, ASCH_OWNER_INTERFACE::ownerindex, REFERENCE_FIELD, REPORTER::Report(), RPT_SEVERITY_DEBUG, SCH_FIELD::SetPosition(), SCH_SYMBOL::SetRef(), SetTextPositioning(), EDA_TEXT::SetVisible(), ASCH_DESIGNATOR::text, and VALUE_FIELD.

Referenced by ParseRecord().

ParseEllipse()

void SCH_IO_ALTIUM::ParseEllipse ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

Definition at line 2507 of file sch_io_altium.cpp.

References LIB_SYMBOL::AddDrawItem(), SCH_SHAPE::AddPoint(), ANGLE_0, SCH_SCREEN::Append(), ASCH_FILL_INTERFACE::AreaColor, ASCH_ELLIPSE::Center, ASCH_BORDER_INTERFACE::Color, GetColorFromInt(), getCurrentScreen(), GetRelativePosition(), EDA_SHAPE::GetStart(), EDA_SHAPE::GetWidth(), ASCH_FILL_INTERFACE::IsSolid, ASCH_FILL_INTERFACE::IsTransparent, KiROUND(), LAYER_DEVICE, ASCH_BORDER_INTERFACE::LineWidth, m_libSymbols, IO_BASE::m_reporter, m_sheetOffset, m_symbols, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, ParseCircle(), ASCH_ELLIPSE::Radius, EDA_SHAPE::RebuildBezierToSegmentsPointsList(), REPORTER::Report(), RPT_SEVERITY_DEBUG, ASCH_ELLIPSE::SecondaryRadius, EDA_SHAPE::SetBezierC1(), EDA_SHAPE::SetBezierC2(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillColor(), EDA_SHAPE::SetFillMode(), SetLibShapeFillAndColor(), SetLibShapeLine(), EDA_SHAPE::SetStart(), SCH_SHAPE::SetStroke(), SCH_ITEM::SetUnit(), EDA_SHAPE::SetWidth(), ShouldPutItemOnSheet(), TransformEllipseToBeziers(), and KIGFX::COLOR4D::WithAlpha().

Referenced by ParseLibFile(), and ParseRecord().

ParseEllipticalArc()

void SCH_IO_ALTIUM::ParseEllipticalArc ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

Definition at line 2319 of file sch_io_altium.cpp.

References LIB_SYMBOL::AddDrawItem(), ANGLE_0, SCH_SCREEN::Append(), DEGREES_T, getCurrentScreen(), GetRelativePosition(), IsComponentPartVisible(), KiROUND(), LAYER_DEVICE, ASCH_BORDER_INTERFACE::LineWidth, ASCH_ARC::m_Center, ASCH_ARC::m_EndAngle, m_libSymbols, ASCH_ARC::m_Radius, IO_BASE::m_reporter, ASCH_ARC::m_SecondaryRadius, m_sheetOffset, ASCH_ARC::m_StartAngle, m_symbols, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, ParseCircle(), EDA_SHAPE::RebuildBezierToSegmentsPointsList(), REPORTER::Report(), RPT_SEVERITY_DEBUG, EDA_SHAPE::SetBezierC1(), EDA_SHAPE::SetBezierC2(), EDA_SHAPE::SetEnd(), SetLibShapeLine(), EDA_SHAPE::SetStart(), SCH_SHAPE::SetStroke(), SCH_ITEM::SetUnit(), ShouldPutItemOnSheet(), and TransformEllipseToBeziers().

Referenced by ParseLibFile().

ParseFileHeader()

void SCH_IO_ALTIUM::ParseFileHeader

(

const ALTIUM_COMPOUND_FILE &

aAltiumSchFile

)

Definition at line 714 of file sch_io_altium.cpp.

References _, ALTIUM_COMPOUND_FILE::FindStream(), fixupSymbolPinNameNumbers(), getCurrentScreen(), getCurrentSheet(), getLibFileName(), ALTIUM_BINARY_PARSER::GetRemainingBytes(), ALTIUM_BINARY_PARSER::HasParsingError(), m_altiumComponents, m_altiumImplementationList, m_altiumPortsCurrentSheet, m_altiumTemplates, m_currentTitleBlock, m_libSymbols, m_pi, m_properties, m_symbols, ParsePort(), ParseRecord(), ALTIUM_BINARY_PARSER::ReadProperties(), ALTIUM_PROPS_UTILS::ReadString(), EDA_ITEM::SetModified(), SCH_SCREEN::SetTitleBlock(), and THROW_IO_ERROR.

Referenced by ParseAltiumSch().

ParseFileName()

void SCH_IO_ALTIUM::ParseFileName ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3886 of file sch_io_altium.cpp.

References ASCH_FILE_NAME::isHidden, ASCH_FILE_NAME::location, IO_BASE::m_reporter, m_sheetOffset, m_sheets, ASCH_FILE_NAME::orientation, ASCH_OWNER_INTERFACE::ownerindex, REPORTER::Report(), RPT_SEVERITY_DEBUG, SCH_FIELD::SetPosition(), SCH_FIELD::SetText(), SetTextPositioning(), EDA_TEXT::SetVisible(), SHEETFILENAME, and ASCH_FILE_NAME::text.

Referenced by ParseRecord().

ParseHarnessConnector()

void SCH_IO_ALTIUM::ParseHarnessConnector ( int  aIndex, const std::map< wxString, wxString > &  aProperties  )

private

Definition at line 2815 of file sch_io_altium.cpp.

References SCH_SCREEN::Append(), ASCH_HARNESS_CONNECTOR::AreaColor, ASCH_HARNESS_CONNECTOR::Color, GetColorFromInt(), getCurrentScreen(), getCurrentSheet(), ASCH_HARNESS_CONNECTOR::Location, m_harnessEntryParent, m_harnessOwnerIndexOffset, IO_BASE::m_reporter, m_schematic, m_sheetOffset, m_sheetPath, m_sheets, ASCH_OWNER_INTERFACE::ownerindex, SCH_SHEET_PATH::push_back(), REPORTER::Report(), RPT_SEVERITY_DEBUG, SCH_SHEET::SetBackgroundColor(), SCH_SHEET::SetBorderColor(), SCH_SHEET_PATH::SetPageNumber(), SCH_SHEET::SetScreen(), ShouldPutItemOnSheet(), and ASCH_HARNESS_CONNECTOR::Size.

Referenced by ParseRecord().

ParseHarnessEntry()

void SCH_IO_ALTIUM::ParseHarnessEntry ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2852 of file sch_io_altium.cpp.

References SPIN_STYLE::BOTTOM, ASCH_HARNESS_ENTRY::DistanceFromTop, SPIN_STYLE::LEFT, m_harnessEntryParent, IO_BASE::m_reporter, m_sheets, ASCH_HARNESS_ENTRY::Name, REPORTER::Report(), SPIN_STYLE::RIGHT, RPT_SEVERITY_DEBUG, SCH_SHEET_PIN::SetPosition(), SCH_LABEL_BASE::SetShape(), SCH_SHEET_PIN::SetSide(), SCH_HIERLABEL::SetSpinStyle(), EDA_TEXT::SetText(), ASCH_HARNESS_ENTRY::Side, SPIN_STYLE::UP, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseRecord().

ParseHarnessPort()

void SCH_IO_ALTIUM::ParseHarnessPort ( const ASCH_PORT &  aElem )

private

Definition at line 3450 of file sch_io_altium.cpp.

References _, ASCH_PORT::Alignment, SCH_SCREEN::Append(), ASCH_SHEET_FONT::Bold, ASCH_PORT::FontID, fonts, GetColorFromInt(), getCurrentScreen(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, HARNESS_PORT_COLOR_DEFAULT_BACKGROUND, HARNESS_PORT_COLOR_DEFAULT_OUTLINE, ASCH_PORT::Height, IS_NEW, ASCH_SHEET_FONT::Italic, ASCH_PORT::Location, m_altiumSheet, IO_BASE::m_reporter, m_sheetOffset, EDA_IU_SCALE::MilsToIU(), ASCH_PORT::Name, REPORTER::Report(), RPT_SEVERITY_WARNING, schIUScale, EDA_TEXT::SetBold(), EDA_SHAPE::SetEndX(), EDA_SHAPE::SetEndY(), EDA_SHAPE::SetFillColor(), EDA_SHAPE::SetFillMode(), EDA_ITEM::SetFlags(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), EDA_SHAPE::SetStartX(), EDA_SHAPE::SetStartY(), SCH_SHAPE::SetStroke(), EDA_TEXT::SetText(), EDA_TEXT::SetTextColor(), EDA_TEXT::SetTextSize(), ASCH_SHEET_FONT::Size, ASCH_PORT::TextColor, and ASCH_PORT::Width.

Referenced by ParseAdditional(), and ParseASCIISchematic().

ParseHarnessType()

void SCH_IO_ALTIUM::ParseHarnessType ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2902 of file sch_io_altium.cpp.

References _, ASCH_HARNESS_TYPE::Color, GetColorFromInt(), PROJECT::GetProjectPath(), FILEEXT::KiCadSchematicFileExtension, ASCH_HARNESS_TYPE::Location, m_harnessEntryParent, IO_BASE::m_reporter, m_schematic, m_sheetOffset, m_sheets, SCHEMATIC::Prj(), REPORTER::Report(), RPT_SEVERITY_DEBUG, RPT_SEVERITY_WARNING, SCH_SCREEN::SetFileName(), SCH_FIELD::SetPosition(), SCH_FIELD::SetText(), EDA_TEXT::SetTextColor(), SetTextPositioning(), EDA_TEXT::SetVisible(), SHEETFILENAME, SHEETNAME, and ASCH_HARNESS_TYPE::Text.

Referenced by ParseRecord().

ParseHyperlink()

void SCH_IO_ALTIUM::ParseHyperlink ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

ParseImage()

void SCH_IO_ALTIUM::ParseImage ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3734 of file sch_io_altium.cpp.

References _, std::abs(), SCH_SCREEN::Append(), center, ASCH_IMAGE::corner, ASCH_STORAGE_FILE::data, ASCH_IMAGE::embedimage, ASCH_IMAGE::filename, getCurrentScreen(), GetFileFromStorage(), REFERENCE_IMAGE::GetSize(), IS_NEW, ASCH_IMAGE::location, m_altiumComponents, IO_BASE::m_reporter, m_sheetOffset, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartid, REFERENCE_IMAGE::ReadImageFile(), REPORTER::Report(), RPT_SEVERITY_ERROR, REFERENCE_IMAGE::SetImageScale(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseRecord().

ParseImplementation()

void SCH_IO_ALTIUM::ParseImplementation ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

Definition at line 4186 of file sch_io_altium.cpp.

References AltiumToKiCadLibID(), LIB_ID::Format(), ASCH_IMPLEMENTATION::isCurrent, ASCH_IMPLEMENTATION::libname, m_altiumImplementationList, m_isIntLib, m_libName, m_libSymbols, IO_BASE::m_reporter, m_symbols, ASCH_IMPLEMENTATION::name, ASCH_OWNER_INTERFACE::ownerindex, REPORTER::Report(), RPT_SEVERITY_DEBUG, SCH_SYMBOL::SetFootprintFieldText(), SCH_FIELD::SetText(), and ASCH_IMPLEMENTATION::type.

Referenced by ParseLibFile(), and ParseRecord().

ParseImplementationList()

void SCH_IO_ALTIUM::ParseImplementationList ( int  aIndex, const std::map< wxString, wxString > &  aProperties  )

private

Definition at line 4177 of file sch_io_altium.cpp.

References m_altiumImplementationList, and ASCH_OWNER_INTERFACE::ownerindex.

Referenced by ParseRecord().

ParseJunction()

void SCH_IO_ALTIUM::ParseJunction ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3720 of file sch_io_altium.cpp.

References SCH_SCREEN::Append(), getCurrentScreen(), IS_NEW, ASCH_JUNCTION::location, m_sheetOffset, and EDA_ITEM::SetFlags().

Referenced by ParseRecord().

ParseLabel()

void SCH_IO_ALTIUM::ParseLabel ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym, std::vector< int > &  aFontSize = nullint  )

private

Handle labels that are in a library symbol, not on schematic

Definition at line 1526 of file sch_io_altium.cpp.

References LIB_SYMBOL::AddDrawItem(), AltiumSchSpecialStringsToKiCadVariables(), SCH_SCREEN::Append(), ASCH_SHEET_FONT::Bold, ASCH_LABEL::fontId, fonts, getCurrentScreen(), GetRelativePosition(), IS_NEW, ASCH_SHEET_FONT::Italic, ASCH_LABEL::justification, LAYER_DEVICE, ASCH_LABEL::location, m_altiumSheet, m_libSymbols, IO_BASE::m_reporter, m_sheetOffset, m_symbols, ASCH_LABEL::orientation, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, REPORTER::Report(), RPT_SEVERITY_DEBUG, EDA_TEXT::SetBold(), EDA_ITEM::SetFlags(), EDA_TEXT::SetItalic(), SCH_TEXT::SetPosition(), SetTextPositioning(), EDA_TEXT::SetTextSize(), SCH_ITEM::SetUnit(), ShouldPutItemOnSheet(), ASCH_SHEET_FONT::Size, and ASCH_LABEL::text.

Referenced by ParseLibFile(), and ParseRecord().

ParseLibComponent()

std::vector< LIB_SYMBOL * > SCH_IO_ALTIUM::ParseLibComponent ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 4250 of file sch_io_altium.cpp.

References AltiumToKiCadLibID(), ASCH_SYMBOL::componentdescription, ASCH_SYMBOL::displaymodecount, getLibName(), LIB_SYMBOL::GetName(), ASCH_SYMBOL::libreference, ASCH_SYMBOL::partcount, LIB_SYMBOL::SetDescription(), LIB_SYMBOL::SetLibId(), LIB_SYMBOL::SetName(), and LIB_SYMBOL::SetUnitCount().

Referenced by ParseLibFile().

ParseLibDesignator()

void SCH_IO_ALTIUM::ParseLibDesignator ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym, std::vector< int > &  aFontSize = nullint  )

private

Definition at line 3950 of file sch_io_altium.cpp.

References ASCH_DESIGNATOR::fontId, ASCH_DESIGNATOR::location, SCH_FIELD::SetPosition(), SCH_FIELD::SetText(), EDA_TEXT::SetTextSize(), and ASCH_DESIGNATOR::text.

Referenced by ParseLibFile().

ParseLibFile()

std::map< wxString, LIB_SYMBOL * > SCH_IO_ALTIUM::ParseLibFile ( const ALTIUM_COMPOUND_FILE &  aAltiumSchFile )

private

Definition at line 4280 of file sch_io_altium.cpp.

References _, LIB_SYMBOL::FixupDrawItems(), fixupSymbolPinNameNumbers(), ALTIUM_COMPOUND_FILE::GetLibSymbols(), IO_BASE::GetName(), ALTIUM_BINARY_PARSER::GetRemainingBytes(), EDA_TEXT::GetText(), LIB_SYMBOL::GetValueField(), ALTIUM_BINARY_PARSER::HasParsingError(), IO_BASE::m_reporter, name, ParseArc(), ParseBezier(), ParseEllipse(), ParseEllipticalArc(), ParseImplementation(), ParseLabel(), ParseLibComponent(), ParseLibDesignator(), ParseLibHeader(), ParseLibParameter(), ParseLine(), ParsePieChart(), ParsePin(), ParsePolygon(), ParsePolyline(), ParseRectangle(), ParseRoundRectangle(), ParseTextFrame(), ALTIUM_BINARY_READER::ReadByte(), ALTIUM_COMPRESSED_READER::ReadCompressedString(), ALTIUM_PROPS_UTILS::ReadInt(), ALTIUM_BINARY_READER::ReadInt16(), ALTIUM_BINARY_READER::ReadInt32(), ALTIUM_BINARY_PARSER::ReadProperties(), ALTIUM_BINARY_READER::ReadShortPascalString(), REPORTER::Report(), RPT_SEVERITY_ERROR, SCH_FIELD::SetText(), split(), and THROW_IO_ERROR.

Referenced by ensureLoadedLibrary().

ParseLibHeader()

void SCH_IO_ALTIUM::ParseLibHeader ( const ALTIUM_COMPOUND_FILE &  aAltiumSchFile, std::vector< int > &  aFontSizes  )

private

Definition at line 4576 of file sch_io_altium.cpp.

References _, ALTIUM_COMPOUND_FILE::FindStream(), ALTIUM_BINARY_PARSER::GetRemainingBytes(), EDA_IU_SCALE::MilsToIU(), ALTIUM_BINARY_PARSER::ReadProperties(), ALTIUM_PROPS_UTILS::ReadString(), schIUScale, and THROW_IO_ERROR.

Referenced by ParseLibFile().

ParseLibParameter()

void SCH_IO_ALTIUM::ParseLibParameter ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym, std::vector< int > &  aFontSize = nullint  )

private

Definition at line 4091 of file sch_io_altium.cpp.

References ALTIUM_COMPONENT_NONE, AltiumSchSpecialStringsToKiCadVariables(), DEFAULT_TEXT_SIZE, ASCH_PARAMETER::fontId, ASCH_PARAMETER::isHidden, ASCH_PARAMETER::justification, ASCH_PARAMETER::location, EDA_IU_SCALE::MilsToIU(), ASCH_PARAMETER::name, ASCH_PARAMETER::orientation, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartid, schIUScale, SCH_FIELD::SetText(), EDA_TEXT::SetTextPos(), SetTextPositioning(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetVisible(), and ASCH_PARAMETER::text.

Referenced by ParseLibFile().

ParseLine()

void SCH_IO_ALTIUM::ParseLine ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

Definition at line 2717 of file sch_io_altium.cpp.

References LIB_SYMBOL::AddDrawItem(), SCH_SHAPE::AddPoint(), SCH_SCREEN::Append(), ASCH_BORDER_INTERFACE::Color, GetColorFromInt(), getCurrentScreen(), GetPlotDashType(), GetRelativePosition(), IS_NEW, IsComponentPartVisible(), LAYER_DEVICE, ASCH_LINE::LineStyle, ASCH_BORDER_INTERFACE::LineWidth, m_libSymbols, IO_BASE::m_reporter, m_sheetOffset, m_symbols, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, ASCH_LINE::point1, ASCH_LINE::point2, REPORTER::Report(), RPT_SEVERITY_DEBUG, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), SetLibShapeLine(), EDA_SHAPE::SetLineStyle(), SCH_LINE::SetStroke(), SCH_ITEM::SetUnit(), and ShouldPutItemOnSheet().

Referenced by ParseLibFile(), and ParseRecord().

ParseNetLabel()

void SCH_IO_ALTIUM::ParseNetLabel ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3664 of file sch_io_altium.cpp.

References SCH_SCREEN::Append(), getCurrentScreen(), IS_NEW, ASCH_NET_LABEL::justification, ASCH_NET_LABEL::location, m_sheetOffset, ASCH_NET_LABEL::orientation, EDA_ITEM::SetFlags(), SetTextPositioning(), and ASCH_NET_LABEL::text.

Referenced by ParseRecord().

ParseNoERC()

void SCH_IO_ALTIUM::ParseNoERC ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3647 of file sch_io_altium.cpp.

References SCH_SCREEN::Append(), getCurrentScreen(), IS_NEW, ASCH_NO_ERC::isActive, ASCH_NO_ERC::location, m_sheetOffset, and EDA_ITEM::SetFlags().

Referenced by ParseRecord().

ParseNote()

void SCH_IO_ALTIUM::ParseNote ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 1640 of file sch_io_altium.cpp.

References AddTextBox().

Referenced by ParseRecord().

ParseParameter()

void SCH_IO_ALTIUM::ParseParameter ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3995 of file sch_io_altium.cpp.

References SCH_SYMBOL::AddField(), AltiumSchSpecialStringsToKiCadVariables(), SCH_SYMBOL::FindField(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetNextFieldId(), PROJECT::GetTextVars(), ASCH_PARAMETER::isHidden, ASCH_PARAMETER::justification, ASCH_PARAMETER::location, m_currentTitleBlock, m_libSymbols, m_schematic, m_sheetOffset, m_sheetPath, m_symbols, ASCH_PARAMETER::name, ASCH_PARAMETER::orientation, ASCH_OWNER_INTERFACE::ownerindex, SCHEMATIC::Prj(), SCH_SHEET_PATH::SetPageNumber(), SCH_FIELD::SetPosition(), SCH_FIELD::SetText(), SetTextPositioning(), EDA_TEXT::SetVisible(), ASCH_PARAMETER::text, and VALUE_FIELD.

Referenced by ParseRecord().

ParsePieChart()

void SCH_IO_ALTIUM::ParsePieChart ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

Definition at line 2421 of file sch_io_altium.cpp.

References LIB_SYMBOL::AddDrawItem(), SCH_SHAPE::AddPoint(), SCH_SCREEN::Append(), center, EDA_ANGLE::Cos(), DEGREES_T, getCurrentScreen(), GetRelativePosition(), IS_NEW, IsComponentPartVisible(), KiROUND(), LAYER_DEVICE, ASCH_BORDER_INTERFACE::LineWidth, ASCH_ARC::m_Center, ASCH_ARC::m_EndAngle, m_libSymbols, ASCH_ARC::m_Radius, IO_BASE::m_reporter, m_sheetOffset, ASCH_ARC::m_StartAngle, m_symbols, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, ParseArc(), REPORTER::Report(), RPT_SEVERITY_DEBUG, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), SetLibShapeLine(), SCH_LINE::SetStroke(), SCH_ITEM::SetUnit(), ShouldPutItemOnSheet(), and EDA_ANGLE::Sin().

Referenced by ParseLibFile(), and ParseRecord().

ParsePin()

void SCH_IO_ALTIUM::ParsePin ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

Definition at line 1250 of file sch_io_altium.cpp.

References _, LIB_SYMBOL::AddDrawItem(), AltiumPinNamesToKiCad(), ASCH_PIN_SYMBOL::CLOCK, DEFAULT_PINNAME_SIZE, DEFAULT_PINNUM_SIZE, ASCH_PIN::designator, ASCH_PIN::electrical, GetRelativePosition(), ASCH_PIN::hidden, IsComponentPartVisible(), ASCH_PIN::location, ASCH_PIN_SYMBOL::LOW_INPUT, ASCH_PIN_SYMBOL::LOW_OUTPUT, m_libSymbols, IO_BASE::m_reporter, m_sheetOffset, m_symbols, EDA_IU_SCALE::MilsToIU(), ASCH_PIN::name, ASCH_PIN_SYMBOL::NEGATED, ASCH_PIN::orientation, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, pin, ASCH_PIN::pinlength, REPORTER::Report(), RPT_SEVERITY_DEBUG, RPT_SEVERITY_WARNING, schIUScale, ASCH_PIN::showDesignator, ASCH_PIN::showPinName, ASCH_PIN::symbolInnerEdge, ASCH_PIN::symbolOuterEdge, ASCH_PIN_SYMBOL::UNKNOWN, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseLibFile(), and ParseRecord().

ParsePolygon()

void SCH_IO_ALTIUM::ParsePolygon ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

Definition at line 2032 of file sch_io_altium.cpp.

References LIB_SYMBOL::AddDrawItem(), SCH_SHAPE::AddPoint(), SCH_SCREEN::Append(), ASCH_BORDER_INTERFACE::Color, STROKE_PARAMS::GetColor(), getCurrentScreen(), EDA_SHAPE::GetFillColor(), EDA_SHAPE::GetFillMode(), GetRelativePosition(), SCH_SHAPE::GetStroke(), IS_NEW, IsComponentPartVisible(), LAYER_DEVICE, m_libSymbols, IO_BASE::m_reporter, m_sheetOffset, m_symbols, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, ASCH_POLYGON::points, REPORTER::Report(), RPT_SEVERITY_DEBUG, EDA_ITEM::SetFlags(), SetLibShapeFillAndColor(), SetLibShapeLine(), SetSchShapeFillAndColor(), SetSchShapeLine(), SCH_SHAPE::SetStroke(), SCH_ITEM::SetUnit(), STROKE_PARAMS::SetWidth(), and ShouldPutItemOnSheet().

Referenced by ParseLibFile(), and ParseRecord().

ParsePolyline()

void SCH_IO_ALTIUM::ParsePolyline ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

Definition at line 1955 of file sch_io_altium.cpp.

References LIB_SYMBOL::AddDrawItem(), SCH_SHAPE::AddPoint(), SCH_SCREEN::Append(), ASCH_BORDER_INTERFACE::Color, GetColorFromInt(), getCurrentScreen(), GetPlotDashType(), GetRelativePosition(), SCH_SHAPE::GetStroke(), IS_NEW, IsComponentPartVisible(), LAYER_DEVICE, ASCH_POLYLINE::LineStyle, ASCH_BORDER_INTERFACE::LineWidth, m_libSymbols, IO_BASE::m_reporter, m_sheetOffset, m_symbols, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, ASCH_POLYLINE::Points, REPORTER::Report(), RPT_SEVERITY_DEBUG, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), SetLibShapeLine(), STROKE_PARAMS::SetLineStyle(), SCH_LINE::SetStartPoint(), SCH_LINE::SetStroke(), SCH_SHAPE::SetStroke(), SCH_ITEM::SetUnit(), and ShouldPutItemOnSheet().

Referenced by ParseLibFile(), and ParseRecord().

ParsePort()

void SCH_IO_ALTIUM::ParsePort ( const ASCH_PORT &  aElem )

private

Definition at line 3516 of file sch_io_altium.cpp.

References _, SCH_SCREEN::Append(), AUTOPLACE_AUTO, SCH_LABEL_BASE::AutoplaceFields(), SPIN_STYLE::BOTTOM, end, getCurrentScreen(), SCH_LABEL_BASE::GetFields(), ASCH_PORT::HarnessType, ASCH_PORT::IOtype, IS_NEW, SCH_SCREEN::IsTerminalPoint(), LAYER_BUS, LAYER_WIRE, SPIN_STYLE::LEFT, ASCH_PORT::Location, m_altiumHarnessPortsCurrentSheet, IO_BASE::m_reporter, m_sheetOffset, EDA_IU_SCALE::MilsToIU(), ASCH_PORT::Name, REPORTER::Report(), SPIN_STYLE::RIGHT, RPT_SEVERITY_WARNING, schIUScale, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineWidth(), SCH_LABEL_BASE::SetShape(), SCH_LABEL_BASE::SetSpinStyle(), ASCH_PORT::Style, SPIN_STYLE::UP, ASCH_PORT::Width, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseASCIISchematic(), and ParseFileHeader().

ParsePowerPort()

void SCH_IO_ALTIUM::ParsePowerPort ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3338 of file sch_io_altium.cpp.

References _, LIB_SYMBOL::AddDrawItem(), AltiumToKiCadLibID(), ANGLE_HORIZONTAL, ANGLE_VERTICAL, SCH_SCREEN::Append(), getCurrentScreen(), SCH_SYMBOL::GetField(), getLibFileName(), getLibName(), SCH_FIELD::GetPosition(), LIB_SYMBOL::GetReferenceField(), LIB_SYMBOL::GetValueField(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_RIGHT, HelperGeneratePowerPortGraphics(), ASCH_POWER_PORT::location, m_pi, m_powerSymbols, m_properties, IO_BASE::m_reporter, m_sheetOffset, m_sheetPath, ASCH_POWER_PORT::orientation, pin, REFERENCE_FIELD, REPORTER::Report(), RPT_SEVERITY_WARNING, LIB_SYMBOL::SetDescription(), EDA_TEXT::SetHorizJustify(), LIB_SYMBOL::SetKeyWords(), LIB_SYMBOL::SetLibId(), SCH_SYMBOL::SetLibId(), SCH_SYMBOL::SetLibSymbol(), LIB_SYMBOL::SetName(), SCH_SYMBOL::SetOrientation(), SCH_FIELD::SetPosition(), SCH_SYMBOL::SetPosition(), LIB_SYMBOL::SetPower(), SCH_SYMBOL::SetRef(), SCH_FIELD::SetText(), EDA_TEXT::SetTextAngle(), SCH_SYMBOL::SetValueFieldText(), EDA_TEXT::SetVisible(), ASCH_POWER_PORT::showNetName, ASCH_POWER_PORT::style, ASCH_POWER_PORT::text, and VALUE_FIELD.

Referenced by ParseRecord().

ParseRecord()

void SCH_IO_ALTIUM::ParseRecord	(	int	index,
		std::map< wxString, wxString > &	properties,
		const wxString &	aSectionName
	)

Definition at line 919 of file sch_io_altium.cpp.

References _, m_altiumPortsCurrentSheet, m_harnessOwnerIndexOffset, IO_BASE::m_reporter, ParseArc(), ParseBezier(), ParseBus(), ParseBusEntry(), ParseComponent(), ParseDesignator(), ParseEllipse(), ParseFileName(), ParseHarnessConnector(), ParseHarnessEntry(), ParseHarnessType(), ParseImage(), ParseImplementation(), ParseImplementationList(), ParseJunction(), ParseLabel(), ParseLine(), ParseNetLabel(), ParseNoERC(), ParseNote(), ParseParameter(), ParsePieChart(), ParsePin(), ParsePolygon(), ParsePolyline(), ParsePowerPort(), ParseRectangle(), ParseRoundRectangle(), ParseSheet(), ParseSheetEntry(), ParseSheetName(), ParseSheetSymbol(), ParseSignalHarness(), ParseTemplate(), ParseTextFrame(), ParseWire(), ALTIUM_PROPS_UTILS::ReadInt(), REPORTER::Report(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, and THROW_IO_ERROR.

Referenced by ParseAdditional(), ParseASCIISchematic(), and ParseFileHeader().

ParseRectangle()

void SCH_IO_ALTIUM::ParseRectangle ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

Definition at line 2949 of file sch_io_altium.cpp.

References LIB_SYMBOL::AddDrawItem(), SCH_SCREEN::Append(), ASCH_RECTANGLE::BottomLeft, ASCH_BORDER_INTERFACE::Color, getCurrentScreen(), GetRelativePosition(), IS_NEW, IsComponentPartVisible(), LAYER_DEVICE, m_libSymbols, IO_BASE::m_reporter, m_sheetOffset, m_symbols, ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, REPORTER::Report(), RPT_SEVERITY_DEBUG, EDA_SHAPE::SetEnd(), EDA_ITEM::SetFlags(), SetLibShapeFillAndColor(), SetLibShapeLine(), SCH_SHAPE::SetPosition(), SetSchShapeFillAndColor(), SetSchShapeLine(), SCH_ITEM::SetUnit(), ShouldPutItemOnSheet(), and ASCH_RECTANGLE::TopRight.

Referenced by ParseLibFile(), and ParseRecord().

ParseRoundRectangle()

void SCH_IO_ALTIUM::ParseRoundRectangle ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym  )

private

Definition at line 2115 of file sch_io_altium.cpp.

References std::abs(), LIB_SYMBOL::AddDrawItem(), SCH_SCREEN::Append(), ASCH_ROUND_RECTANGLE::BottomLeft, center, ASCH_BORDER_INTERFACE::Color, ASCH_ROUND_RECTANGLE::CornerRadius, getCurrentScreen(), SCH_SHAPE::GetPosition(), GetRelativePosition(), IS_NEW, IsComponentPartVisible(), LAYER_DEVICE, m_libSymbols, IO_BASE::m_reporter, m_sheetOffset, m_symbols, SCH_SHAPE::Normalize(), ASCH_OWNER_INTERFACE::ownerindex, ASCH_OWNER_INTERFACE::ownerpartdisplaymode, ASCH_OWNER_INTERFACE::ownerpartid, radius, REPORTER::Report(), RPT_SEVERITY_DEBUG, EDA_SHAPE::SetEnd(), EDA_ITEM::SetFlags(), SetLibShapeFillAndColor(), SetLibShapeLine(), SCH_SHAPE::SetPosition(), SetSchShapeFillAndColor(), SetSchShapeLine(), SCH_ITEM::SetUnit(), ShouldPutItemOnSheet(), ASCH_ROUND_RECTANGLE::TopRight, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseLibFile(), and ParseRecord().

ParseSheet()

void SCH_IO_ALTIUM::ParseSheet ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3814 of file sch_io_altium.cpp.

References PAGE_INFO::Custom, getCurrentScreen(), PAGE_INFO::GetHeightIU(), EDA_IU_SCALE::IU_PER_MILS, EDA_IU_SCALE::IUToMils(), m_altiumSheet, m_sheetOffset, schIUScale, PAGE_INFO::SetCustomHeightMils(), PAGE_INFO::SetCustomWidthMils(), SCH_SCREEN::SetPageSettings(), and PAGE_INFO::SetType().

Referenced by ParseRecord().

ParseSheetEntry()

void SCH_IO_ALTIUM::ParseSheetEntry ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3057 of file sch_io_altium.cpp.

References SPIN_STYLE::BOTTOM, ASCH_SHEET_ENTRY::distanceFromTop, ASCH_SHEET_ENTRY::iotype, SPIN_STYLE::LEFT, IO_BASE::m_reporter, m_sheets, ASCH_SHEET_ENTRY::name, ASCH_OWNER_INTERFACE::ownerindex, REPORTER::Report(), SPIN_STYLE::RIGHT, RPT_SEVERITY_DEBUG, SCH_SHEET_PIN::SetPosition(), SCH_LABEL_BASE::SetShape(), SCH_SHEET_PIN::SetSide(), SCH_HIERLABEL::SetSpinStyle(), EDA_TEXT::SetText(), ASCH_SHEET_ENTRY::side, SPIN_STYLE::UP, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseRecord().

ParseSheetName()

void SCH_IO_ALTIUM::ParseSheetName ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3863 of file sch_io_altium.cpp.

References ASCH_SHEET_NAME::isHidden, ASCH_SHEET_NAME::location, IO_BASE::m_reporter, m_sheetOffset, m_sheets, ASCH_SHEET_NAME::orientation, ASCH_OWNER_INTERFACE::ownerindex, REPORTER::Report(), RPT_SEVERITY_DEBUG, SCH_FIELD::SetPosition(), SCH_FIELD::SetText(), SetTextPositioning(), EDA_TEXT::SetVisible(), SHEETNAME, and ASCH_SHEET_NAME::text.

Referenced by ParseRecord().

ParseSheetSymbol()

void SCH_IO_ALTIUM::ParseSheetSymbol ( int  aIndex, const std::map< wxString, wxString > &  aProperties  )

private

Definition at line 3021 of file sch_io_altium.cpp.

References SCH_SCREEN::Append(), ASCH_SHEET_SYMBOL::areacolor, ASCH_SHEET_SYMBOL::color, GetColorFromInt(), getCurrentScreen(), getCurrentSheet(), SCH_SHEET::GetScreen(), IS_NEW, ASCH_SHEET_SYMBOL::isSolid, ASCH_SHEET_SYMBOL::location, SCH_SHEET_INSTANCE::m_PageNumber, SCH_SHEET_INSTANCE::m_Path, m_rootSheet, SCH_SCREEN::m_sheetInstances, m_sheetOffset, m_sheetPath, m_sheets, SCH_SHEET_PATH::Path(), SCH_SHEET_PATH::push_back(), SCH_SHEET::SetBackgroundColor(), SCH_SHEET::SetBorderColor(), EDA_ITEM::SetFlags(), SCH_SHEET_PATH::SetPageNumber(), and ASCH_SHEET_SYMBOL::size.

Referenced by ParseRecord().

ParseSignalHarness()

void SCH_IO_ALTIUM::ParseSignalHarness ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2786 of file sch_io_altium.cpp.

References SCH_SHAPE::AddPoint(), SCH_SCREEN::Append(), ASCH_SIGNAL_HARNESS::Color, GetColorFromInt(), getCurrentScreen(), IS_NEW, ASCH_SIGNAL_HARNESS::LineWidth, IO_BASE::m_reporter, m_sheetOffset, ASCH_OWNER_INTERFACE::ownerindex, ASCH_SIGNAL_HARNESS::Points, REPORTER::Report(), RPT_SEVERITY_DEBUG, EDA_ITEM::SetFlags(), SCH_SHAPE::SetStroke(), and ShouldPutItemOnSheet().

Referenced by ParseRecord().

ParseStorage()

void SCH_IO_ALTIUM::ParseStorage

(

const ALTIUM_COMPOUND_FILE &

aAltiumSchFile

)

Definition at line 632 of file sch_io_altium.cpp.

References _, ALTIUM_COMPOUND_FILE::FindStream(), ALTIUM_BINARY_PARSER::GetRemainingBytes(), ALTIUM_BINARY_PARSER::HasParsingError(), m_altiumStorage, IO_BASE::m_reporter, ALTIUM_PROPS_UTILS::ReadInt(), ALTIUM_BINARY_PARSER::ReadProperties(), ALTIUM_PROPS_UTILS::ReadString(), REPORTER::Report(), RPT_SEVERITY_ERROR, and THROW_IO_ERROR.

Referenced by ParseAltiumSch().

ParseTemplate()

void SCH_IO_ALTIUM::ParseTemplate ( int  aIndex, const std::map< wxString, wxString > &  aProperties  )

private

Definition at line 1227 of file sch_io_altium.cpp.

References ASCH_TEMPLATE::filename, SCH_SHEET::GetName(), SCH_SHEET_PATH::Last(), m_altiumTemplates, and m_sheetPath.

Referenced by ParseRecord().

ParseTextFrame()

void SCH_IO_ALTIUM::ParseTextFrame ( const std::map< wxString, wxString > &  aProperties, std::vector< LIB_SYMBOL * > &  aSymbol = nullsym, std::vector< int > &  aFontSize = nullint  )

private

Definition at line 1627 of file sch_io_altium.cpp.

References AddLibTextBox(), AddTextBox(), ASCH_OWNER_INTERFACE::ownerindex, and ShouldPutItemOnSheet().

Referenced by ParseLibFile(), and ParseRecord().

ParseWire()

void SCH_IO_ALTIUM::ParseWire ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 3700 of file sch_io_altium.cpp.

References SCH_SCREEN::Append(), getCurrentScreen(), IS_NEW, m_sheetOffset, ASCH_WIRE::points, SCH_LINE::SetEndPoint(), and EDA_ITEM::SetFlags().

Referenced by ParseRecord().

Report()

void IO_BASE::Report ( const wxString &  aText, SEVERITY  aSeverity = RPT_SEVERITY_UNDEFINED  )

virtualinherited

Definition at line 124 of file io_base.cpp.

References IO_BASE::m_reporter, and REPORTER::Report().

Referenced by SCH_IO_EAGLE::loadInstance(), SCH_IO_EAGLE::loadLibrary(), and EAGLE_BASE::Report().

SaveLibrary()

void SCH_IO::SaveLibrary ( const wxString &  aFileName, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

virtualinherited

Reimplemented in SCH_IO_KICAD_LEGACY, and SCH_IO_KICAD_SEXPR.

Definition at line 61 of file sch_io.cpp.

References NOT_IMPLEMENTED.

SaveSchematicFile()

void SCH_IO::SaveSchematicFile ( const wxString &  aFileName, SCH_SHEET *  aSheet, SCHEMATIC *  aSchematic, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

virtualinherited

Write aSchematic to a storage file in a format that this SCH_IO implementation knows about, or it can be used to write a portion of aSchematic to a special kind of export file.

Parameters

aFileName	is the name of a file to save to on disk.
aSheet	is the class SCH_SHEET in memory document tree from which to extract information when writing to aFileName. The caller continues to own the SCHEMATIC, and the plugin should refrain from modifying the SCHEMATIC if possible.
aSchematic	is the SCHEMATIC object used to access any schematic-wide or project information needed to save the document.
aProperties	is an associative array that can be used to tell the saver how to save the file, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL. Set the #PropSaveCurrentSheetOnly property to only save the current sheet. Otherwise, all hierarchical sheets are saved.

Exceptions

IO_ERROR

if there is a problem saving or exporting.

Reimplemented in SCH_IO_KICAD_LEGACY, and SCH_IO_KICAD_SEXPR.

Definition at line 74 of file sch_io.cpp.

References NOT_IMPLEMENTED.

SaveSymbol()

void SCH_IO::SaveSymbol ( const wxString &  aLibraryPath, const LIB_SYMBOL *  aSymbol, const std::map< std::string, UTF8 > *  aProperties = nullptr  )

virtualinherited

Write aSymbol to an existing library located at aLibraryPath.

If a LIB_SYMBOL by the same name already exists or there are any conflicting alias names, the new LIB_SYMBOL will silently overwrite any existing aliases and/or part because libraries cannot have duplicate alias names. It is the responsibility of the caller to check the library for conflicts before saving.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several symbols.
aSymbol	is what to store in the library. The library is refreshed and the caller must update any LIB_SYMBOL pointers that may have changed.
aProperties	is an associative array that can be used to tell the saver how to save the symbol, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Exceptions

IO_ERROR

if there is a problem saving.

Reimplemented in SCH_IO_HTTP_LIB, SCH_IO_KICAD_LEGACY, and SCH_IO_KICAD_SEXPR.

Definition at line 108 of file sch_io.cpp.

References NOT_IMPLEMENTED.

Referenced by LIB_BUFFER::SaveBuffer().

SetLibTable()

virtual void SCH_IO::SetLibTable ( SYMBOL_LIB_TABLE *  aTable )

inlinevirtualinherited

Some library plugins need to have access to their parent library table.

Parameters

aTable

is the table this plugin is registered within.

Reimplemented in SCH_IO_DATABASE, and SCH_IO_HTTP_LIB.

Definition at line 357 of file sch_io.h.

SetProgressReporter()

virtual void IO_BASE::SetProgressReporter ( PROGRESS_REPORTER *  aReporter )

inlinevirtualinherited

Set an optional progress reporter.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE.

Definition at line 89 of file io_base.h.

Referenced by PCB_CONTROL::AppendBoard().

SetReporter()

virtual void IO_BASE::SetReporter ( REPORTER *  aReporter )

inlinevirtualinherited

Set an optional reporter for warnings/errors.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE.

Definition at line 84 of file io_base.h.

ShouldPutItemOnSheet()

bool SCH_IO_ALTIUM::ShouldPutItemOnSheet ( int  aOwnerindex )

private

Definition at line 1512 of file sch_io_altium.cpp.

References ALTIUM_COMPONENT_NONE, and m_altiumTemplates.

Referenced by ParseArc(), ParseBezier(), ParseCircle(), ParseEllipse(), ParseEllipticalArc(), ParseHarnessConnector(), ParseLabel(), ParseLine(), ParsePieChart(), ParsePolygon(), ParsePolyline(), ParseRectangle(), ParseRoundRectangle(), ParseSignalHarness(), and ParseTextFrame().

SupportsSubLibraries()

virtual bool SCH_IO::SupportsSubLibraries ( ) const

inlinevirtualinherited

Returns

true if this plugin supports libraries that contain sub-libraries.

Reimplemented in SCH_IO_DATABASE, and SCH_IO_HTTP_LIB.

Definition at line 288 of file sch_io.h.

Member Data Documentation

m_altiumAdditional

std::vector<ASCH_ADDITIONAL_FILE> SCH_IO_ALTIUM::m_altiumAdditional

private

Definition at line 209 of file sch_io_altium.h.

m_altiumComponents

std::map<int, ASCH_SYMBOL> SCH_IO_ALTIUM::m_altiumComponents

private

Definition at line 211 of file sch_io_altium.h.

Referenced by IsComponentPartVisible(), ParseASCIISchematic(), ParseComponent(), ParseFileHeader(), and ParseImage().

m_altiumHarnessPortsCurrentSheet

std::vector<ASCH_PORT> SCH_IO_ALTIUM::m_altiumHarnessPortsCurrentSheet

private

Definition at line 217 of file sch_io_altium.h.

Referenced by ParseAdditional(), ParseASCIISchematic(), and ParsePort().

m_altiumImplementationList

std::map<int, int> SCH_IO_ALTIUM::m_altiumImplementationList

private

Definition at line 213 of file sch_io_altium.h.

Referenced by ParseASCIISchematic(), ParseFileHeader(), ParseImplementation(), and ParseImplementationList().

m_altiumPortsCurrentSheet

std::vector<ASCH_PORT> SCH_IO_ALTIUM::m_altiumPortsCurrentSheet

private

Definition at line 214 of file sch_io_altium.h.

Referenced by ParseASCIISchematic(), ParseFileHeader(), and ParseRecord().

m_altiumSheet

std::unique_ptr<ASCH_SHEET> SCH_IO_ALTIUM::m_altiumSheet

private

Definition at line 202 of file sch_io_altium.h.

Referenced by AddTextBox(), ParseHarnessPort(), ParseLabel(), and ParseSheet().

m_altiumStorage

std::vector<ASCH_STORAGE_FILE> SCH_IO_ALTIUM::m_altiumStorage

private

Definition at line 208 of file sch_io_altium.h.

Referenced by GetFileFromStorage(), ParseASCIISchematic(), and ParseStorage().

m_altiumTemplates

std::map<int, ASCH_TEMPLATE> SCH_IO_ALTIUM::m_altiumTemplates

private

Definition at line 212 of file sch_io_altium.h.

Referenced by IsComponentPartVisible(), ParseASCIISchematic(), ParseFileHeader(), ParseTemplate(), and ShouldPutItemOnSheet().

m_currentTitleBlock

std::unique_ptr<TITLE_BLOCK> SCH_IO_ALTIUM::m_currentTitleBlock

private

Definition at line 198 of file sch_io_altium.h.

Referenced by ParseASCIISchematic(), ParseFileHeader(), and ParseParameter().

m_fonts

std::vector<std::pair<wxString, int> > SCH_IO_ALTIUM::m_fonts

private

Definition at line 235 of file sch_io_altium.h.

m_harnessEntryParent

int SCH_IO_ALTIUM::m_harnessEntryParent

private

Definition at line 221 of file sch_io_altium.h.

Referenced by ParseHarnessConnector(), ParseHarnessEntry(), ParseHarnessType(), and SCH_IO_ALTIUM().

m_harnessOwnerIndexOffset

int SCH_IO_ALTIUM::m_harnessOwnerIndexOffset

private

Definition at line 220 of file sch_io_altium.h.

Referenced by ParseHarnessConnector(), ParseRecord(), and SCH_IO_ALTIUM().

m_isIntLib

bool SCH_IO_ALTIUM::m_isIntLib

private

Definition at line 193 of file sch_io_altium.h.

Referenced by ensureLoadedLibrary(), ParseImplementation(), and SCH_IO_ALTIUM().

m_libCache

std::map<wxString, std::map<wxString, LIB_SYMBOL*> > SCH_IO_ALTIUM::m_libCache

private

Definition at line 232 of file sch_io_altium.h.

Referenced by doEnumerateSymbolLib(), ensureLoadedLibrary(), LoadSymbol(), and ~SCH_IO_ALTIUM().

m_libName

wxString SCH_IO_ALTIUM::m_libName

private

Definition at line 192 of file sch_io_altium.h.

Referenced by ensureLoadedLibrary(), getLibName(), and ParseImplementation().

m_libSymbols

std::map<int, LIB_SYMBOL*> SCH_IO_ALTIUM::m_libSymbols

private

Definition at line 205 of file sch_io_altium.h.

Referenced by AddLibTextBox(), ParseArc(), ParseASCIISchematic(), ParseBezier(), ParseCircle(), ParseComponent(), ParseDesignator(), ParseEllipse(), ParseEllipticalArc(), ParseFileHeader(), ParseImplementation(), ParseLabel(), ParseLine(), ParseParameter(), ParsePieChart(), ParsePin(), ParsePolygon(), ParsePolyline(), ParseRectangle(), and ParseRoundRectangle().

m_name

wxString IO_BASE::m_name

protectedinherited

Name of the IO loader.

Definition at line 220 of file io_base.h.

m_pi

IO_RELEASER<SCH_IO> SCH_IO_ALTIUM::m_pi

private

Definition at line 195 of file sch_io_altium.h.

Referenced by LoadSchematicFile(), ParseASCIISchematic(), ParseFileHeader(), and ParsePowerPort().

m_powerSymbols

std::map<wxString, LIB_SYMBOL*> SCH_IO_ALTIUM::m_powerSymbols

private

Definition at line 207 of file sch_io_altium.h.

Referenced by ParsePowerPort().

m_progressReporter

PROGRESS_REPORTER* IO_BASE::m_progressReporter

protectedinherited

Progress reporter to track the progress of the operation, may be nullptr.

Definition at line 226 of file io_base.h.

Referenced by IO_BASE::AdvanceProgressPhase(), SCH_IO_KICAD_LEGACY::checkpoint(), SCH_IO_EAGLE::ensureLoadedLibrary(), SCH_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), PCB_IO_ODBPP::ExportODB(), PCB_IO_IPC2581::generateAvlSection(), PCB_IO_IPC2581::generateBOMSection(), PCB_IO_IPC2581::generateContentSection(), PCB_IO_IPC2581::generateEcadSection(), PCB_IO_IPC2581::generateHistorySection(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard(), PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard(), PCB_IO_ALTIUM_DESIGNER::LoadBoard(), PCB_IO_SOLIDWORKS::LoadBoard(), PCB_IO_CADSTAR_ARCHIVE::LoadBoard(), PCB_IO_EASYEDA::LoadBoard(), PCB_IO_EASYEDAPRO::LoadBoard(), PCB_IO_FABMASTER::LoadBoard(), PCB_IO_KICAD_SEXPR::LoadBoard(), SCH_IO_KICAD_LEGACY::loadFile(), SCH_IO_KICAD_SEXPR::loadFile(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), PCB_IO_IPC2581::SaveBoard(), and SCH_IO_CADSTAR_ARCHIVE::SetProgressReporter().

m_properties

std::unique_ptr<std::map<std::string, UTF8> > SCH_IO_ALTIUM::m_properties

private

Definition at line 196 of file sch_io_altium.h.

Referenced by ParseASCIISchematic(), ParseFileHeader(), and ParsePowerPort().

m_reporter

REPORTER* IO_BASE::m_reporter

protectedinherited

Reporter to log errors/warnings to, may be nullptr.

Definition at line 223 of file io_base.h.

Referenced by AddLibTextBox(), SCH_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), PCB_IO_ALTIUM_DESIGNER::FootprintLoad(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard(), PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard(), PCB_IO_ALTIUM_DESIGNER::LoadBoard(), PCB_IO_SOLIDWORKS::LoadBoard(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), ParseAltiumSch(), ParseArc(), ParseBezier(), ParseCircle(), ParseComponent(), ParseDesignator(), ParseEllipse(), ParseEllipticalArc(), ParseFileName(), ParseHarnessConnector(), ParseHarnessEntry(), ParseHarnessPort(), ParseHarnessType(), ParseImage(), ParseImplementation(), ParseLabel(), ParseLibFile(), ParseLine(), ParsePieChart(), ParsePin(), ParsePolygon(), ParsePolyline(), ParsePort(), ParsePowerPort(), ParseRecord(), ParseRectangle(), ParseRoundRectangle(), ParseSheetEntry(), ParseSheetName(), ParseSignalHarness(), ParseStorage(), PCB_IO_ALTIUM_DESIGNER::PCB_IO_ALTIUM_DESIGNER(), PCB_IO_SOLIDWORKS::PCB_IO_SOLIDWORKS(), IO_BASE::Report(), SCH_IO_ALTIUM(), SCH_IO_CADSTAR_ARCHIVE::SCH_IO_CADSTAR_ARCHIVE(), SCH_IO_EAGLE::SCH_IO_EAGLE(), SCH_IO_EASYEDA::SCH_IO_EASYEDA(), SCH_IO_EASYEDAPRO::SCH_IO_EASYEDAPRO(), SCH_IO_LTSPICE::SCH_IO_LTSPICE(), and SCH_IO_CADSTAR_ARCHIVE::SetReporter().

m_rootSheet

SCH_SHEET* SCH_IO_ALTIUM::m_rootSheet

private

Definition at line 189 of file sch_io_altium.h.

Referenced by getLibName(), LoadSchematicFile(), ParseAltiumSch(), ParseSheetSymbol(), and SCH_IO_ALTIUM().

m_schematic

SCHEMATIC* SCH_IO_ALTIUM::m_schematic

private

Definition at line 191 of file sch_io_altium.h.

Referenced by getLibFileName(), getLibName(), LoadSchematicFile(), ParseAltiumSch(), ParseHarnessConnector(), ParseHarnessType(), ParseParameter(), and SCH_IO_ALTIUM().

m_sheetOffset

VECTOR2I SCH_IO_ALTIUM::m_sheetOffset

private

Definition at line 201 of file sch_io_altium.h.

Referenced by AddLibTextBox(), AddTextBox(), ParseArc(), ParseBezier(), ParseBus(), ParseBusEntry(), ParseCircle(), ParseComponent(), ParseDesignator(), ParseEllipse(), ParseEllipticalArc(), ParseFileName(), ParseHarnessConnector(), ParseHarnessPort(), ParseHarnessType(), ParseImage(), ParseJunction(), ParseLabel(), ParseLine(), ParseNetLabel(), ParseNoERC(), ParseParameter(), ParsePieChart(), ParsePin(), ParsePolygon(), ParsePolyline(), ParsePort(), ParsePowerPort(), ParseRectangle(), ParseRoundRectangle(), ParseSheet(), ParseSheetName(), ParseSheetSymbol(), ParseSignalHarness(), and ParseWire().

m_sheetPath

SCH_SHEET_PATH SCH_IO_ALTIUM::m_sheetPath

private

Definition at line 190 of file sch_io_altium.h.

Referenced by getCurrentScreen(), getCurrentSheet(), LoadSchematicFile(), ParseAltiumSch(), ParseComponent(), ParseDesignator(), ParseHarnessConnector(), ParseParameter(), ParsePowerPort(), ParseSheetSymbol(), and ParseTemplate().

m_sheets

std::map<int, SCH_SHEET*> SCH_IO_ALTIUM::m_sheets

private

Definition at line 204 of file sch_io_altium.h.

Referenced by ParseFileName(), ParseHarnessConnector(), ParseHarnessEntry(), ParseHarnessType(), ParseSheetEntry(), ParseSheetName(), and ParseSheetSymbol().

m_symbols

std::map<int, SCH_SYMBOL*> SCH_IO_ALTIUM::m_symbols

private

Definition at line 203 of file sch_io_altium.h.

Referenced by AddLibTextBox(), ParseArc(), ParseASCIISchematic(), ParseBezier(), ParseCircle(), ParseComponent(), ParseDesignator(), ParseEllipse(), ParseEllipticalArc(), ParseFileHeader(), ParseImplementation(), ParseLabel(), ParseLine(), ParseParameter(), ParsePieChart(), ParsePin(), ParsePolygon(), ParsePolyline(), ParseRectangle(), and ParseRoundRectangle().

m_timestamps

std::map<wxString, long long> SCH_IO_ALTIUM::m_timestamps

private

Definition at line 231 of file sch_io_altium.h.

Referenced by ensureLoadedLibrary().

---

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

• sch_io_altium.h
• sch_io_altium.cpp