SCH_IO_EAGLE Class Reference

A SCH_IO derivation for loading 6.x+ Eagle schematic files. More...

#include <sch_io_eagle.h>

Inheritance diagram for SCH_IO_EAGLE:

Classes
struct	EAGLE_MISSING_CMP
	Map references to missing symbol units data. More...
struct	SEG_DESC
	Segments representing wires for intersection checking. More...

Public Member Functions
	SCH_IO_EAGLE ()
	~SCH_IO_EAGLE ()
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 STRING_UTF8_MAP *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 STRING_UTF8_MAP *aProperties) 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 STRING_UTF8_MAP *aProperties) override
	Populate a list of LIB_SYMBOL aliases contained within the library aLibraryPath.
LIB_SYMBOL *	LoadSymbol (const wxString &aLibraryPath, const wxString &aAliasName, const STRING_UTF8_MAP *aProperties) 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.
virtual void	SaveLibrary (const wxString &aFileName, const STRING_UTF8_MAP *aProperties=nullptr)
virtual void	SaveSchematicFile (const wxString &aFileName, SCH_SHEET *aSheet, SCHEMATIC *aSchematic, const STRING_UTF8_MAP *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 STRING_UTF8_MAP *aProperties=nullptr)
	Write aSymbol to an existing library located at aLibraryPath.
virtual void	DeleteSymbol (const wxString &aLibraryPath, const wxString &aSymbolName, const STRING_UTF8_MAP *aProperties=nullptr)
	Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath.
virtual void	GetLibraryOptions (STRING_UTF8_MAP *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 STRING_UTF8_MAP *aProperties=nullptr)
	Create a new empty library at aLibraryPath empty.
virtual bool	DeleteLibrary (const wxString &aLibraryPath, const STRING_UTF8_MAP *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.

Public Attributes
const double	ARC_ACCURACY = SCH_IU_PER_MM * 0.01

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
void	checkpoint ()
bool	checkHeader (const wxString &aFileName) const
wxXmlDocument	loadXmlDocument (const wxString &aFileName)
long long	getLibraryTimestamp (const wxString &aLibraryPath) const
void	ensureLoadedLibrary (const wxString &aLibraryPath)
void	loadDrawing (wxXmlNode *aDrawingNode)
void	loadLayerDefs (wxXmlNode *aLayers)
void	loadSchematic (wxXmlNode *aSchematicNode)
void	loadSheet (wxXmlNode *aSheetNode, int sheetcount)
void	loadInstance (wxXmlNode *aInstanceNode)
EAGLE_LIBRARY *	loadLibrary (wxXmlNode *aLibraryNode, EAGLE_LIBRARY *aEagleLib)
void	countNets (wxXmlNode *aSchematicNode)
void	moveLabels (SCH_LINE *aWire, const VECTOR2I &aNewEndPoint)
	Move any labels on the wire to the new end point of the wire.
void	addBusEntries ()
	This function finds best way to place a bus entry symbol for when an Eagle wire segment ends on an Eagle bus segment.
SCH_LAYER_ID	kiCadLayer (int aEagleLayer)
	Return the matching layer or return LAYER_NOTES.
std::pair< VECTOR2I, const SEG * >	findNearestLinePoint (const VECTOR2I &aPoint, const std::vector< SEG > &aLines) const
void	loadSegments (wxXmlNode *aSegmentsNode, const wxString &aNetName, const wxString &aNetClass)
SCH_SHAPE *	loadPolyLine (wxXmlNode *aPolygonNode)
SCH_ITEM *	loadWire (wxXmlNode *aWireNode, SEG &endpoints)
SCH_SHAPE *	loadCircle (wxXmlNode *aCircleNode)
SCH_SHAPE *	loadRectangle (wxXmlNode *aRectNode)
SCH_TEXT *	loadLabel (wxXmlNode *aLabelNode, const wxString &aNetName)
SCH_JUNCTION *	loadJunction (wxXmlNode *aJunction)
SCH_TEXT *	loadPlainText (wxXmlNode *aSchText)
void	loadFrame (wxXmlNode *aFrameNode, std::vector< SCH_ITEM * > &aItems)
bool	loadSymbol (wxXmlNode *aSymbolNode, std::unique_ptr< LIB_SYMBOL > &aSymbol, EDEVICE *aDevice, int aGateNumber, const wxString &aGateName)
SCH_SHAPE *	loadSymbolCircle (wxXmlNode *aCircleNode, int aGateNumber)
SCH_SHAPE *	loadSymbolRectangle (wxXmlNode *aRectNode, int aGateNumber)
SCH_SHAPE *	loadSymbolPolyLine (wxXmlNode *aPolygonNode, int aGateNumber)
SCH_ITEM *	loadSymbolWire (wxXmlNode *aWireNode, int aGateNumber)
SCH_PIN *	loadPin (std::unique_ptr< LIB_SYMBOL > &aSymbol, wxXmlNode *, EPIN *epin, int aGateNumber)
SCH_TEXT *	loadSymbolText (wxXmlNode *aLibText, int aGateNumber)
void	loadSymbolFrame (wxXmlNode *aFrameNode, std::vector< SCH_ITEM * > &aLines)
void	loadTextAttributes (EDA_TEXT *aText, const ETEXT &aAttribs) const
void	loadFieldAttributes (SCH_FIELD *aField, const SCH_TEXT *aText) const
	Move net labels that are detached from any wire to the nearest wire.
void	adjustNetLabels ()
wxString	translateEagleBusName (const wxString &aEagleName) const
	Translate an Eagle-style bus name into one that is KiCad-compatible.
wxString	getLibName ()
wxFileName	getLibFileName ()
	Checks if there are other wires or pins at the position of the tested pin.
bool	checkConnections (const SCH_SYMBOL *aSymbol, const SCH_PIN *aPin) const
void	addImplicitConnections (SCH_SYMBOL *aSymbol, SCH_SCREEN *aScreen, bool aUpdateSet)
	Create net labels to emulate implicit connections in Eagle.
bool	netHasPowerDriver (SCH_LINE *aLine, const wxString &aNetName) const
SCH_SHEET *	getCurrentSheet ()
SCH_SCREEN *	getCurrentScreen ()

Private Attributes
std::map< wxString, EAGLE_MISSING_CMP >	m_missingCmps
SCH_SHEET *	m_rootSheet
	The root sheet of the schematic being loaded.
SCH_SHEET_PATH	m_sheetPath
	The current sheet path of the schematic being loaded.
wxString	m_version
	Eagle file version.
wxFileName	m_filename
wxString	m_libName
	Library name to save symbols.
SCHEMATIC *	m_schematic
	Passed to Load(), the schematic object being loaded.
EPART_MAP	m_partlist
std::map< wxString, long long >	m_timestamps
std::map< wxString, EAGLE_LIBRARY >	m_eagleLibs
std::unordered_map< wxString, bool >	m_userValue
	deviceset/@uservalue for device.
IO_RELEASER< SCH_IO >	m_pi
	PI to create KiCad symbol library.
std::unique_ptr< STRING_UTF8_MAP >	m_properties
	Library plugin properties.
unsigned	m_doneCount
unsigned	m_lastProgressCount
unsigned	m_totalCount
	for progress reporting
std::map< wxString, int >	m_netCounts
std::map< int, SCH_LAYER_ID >	m_layerMap
std::map< wxString, wxString >	m_powerPorts
	map from symbol reference to global label equivalent
std::vector< VECTOR2I >	m_wireIntersections
	Wires and labels of a single connection (segment in Eagle nomenclature)
std::vector< SEG_DESC >	m_segments
	Nets as defined in the <nets> sections of an Eagle schematic file.
std::map< wxString, ENET >	m_nets
	Positions of pins and wire endings mapped to its parent.
std::map< VECTOR2I, std::set< const EDA_ITEM * > >	m_connPoints

Detailed Description

A SCH_IO derivation for loading 6.x+ Eagle schematic files.

As with all SCH_IO there is no UI dependencies i.e. windowing calls allowed.

Definition at line 75 of file sch_io_eagle.h.

Constructor & Destructor Documentation

SCH_IO_EAGLE()

SCH_IO_EAGLE::SCH_IO_EAGLE

(

)

Definition at line 357 of file sch_io_eagle.cpp.

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

~SCH_IO_EAGLE()

SCH_IO_EAGLE::~SCH_IO_EAGLE

(

)

Definition at line 369 of file sch_io_eagle.cpp.

Member Function Documentation

addBusEntries()

void SCH_IO_EAGLE::addBusEntries ( )

private

This function finds best way to place a bus entry symbol for when an Eagle wire segment ends on an Eagle bus segment.

Definition at line 2915 of file sch_io_eagle.cpp.

References SCH_SCREEN::Append(), ERC_ITEM::Create(), DEFAULT_SCH_ENTRY_SIZE, ERCE_BUS_ENTRY_NEEDED, getCurrentScreen(), IS_NEW, SCH_LINE::IsBus(), SCH_LINE::IsWire(), SCH_SCREEN::Items(), EDA_IU_SCALE::MilsToIU(), moveLabels(), EE_RTREE::OfType(), SCH_LINE_T, schIUScale, EDA_ITEM::SetFlags(), TestSegmentHit(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadSheet().

addImplicitConnections()

void SCH_IO_EAGLE::addImplicitConnections ( SCH_SYMBOL *  aSymbol, SCH_SCREEN *  aScreen, bool  aUpdateSet  )

private

Create net labels to emulate implicit connections in Eagle.

Each named power input pin creates an implicit connection in Eagle. To emulate this behavior one needs to attach global net labels to the mentioned pins. This is is also expected for the units that are not instantiated in the schematics, therefore such units need to be stored in order to create them at later stage.

Parameters

aSymbol	is the symbol to process.
aScreen	is the screen where net labels should be added.
aUpdateSet	decides whether the missing units data should be updated.

Definition at line 3499 of file sch_io_eagle.cpp.

References SCH_SCREEN::Append(), SPIN_STYLE::BOTTOM, checkConnections(), SCH_IO_EAGLE::EAGLE_MISSING_CMP::cmp, extractNetName(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetLibSymbolRef(), SCH_SYMBOL::GetPinPhysicalPosition(), EDA_TEXT::GetText(), SCH_ITEM::GetUnit(), SPIN_STYLE::LEFT, m_missingCmps, EDA_IU_SCALE::MilsToIU(), pin, REFERENCE_FIELD, SPIN_STYLE::RIGHT, schIUScale, SCH_LABEL_BASE::SetPosition(), SCH_GLOBALLABEL::SetSpinStyle(), EDA_TEXT::SetText(), EDA_TEXT::SetTextSize(), SCH_IO_EAGLE::EAGLE_MISSING_CMP::units, and SPIN_STYLE::UP.

Referenced by loadSchematic(), and loadSheet().

adjustNetLabels()

void SCH_IO_EAGLE::adjustNetLabels ( )

private

Definition at line 2783 of file sch_io_eagle.cpp.

References SEG::A, SEG::B, SEG::Contains(), findNearestLinePoint(), SCH_TEXT::GetPosition(), m_segments, m_wireIntersections, EDA_IU_SCALE::MilsToIU(), move, VECTOR2< T >::Resize(), schIUScale, and SCH_TEXT::SetPosition().

Referenced by loadSheet().

CanReadLibrary()

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

overridevirtual

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

If not overriden, 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 2867 of file sch_io_eagle.cpp.

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

CanReadSchematicFile()

bool SCH_IO_EAGLE::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 2858 of file sch_io_eagle.cpp.

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

checkConnections()

bool SCH_IO_EAGLE::checkConnections ( const SCH_SYMBOL *  aSymbol, const SCH_PIN *  aPin  ) const

private

Definition at line 3481 of file sch_io_eagle.cpp.

References SCH_SYMBOL::GetPinPhysicalPosition(), and m_connPoints.

Referenced by addImplicitConnections().

checkHeader()

bool SCH_IO_EAGLE::checkHeader ( const wxString &  aFileName ) const

private

Definition at line 2876 of file sch_io_eagle.cpp.

References text.

Referenced by CanReadLibrary(), and CanReadSchematicFile().

checkpoint()

void SCH_IO_EAGLE::checkpoint ( )

private

Definition at line 380 of file sch_io_eagle.cpp.

References PROGRESS_REPORTER::KeepRefreshing(), m_doneCount, m_lastProgressCount, IO_BASE::m_progressReporter, m_totalCount, PROGRESS_REPORTER::SetCurrentProgress(), and THROW_IO_ERROR.

Referenced by loadLibrary(), loadSchematic(), and loadSheet().

countNets()

void SCH_IO_EAGLE::countNets ( wxXmlNode *  aSchematicNode )

private

Definition at line 687 of file sch_io_eagle.cpp.

References getChildrenNodes(), m_netCounts, and MapChildren().

Referenced by loadSchematic().

CreateLibrary()

void IO_BASE::CreateLibrary ( const wxString &  aLibraryPath, const STRING_UTF8_MAP *  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 SCH_IO_KICAD_LEGACY, SCH_IO_KICAD_SEXPR, and PCB_IO_KICAD_SEXPR.

Definition at line 44 of file io_base.cpp.

References NOT_IMPLEMENTED.

DeleteLibrary()

bool IO_BASE::DeleteLibrary ( const wxString &  aLibraryPath, const STRING_UTF8_MAP *  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 SCH_IO_KICAD_LEGACY, SCH_IO_KICAD_SEXPR, PCB_IO_GEDA, PCB_IO_KICAD_LEGACY, and PCB_IO_KICAD_SEXPR.

Definition at line 50 of file io_base.cpp.

References NOT_IMPLEMENTED.

DeleteSymbol()

void SCH_IO::DeleteSymbol ( const wxString &  aLibraryPath, const wxString &  aSymbolName, const STRING_UTF8_MAP *  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 117 of file sch_io.cpp.

References NOT_IMPLEMENTED.

Referenced by LIB_BUFFER::SaveBuffer().

ensureLoadedLibrary()

void SCH_IO_EAGLE::ensureLoadedLibrary ( const wxString &  aLibraryPath )

private

Definition at line 579 of file sch_io_eagle.cpp.

References _, getLibraryTimestamp(), PROGRESS_REPORTER::KeepRefreshing(), loadDrawing(), loadXmlDocument(), m_eagleLibs, m_filename, m_libName, IO_BASE::m_progressReporter, m_timestamps, m_version, MapChildren(), PROGRESS_REPORTER::Report(), and THROW_IO_ERROR.

Referenced by EnumerateSymbolLib(), and LoadSymbol().

EnumerateSymbolLib() [1/2]

void SCH_IO_EAGLE::EnumerateSymbolLib ( std::vector< LIB_SYMBOL * > &  aSymbolList, const wxString &  aLibraryPath, const STRING_UTF8_MAP *  aProperties  )

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 527 of file sch_io_eagle.cpp.

References ensureLoadedLibrary(), m_eagleLibs, m_filename, and m_libName.

EnumerateSymbolLib() [2/2]

void SCH_IO_EAGLE::EnumerateSymbolLib ( wxArrayString &  aSymbolNameList, const wxString &  aLibraryPath, const STRING_UTF8_MAP *  aProperties  )

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 508 of file sch_io_eagle.cpp.

References ensureLoadedLibrary(), m_eagleLibs, m_filename, and m_libName.

findNearestLinePoint()

std::pair< VECTOR2I, const SEG * > SCH_IO_EAGLE::findNearestLinePoint ( const VECTOR2I &  aPoint, const std::vector< SEG > &  aLines  ) const

private

Definition at line 1667 of file sch_io_eagle.cpp.

References std::abs(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by adjustNetLabels().

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_EAGLE::getCurrentScreen ( )

private

Definition at line 137 of file sch_io_eagle.cpp.

References SCH_SHEET::GetScreen(), SCH_SHEET_PATH::Last(), and m_sheetPath.

Referenced by addBusEntries(), loadInstance(), loadSegments(), loadSheet(), and moveLabels().

getCurrentSheet()

SCH_SHEET * SCH_IO_EAGLE::getCurrentSheet ( )

private

Definition at line 131 of file sch_io_eagle.cpp.

References SCH_SHEET_PATH::Last(), and m_sheetPath.

Referenced by loadSheet().

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 140 of file sch_io.cpp.

References NOT_IMPLEMENTED.

getLibFileName()

wxFileName SCH_IO_EAGLE::getLibFileName ( )

private

Checks if there are other wires or pins at the position of the tested pin.

Definition at line 169 of file sch_io_eagle.cpp.

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

Referenced by loadLibrary(), loadSchematic(), and LoadSchematicFile().

getLibName()

wxString SCH_IO_EAGLE::getLibName ( )

private

Definition at line 145 of file sch_io_eagle.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(), and LoadSchematicFile().

GetLibraryDesc()

const IO_BASE::IO_FILE_DESC SCH_IO_EAGLE::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 88 of file sch_io_eagle.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 102 of file io_base.h.

References IO_BASE::GetLibraryDesc().

Referenced by PCB_IO::CanReadFootprint().

GetLibraryOptions()

void SCH_IO::GetLibraryOptions ( STRING_UTF8_MAP *  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 125 of file sch_io.cpp.

References IO_BASE::GetLibraryOptions().

getLibraryTimestamp()

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

private

Definition at line 568 of file sch_io_eagle.cpp.

Referenced by ensureLoadedLibrary().

GetModifyHash()

int SCH_IO_EAGLE::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 374 of file sch_io_eagle.cpp.

GetName()

const wxString & IO_BASE::GetName ( ) const

inlineinherited

Return a brief hard coded name for this IO interface.

Definition at line 71 of file io_base.h.

References IO_BASE::m_name.

Referenced by SCH_IO_ALTIUM::ParseLibFile().

GetSchematicFileDesc()

const IO_BASE::IO_FILE_DESC SCH_IO_EAGLE::GetSchematicFileDesc ( ) const

inlineoverridevirtual

Returns schematic file description for the SCH_IO.

Reimplemented from SCH_IO.

Definition at line 83 of file sch_io_eagle.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.

IsLibraryWritable()

bool SCH_IO_EAGLE::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 111 of file sch_io_eagle.h.

kiCadLayer()

SCH_LAYER_ID SCH_IO_EAGLE::kiCadLayer ( int  aEagleLayer )

private

Return the matching layer or return LAYER_NOTES.

Definition at line 227 of file sch_io_eagle.cpp.

References LAYER_NOTES, and m_layerMap.

Referenced by loadCircle(), loadPolyLine(), loadRectangle(), and loadWire().

loadCircle()

SCH_SHAPE * SCH_IO_EAGLE::loadCircle ( wxXmlNode *  aCircleNode )

private

Definition at line 1573 of file sch_io_eagle.cpp.

References kiCadLayer(), ECIRCLE::layer, ECIRCLE::radius, ECOORD::ToSchUnits(), ECIRCLE::width, ECIRCLE::x, VECTOR2< T >::x, ECIRCLE::y, and VECTOR2< T >::y.

Referenced by loadSheet().

loadDrawing()

void SCH_IO_EAGLE::loadDrawing ( wxXmlNode *  aDrawingNode )

private

Definition at line 652 of file sch_io_eagle.cpp.

References loadLayerDefs(), loadLibrary(), loadSchematic(), m_eagleLibs, m_libName, MapChildren(), and EAGLE_LIBRARY::name.

Referenced by ensureLoadedLibrary(), and LoadSchematicFile().

loadFieldAttributes()

void SCH_IO_EAGLE::loadFieldAttributes ( SCH_FIELD *  aField, const SCH_TEXT *  aText  ) const

private

Move net labels that are detached from any wire to the nearest wire.

Definition at line 2768 of file sch_io_eagle.cpp.

References EDA_TEXT::GetHorizJustify(), SCH_TEXT::GetPosition(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetVertJustify(), EDA_TEXT::IsBold(), EDA_TEXT::SetBold(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextSize(), and EDA_TEXT::SetVertJustify().

Referenced by loadSymbol().

loadFrame()

void SCH_IO_EAGLE::loadFrame ( wxXmlNode *  aFrameNode, std::vector< SCH_ITEM * > &  aItems  )

private

Definition at line 1150 of file sch_io_eagle.cpp.

References SCH_SHAPE::AddPoint(), EFRAME::border_bottom, EFRAME::border_left, EFRAME::border_right, EFRAME::border_top, EFRAME::columns, GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, KiROUND(), EDA_IU_SCALE::MilsToIU(), EFRAME::rows, schIUScale, EDA_TEXT::SetHorizJustify(), SCH_TEXT::SetPosition(), EDA_TEXT::SetText(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetVertJustify(), ECOORD::ToSchUnits(), EFRAME::x1, EFRAME::x2, EFRAME::y1, and EFRAME::y2.

Referenced by loadSheet().

loadInstance()

void SCH_IO_EAGLE::loadInstance ( wxXmlNode *  aInstanceNode )

private

Definition at line 1713 of file sch_io_eagle.cpp.

References _, EATTR::align, SCH_SCREEN::Append(), EPART::attribute, ETEXT::BOTTOM_LEFT, CTX_LIBID, EROT::degrees, EPART::device, EPART::deviceset, EATTR::display, eagleToKicadAlignment(), EscapeString(), FOOTPRINT_FIELD, EINSTANCE::gate, OPTIONAL_XML_ATTRIBUTE< T >::Get(), getCurrentScreen(), LIB_SYMBOL::GetFieldById(), LIB_SYMBOL::GetFields(), SCH_FIELD::GetPosition(), LIB_SYMBOL::IsPower(), EDA_TEXT::IsVisible(), kiCadComponentRotation(), EPART::library, SYMBOL_LIB_TABLE::LoadSymbol(), m_eagleLibs, m_partlist, IO_BASE::m_reporter, EROT::mirror, EATTR::name, EATTR::NAME, EATTR::Off, EAGLE_LIBRARY::package, EINSTANCE::part, pin, REFERENCE_FIELD, REPORTER::Report(), EATTR::rot, EINSTANCE::rot, RPT_SEVERITY_ERROR, PROJECT_SCH::SchSymbolLibTable(), SCH_FIELD::SetName(), SCH_FIELD::SetPosition(), SCH_FIELD::SetText(), EDA_TEXT::SetVisible(), EINSTANCE::smashed, EROT::spin, ECOORD::ToSchUnits(), UnescapeString(), EPART::value, VALUE_FIELD, EPART::variant, EATTR::x, EINSTANCE::x, EATTR::y, and EINSTANCE::y.

Referenced by loadSheet().

loadJunction()

SCH_JUNCTION * SCH_IO_EAGLE::loadJunction ( wxXmlNode *  aJunction )

private

Definition at line 1617 of file sch_io_eagle.cpp.

References ECOORD::ToSchUnits(), EJUNCTION::x, and EJUNCTION::y.

Referenced by loadSegments().

loadLabel()

SCH_TEXT * SCH_IO_EAGLE::loadLabel ( wxXmlNode *  aLabelNode, const wxString &  aNetName  )

private

Definition at line 1630 of file sch_io_eagle.cpp.

References EROT::degrees, escapeName(), KiROUND(), m_netCounts, EROT::mirror, ELABEL::netname, SPIN_STYLE::RIGHT, ELABEL::rot, ELABEL::size, ECOORD::ToSchUnits(), ELABEL::x, and ELABEL::y.

Referenced by loadSegments().

loadLayerDefs()

void SCH_IO_EAGLE::loadLayerDefs ( wxXmlNode *  aLayers )

private

Layers in KiCad schematics are not actually layers, but abstract groups mainly used to decide item colors.

<layers> <layer number="90" name="Modules" color="5" fill="1" visible="yes" active="yes"> <layer number="91" name="Nets" color="2" fill="1" visible="yes" active="yes"> <layer number="92" name="Busses" color="1" fill="1" visible="yes" active="yes"> <layer number="93" name="Pins" color="2" fill="1" visible="no" active="yes"> <layer number="94" name="Symbols" color="4" fill="1" visible="yes" active="yes"> <layer number="95" name="Names" color="7" fill="1" visible="yes" active="yes"> <layer number="96" name="Values" color="7" fill="1" visible="yes" active="yes"> <layer number="97" name="Info" color="7" fill="1" visible="yes" active="yes"> <layer number="98" name="Guide" color="6" fill="1" visible="yes" active="yes"> </layers>

Definition at line 182 of file sch_io_eagle.cpp.

References LAYER_BUS, LAYER_NOTES, LAYER_WIRE, and m_layerMap.

Referenced by loadDrawing().

loadLibrary()

EAGLE_LIBRARY * SCH_IO_EAGLE::loadLibrary ( wxXmlNode *  aLibraryNode, EAGLE_LIBRARY *  aEagleLib  )

private

Definition at line 1982 of file sch_io_eagle.cpp.

References checkpoint(), convertDescription(), countChildren(), CTX_LIBID, EscapeString(), EAGLE_LIBRARY::GateUnit, OPTIONAL_XML_ATTRIBUTE< T >::Get(), getChildrenNodes(), getLibFileName(), PROJECT::GetProjectName(), EAGLE_LIBRARY::KiCadSymbols, loadSymbol(), m_libName, m_pi, m_properties, m_schematic, m_userValue, MapChildren(), EGATE::name, EDEVICE::name, EDEVICE_SET::name, EAGLE_LIBRARY::name, EDEVICE::package, EAGLE_LIBRARY::package, EDEVICE_SET::prefix, SCHEMATIC::Prj(), REFERENCE_FIELD, SCH_FIELD::SetText(), EDA_TEXT::SetVisible(), EGATE::symbol, EAGLE_LIBRARY::SymbolNodes, UnescapeHTML(), and EDEVICE_SET::uservalue.

Referenced by loadDrawing(), and loadSchematic().

loadPin()

SCH_PIN * SCH_IO_EAGLE::loadPin ( std::unique_ptr< LIB_SYMBOL > &  aSymbol, wxXmlNode *  aPin, EPIN *  epin, int  aGateNumber  )

private

Definition at line 2429 of file sch_io_eagle.cpp.

References EROT::degrees, EPIN::function, OPTIONAL_XML_ATTRIBUTE< T >::Get(), EPIN::length, EDA_IU_SCALE::MilsToIU(), EPIN::name, pin, EPIN::rot, schIUScale, ECOORD::ToSchUnits(), EPIN::visible, EPIN::x, and EPIN::y.

Referenced by loadSymbol().

loadPlainText()

SCH_TEXT * SCH_IO_EAGLE::loadPlainText ( wxXmlNode *  aSchText )

private

Definition at line 2722 of file sch_io_eagle.cpp.

References escapeName(), interpretText(), loadTextAttributes(), ECOORD::ToSchUnits(), ETEXT::x, and ETEXT::y.

Referenced by loadSheet().

loadPolyLine()

SCH_SHAPE * SCH_IO_EAGLE::loadPolyLine ( wxXmlNode *  aPolygonNode )

private

Definition at line 1489 of file sch_io_eagle.cpp.

References ARC_ACCURACY, SHAPE_ARC::ConstructFromStartEndAngle(), EVERTEX::curve, DEGREES_T, kiCadLayer(), EPOLYGON::layer, ECOORD::ToSchUnits(), EPOLYGON::width, EVERTEX::x, and EVERTEX::y.

Referenced by loadSheet().

loadRectangle()

SCH_SHAPE * SCH_IO_EAGLE::loadRectangle ( wxXmlNode *  aRectNode )

private

Definition at line 1588 of file sch_io_eagle.cpp.

References EROT::degrees, DEGREES_T, kiCadLayer(), ERECT::layer, ERECT::rot, RotatePoint(), ECOORD::ToSchUnits(), ERECT::x1, ERECT::x2, ERECT::y1, and ERECT::y2.

Referenced by loadSheet().

loadSchematic()

void SCH_IO_EAGLE::loadSchematic ( wxXmlNode *  aSchematicNode )

private

Definition at line 721 of file sch_io_eagle.cpp.

References addImplicitConnections(), SCH_SCREEN::Append(), checkpoint(), countChildren(), countNets(), SCH_ITEM::Duplicate(), BOX2< Vec >::GetBottom(), getChildrenNodes(), SCH_SYMBOL::GetField(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetLeft(), getLibFileName(), SCH_SCREEN::GetPageSettings(), SCH_SHEET::GetScreen(), getSheetBbox(), PAGE_INFO::GetSizeIU(), EDA_TEXT::GetText(), BOX2< Vec >::GetWidth(), BOX2< Vec >::GetY(), EDA_IU_SCALE::IU_PER_MILS, loadLibrary(), loadSheet(), SCH_SHEET::LocatePathOfScreen(), m_doneCount, m_eagleLibs, m_missingCmps, m_partlist, m_pi, IO_BASE::m_progressReporter, m_rootSheet, m_schematic, m_sheetPath, m_totalCount, MapChildren(), EDA_IU_SCALE::MilsToIU(), EAGLE_LIBRARY::name, SCH_SHEET_PATH::Path(), SCH_SHEET_PATH::pop_back(), SCH_SHEET_PATH::push_back(), REFERENCE_FIELD, schIUScale, SCH_SCREEN::SetFileName(), SCH_SHEET_PATH::SetPageNumber(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadDrawing().

LoadSchematicFile()

SCH_SHEET * SCH_IO_EAGLE::LoadSchematicFile ( const wxString &  aFileName, SCHEMATIC *  aSchematic, SCH_SHEET *  aAppendToMe = nullptr, const STRING_UTF8_MAP *  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 400 of file sch_io_eagle.cpp.

References _, PROJECT::ELEM_SYMBOL_LIB_TABLE, SYMBOL_LIB_TABLE::Format(), getLibFileName(), getLibName(), PROJECT::GetProjectPath(), SCH_SHEET::GetScreen(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), SCH_SCREEN::GetUuid(), LIB_TABLE::HasLibrary(), LIB_TABLE::InsertRow(), SCHEMATIC::IsValid(), PROGRESS_REPORTER::KeepRefreshing(), FILEEXT::KiCadSchematicFileExtension, loadDrawing(), loadXmlDocument(), m_filename, m_pi, IO_BASE::m_progressReporter, m_properties, m_rootSheet, m_schematic, EDA_ITEM::m_Uuid, m_version, MapChildren(), SCHEMATIC::Prj(), SCH_IO_KICAD_LEGACY::PropBuffering, PROGRESS_REPORTER::Report(), SCHEMATIC::Root(), PROJECT_SCH::SchSymbolLibTable(), PROJECT::SetElem(), SCH_SCREEN::SetFileName(), SCH_SHEET::SetFileName(), SCHEMATIC::SetRoot(), SCH_SHEET::SetScreen(), THROW_IO_ERROR, and SCH_SCREENS::UpdateSymbolLinks().

loadSegments()

void SCH_IO_EAGLE::loadSegments ( wxXmlNode *  aSegmentsNode, const wxString &  aNetName, const wxString &  aNetClass  )

private

Definition at line 1347 of file sch_io_eagle.cpp.

References SEG::A, SCH_SCREEN::Append(), SEG::B, countChildren(), CTX_NETNAME, escapeName(), EscapeString(), getCurrentScreen(), EDA_TEXT::GetText(), SEG::Intersect(), SCH_IO_EAGLE::SEG_DESC::labels, SPIN_STYLE::LEFT, loadJunction(), loadLabel(), loadWire(), m_connPoints, m_netCounts, m_powerPorts, m_segments, m_wireIntersections, MapChildren(), EDA_IU_SCALE::MilsToIU(), pin, SPIN_STYLE::RIGHT, schIUScale, SCH_IO_EAGLE::SEG_DESC::segs, and VECTOR2< T >::x.

Referenced by loadSheet().

loadSheet()

void SCH_IO_EAGLE::loadSheet ( wxXmlNode *  aSheetNode, int  sheetcount  )

private

Definition at line 939 of file sch_io_eagle.cpp.

References addBusEntries(), addImplicitConnections(), adjustNetLabels(), SCH_SCREEN::Append(), SCH_SHEET::AutoplaceFields(), EE_RTREE::begin(), BOX2< Vec >::Centre(), checkpoint(), EE_RTREE::end(), getChildrenNodes(), getCurrentScreen(), getCurrentSheet(), SCH_SHEET::GetFields(), SCH_SCREEN::GetPageSettings(), getSheetBbox(), BOX2< Vec >::GetSize(), PAGE_INFO::GetSizeIU(), SCH_SCREEN::Items(), EDA_IU_SCALE::IU_PER_MILS, EDA_IU_SCALE::IUToMils(), FILEEXT::KiCadSchematicFileExtension, loadCircle(), loadFrame(), loadInstance(), loadPlainText(), loadPolyLine(), loadRectangle(), loadSegments(), loadWire(), m_connPoints, m_filename, MapChildren(), EDA_IU_SCALE::MilsToIU(), EE_RTREE::OfType(), ReplaceIllegalFileNameChars(), SCH_SYMBOL_T, schIUScale, SCH_SCREEN::SetFileName(), PAGE_INFO::SetHeightMils(), SCH_SCREEN::SetPageSettings(), SCH_FIELD::SetText(), PAGE_INFO::SetWidthMils(), SHEETFILENAME, SHEETNAME, translateEagleBusName(), SCH_SCREEN::Update(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadSchematic().

LoadSymbol()

LIB_SYMBOL * SCH_IO_EAGLE::LoadSymbol ( const wxString &  aLibraryPath, const wxString &  aPartName, const STRING_UTF8_MAP *  aProperties  )

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 546 of file sch_io_eagle.cpp.

References ensureLoadedLibrary(), m_eagleLibs, m_filename, and m_libName.

loadSymbol()

bool SCH_IO_EAGLE::loadSymbol ( wxXmlNode *  aSymbolNode, std::unique_ptr< LIB_SYMBOL > &  aSymbol, EDEVICE *  aDevice, int  aGateNumber, const wxString &  aGateName  )

private

Definition at line 2129 of file sch_io_eagle.cpp.

References EDEVICE::connects, EPIN::direction, escapeName(), ECONNECT::gate, loadFieldAttributes(), loadPin(), loadSymbolCircle(), loadSymbolFrame(), loadSymbolPolyLine(), loadSymbolRectangle(), loadSymbolText(), loadSymbolWire(), ECONNECT::pad, ECONNECT::pin, pin, pinDirectionsMap, REFERENCE_FIELD, SCH_PIN::SetNumber(), and VALUE_FIELD.

Referenced by loadLibrary().

loadSymbolCircle()

SCH_SHAPE * SCH_IO_EAGLE::loadSymbolCircle ( wxXmlNode *  aCircleNode, int  aGateNumber  )

private

Definition at line 2285 of file sch_io_eagle.cpp.

References LAYER_DEVICE, ECIRCLE::radius, EDA_SHAPE::SetEnd(), SCH_SHAPE::SetPosition(), SCH_SHAPE::SetStroke(), SCH_ITEM::SetUnit(), ECOORD::ToSchUnits(), ECIRCLE::width, ECIRCLE::x, VECTOR2< T >::x, ECIRCLE::y, and VECTOR2< T >::y.

Referenced by loadSymbol().

loadSymbolFrame()

void SCH_IO_EAGLE::loadSymbolFrame ( wxXmlNode *  aFrameNode, std::vector< SCH_ITEM * > &  aLines  )

private

Definition at line 2537 of file sch_io_eagle.cpp.

References SCH_SHAPE::AddPoint(), EFRAME::border_bottom, EFRAME::border_left, EFRAME::border_right, EFRAME::border_top, EFRAME::columns, KiROUND(), LAYER_DEVICE, EDA_IU_SCALE::MilsToIU(), EFRAME::rows, schIUScale, EDA_TEXT::SetTextSize(), ECOORD::ToSchUnits(), EFRAME::x1, EFRAME::x2, EFRAME::y1, and EFRAME::y2.

Referenced by loadSymbol().

loadSymbolPolyLine()

SCH_SHAPE * SCH_IO_EAGLE::loadSymbolPolyLine ( wxXmlNode *  aPolygonNode, int  aGateNumber  )

private

Definition at line 2388 of file sch_io_eagle.cpp.

References SCH_SHAPE::AddPoint(), SHAPE_POLY_SET::Append(), ARC_ACCURACY, SHAPE_ARC::ConstructFromStartEndAngle(), EVERTEX::curve, DEGREES_T, EDA_SHAPE::GetPolyShape(), LAYER_DEVICE, EDA_SHAPE::SetFillMode(), SCH_SHAPE::SetStroke(), SCH_ITEM::SetUnit(), ECOORD::ToSchUnits(), EPOLYGON::width, EVERTEX::x, and EVERTEX::y.

Referenced by loadSymbol().

loadSymbolRectangle()

SCH_SHAPE * SCH_IO_EAGLE::loadSymbolRectangle ( wxXmlNode *  aRectNode, int  aGateNumber  )

private

Definition at line 2301 of file sch_io_eagle.cpp.

References EROT::degrees, DEGREES_T, SCH_SHAPE::GetCenter(), EDA_SHAPE::GetEnd(), SCH_SHAPE::GetPosition(), LAYER_DEVICE, ERECT::rot, RotatePoint(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillMode(), SCH_SHAPE::SetPosition(), SCH_ITEM::SetUnit(), ECOORD::ToSchUnits(), ERECT::x1, ERECT::x2, ERECT::y1, and ERECT::y2.

Referenced by loadSymbol().

loadSymbolText()

SCH_TEXT * SCH_IO_EAGLE::loadSymbolText ( wxXmlNode *  aLibText, int  aGateNumber  )

private

Definition at line 2506 of file sch_io_eagle.cpp.

References interpretText(), LAYER_DEVICE, loadTextAttributes(), ECOORD::ToSchUnits(), ETEXT::x, and ETEXT::y.

Referenced by loadSymbol().

loadSymbolWire()

SCH_ITEM * SCH_IO_EAGLE::loadSymbolWire ( wxXmlNode *  aWireNode, int  aGateNumber  )

private

Definition at line 2331 of file sch_io_eagle.cpp.

References SCH_SHAPE::AddPoint(), EWIRE::cap, ConvertArcCenter(), EWIRE::curve, DEGREES_T, EWIRE::FLAT, LAYER_DEVICE, EDA_SHAPE::SetArcAngleAndEnd(), EDA_SHAPE::SetCenter(), EDA_SHAPE::SetFillMode(), EDA_SHAPE::SetStart(), SCH_SHAPE::SetStroke(), SCH_ITEM::SetUnit(), ECOORD::ToSchUnits(), EWIRE::width, VECTOR2< T >::x, EWIRE::x1, EWIRE::x2, VECTOR2< T >::y, EWIRE::y1, and EWIRE::y2.

Referenced by loadSymbol().

loadTextAttributes()

void SCH_IO_EAGLE::loadTextAttributes ( EDA_TEXT *  aText, const ETEXT &  aAttribs  ) const

private

Definition at line 2751 of file sch_io_eagle.cpp.

References ETEXT::align, ETEXT::BOTTOM_LEFT, OPTIONAL_XML_ATTRIBUTE< T >::CGet(), ETEXT::ConvertSize(), EROT::degrees, eagleToKicadAlignment(), EROT::mirror, ETEXT::ratio, ETEXT::rot, EDA_TEXT::SetBold(), EDA_TEXT::SetTextSize(), and EROT::spin.

Referenced by loadPlainText(), and loadSymbolText().

loadWire()

SCH_ITEM * SCH_IO_EAGLE::loadWire ( wxXmlNode *  aWireNode, SEG &  endpoints  )

private

Definition at line 1530 of file sch_io_eagle.cpp.

References ConvertArcCenter(), EWIRE::curve, DEGREES_T, kiCadLayer(), EWIRE::layer, ECOORD::ToSchUnits(), EWIRE::width, VECTOR2< T >::x, EWIRE::x1, EWIRE::x2, VECTOR2< T >::y, EWIRE::y1, and EWIRE::y2.

Referenced by loadSegments(), and loadSheet().

loadXmlDocument()

wxXmlDocument SCH_IO_EAGLE::loadXmlDocument ( const wxString &  aFileName )

private

Definition at line 620 of file sch_io_eagle.cpp.

References _, m_filename, text, and THROW_IO_ERROR.

Referenced by ensureLoadedLibrary(), and LoadSchematicFile().

moveLabels()

void SCH_IO_EAGLE::moveLabels ( SCH_LINE *  aWire, const VECTOR2I &  aNewEndPoint  )

private

Move any labels on the wire to the new end point of the wire.

Definition at line 2898 of file sch_io_eagle.cpp.

References SCH_LINE::GetBoundingBox(), getCurrentScreen(), SCH_LINE::GetEndPoint(), SCH_LINE::GetStartPoint(), SCH_SCREEN::Items(), EE_RTREE::Overlapping(), and TestSegmentHit().

Referenced by addBusEntries().

netHasPowerDriver()

bool SCH_IO_EAGLE::netHasPowerDriver ( SCH_LINE *  aLine, const wxString &  aNetName  ) const

private

SaveLibrary()

void SCH_IO::SaveLibrary ( const wxString &  aFileName, const STRING_UTF8_MAP *  aProperties = nullptr  )

virtualinherited

Reimplemented in SCH_IO_KICAD_LEGACY, and SCH_IO_KICAD_SEXPR.

Definition at line 62 of file sch_io.cpp.

References NOT_IMPLEMENTED.

SaveSchematicFile()

void SCH_IO::SaveSchematicFile ( const wxString &  aFileName, SCH_SHEET *  aSheet, SCHEMATIC *  aSchematic, const STRING_UTF8_MAP *  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 75 of file sch_io.cpp.

References NOT_IMPLEMENTED.

SaveSymbol()

void SCH_IO::SaveSymbol ( const wxString &  aLibraryPath, const LIB_SYMBOL *  aSymbol, const STRING_UTF8_MAP *  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 109 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 81 of file io_base.h.

References IO_BASE::m_progressReporter.

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 76 of file io_base.h.

References IO_BASE::m_reporter.

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.

translateEagleBusName()

wxString SCH_IO_EAGLE::translateEagleBusName ( const wxString &  aEagleName ) const

private

Translate an Eagle-style bus name into one that is KiCad-compatible.

For vector buses such as A[7..0] this has no impact. For group buses, we translate from Eagle-style to KiCad-style.

Parameters

aEagleName

is the name of the bus from the Eagle schematic

Definition at line 3597 of file sch_io_eagle.cpp.

References NET_SETTINGS::ParseBusVector().

Referenced by loadSheet().

Member Data Documentation

ARC_ACCURACY

const double SCH_IO_EAGLE::ARC_ACCURACY = SCH_IU_PER_MM * 0.01

Definition at line 78 of file sch_io_eagle.h.

Referenced by loadPolyLine(), and loadSymbolPolyLine().

m_connPoints

std::map<VECTOR2I, std::set<const EDA_ITEM*> > SCH_IO_EAGLE::m_connPoints

private

Definition at line 272 of file sch_io_eagle.h.

Referenced by checkConnections(), loadSegments(), and loadSheet().

m_doneCount

unsigned SCH_IO_EAGLE::m_doneCount

private

Definition at line 242 of file sch_io_eagle.h.

Referenced by checkpoint(), and loadSchematic().

m_eagleLibs

std::map<wxString, EAGLE_LIBRARY> SCH_IO_EAGLE::m_eagleLibs

private

Definition at line 236 of file sch_io_eagle.h.

Referenced by ensureLoadedLibrary(), EnumerateSymbolLib(), loadDrawing(), loadInstance(), loadSchematic(), and LoadSymbol().

m_filename

wxFileName SCH_IO_EAGLE::m_filename

private

Definition at line 230 of file sch_io_eagle.h.

Referenced by ensureLoadedLibrary(), EnumerateSymbolLib(), LoadSchematicFile(), loadSheet(), LoadSymbol(), and loadXmlDocument().

m_lastProgressCount

unsigned SCH_IO_EAGLE::m_lastProgressCount

private

Definition at line 243 of file sch_io_eagle.h.

Referenced by checkpoint().

m_layerMap

std::map<int, SCH_LAYER_ID> SCH_IO_EAGLE::m_layerMap

private

Definition at line 247 of file sch_io_eagle.h.

Referenced by kiCadLayer(), and loadLayerDefs().

m_libName

wxString SCH_IO_EAGLE::m_libName

private

Library name to save symbols.

Definition at line 231 of file sch_io_eagle.h.

Referenced by ensureLoadedLibrary(), EnumerateSymbolLib(), getLibName(), loadDrawing(), loadLibrary(), and LoadSymbol().

m_missingCmps

std::map<wxString, EAGLE_MISSING_CMP> SCH_IO_EAGLE::m_missingCmps

private

Definition at line 225 of file sch_io_eagle.h.

Referenced by addImplicitConnections(), and loadSchematic().

m_name

wxString IO_BASE::m_name

protectedinherited

Name of the IO loader.

Definition at line 207 of file io_base.h.

Referenced by IO_BASE::GetName().

m_netCounts

std::map<wxString, int> SCH_IO_EAGLE::m_netCounts

private

Definition at line 246 of file sch_io_eagle.h.

Referenced by countNets(), loadLabel(), and loadSegments().

m_nets

std::map<wxString, ENET> SCH_IO_EAGLE::m_nets

private

Positions of pins and wire endings mapped to its parent.

Definition at line 269 of file sch_io_eagle.h.

m_partlist

EPART_MAP SCH_IO_EAGLE::m_partlist

private

Definition at line 234 of file sch_io_eagle.h.

Referenced by loadInstance(), and loadSchematic().

m_pi

IO_RELEASER<SCH_IO> SCH_IO_EAGLE::m_pi

private

PI to create KiCad symbol library.

Definition at line 239 of file sch_io_eagle.h.

Referenced by loadLibrary(), loadSchematic(), and LoadSchematicFile().

m_powerPorts

std::map<wxString, wxString> SCH_IO_EAGLE::m_powerPorts

private

map from symbol reference to global label equivalent

Wire intersection points, used for quick checks whether placing a net label in a particular place would short two nets.

Definition at line 248 of file sch_io_eagle.h.

Referenced by loadSegments().

m_progressReporter

PROGRESS_REPORTER* IO_BASE::m_progressReporter

protectedinherited

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

Definition at line 213 of file io_base.h.

Referenced by checkpoint(), SCH_IO_KICAD_LEGACY::checkpoint(), ensureLoadedLibrary(), SCH_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), 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(), loadSchematic(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), PCB_IO_IPC2581::SaveBoard(), IO_BASE::SetProgressReporter(), and SCH_IO_CADSTAR_ARCHIVE::SetProgressReporter().

m_properties

std::unique_ptr<STRING_UTF8_MAP> SCH_IO_EAGLE::m_properties

private

Library plugin properties.

Definition at line 240 of file sch_io_eagle.h.

Referenced by loadLibrary(), and LoadSchematicFile().

m_reporter

REPORTER* IO_BASE::m_reporter

protectedinherited

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

Definition at line 210 of file io_base.h.

Referenced by SCH_IO_ALTIUM::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(), loadInstance(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), SCH_IO_ALTIUM::ParseAltiumSch(), SCH_IO_ALTIUM::ParseArc(), SCH_IO_ALTIUM::ParseBezier(), SCH_IO_ALTIUM::ParseCircle(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_ALTIUM::ParseDesignator(), SCH_IO_ALTIUM::ParseEllipse(), SCH_IO_ALTIUM::ParseEllipticalArc(), SCH_IO_ALTIUM::ParseFileName(), SCH_IO_ALTIUM::ParseHarnessConnector(), SCH_IO_ALTIUM::ParseHarnessEntry(), SCH_IO_ALTIUM::ParseHarnessPort(), SCH_IO_ALTIUM::ParseHarnessType(), SCH_IO_ALTIUM::ParseImage(), SCH_IO_ALTIUM::ParseImplementation(), SCH_IO_ALTIUM::ParseLabel(), SCH_IO_ALTIUM::ParseLibFile(), SCH_IO_ALTIUM::ParseLine(), SCH_IO_ALTIUM::ParsePin(), SCH_IO_ALTIUM::ParsePolygon(), SCH_IO_ALTIUM::ParsePolyline(), SCH_IO_ALTIUM::ParsePort(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_IO_ALTIUM::ParseRecord(), SCH_IO_ALTIUM::ParseRectangle(), SCH_IO_ALTIUM::ParseRoundRectangle(), SCH_IO_ALTIUM::ParseSheetEntry(), SCH_IO_ALTIUM::ParseSheetName(), SCH_IO_ALTIUM::ParseSignalHarness(), SCH_IO_ALTIUM::ParseStorage(), PCB_IO_ALTIUM_DESIGNER::PCB_IO_ALTIUM_DESIGNER(), PCB_IO_SOLIDWORKS::PCB_IO_SOLIDWORKS(), SCH_IO_ALTIUM::SCH_IO_ALTIUM(), SCH_IO_CADSTAR_ARCHIVE::SCH_IO_CADSTAR_ARCHIVE(), SCH_IO_EAGLE(), SCH_IO_EASYEDA::SCH_IO_EASYEDA(), SCH_IO_EASYEDAPRO::SCH_IO_EASYEDAPRO(), SCH_IO_LTSPICE::SCH_IO_LTSPICE(), IO_BASE::SetReporter(), and SCH_IO_CADSTAR_ARCHIVE::SetReporter().

m_rootSheet

SCH_SHEET* SCH_IO_EAGLE::m_rootSheet

private

The root sheet of the schematic being loaded.

Definition at line 227 of file sch_io_eagle.h.

Referenced by getLibName(), loadSchematic(), LoadSchematicFile(), and SCH_IO_EAGLE().

m_schematic

SCHEMATIC* SCH_IO_EAGLE::m_schematic

private

Passed to Load(), the schematic object being loaded.

Definition at line 232 of file sch_io_eagle.h.

Referenced by getLibFileName(), getLibName(), loadLibrary(), loadSchematic(), LoadSchematicFile(), and SCH_IO_EAGLE().

m_segments

std::vector<SEG_DESC> SCH_IO_EAGLE::m_segments

private

Nets as defined in the <nets> sections of an Eagle schematic file.

Definition at line 266 of file sch_io_eagle.h.

Referenced by adjustNetLabels(), and loadSegments().

m_sheetPath

SCH_SHEET_PATH SCH_IO_EAGLE::m_sheetPath

private

The current sheet path of the schematic being loaded.

Definition at line 228 of file sch_io_eagle.h.

Referenced by getCurrentScreen(), getCurrentSheet(), and loadSchematic().

m_timestamps

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

private

Definition at line 235 of file sch_io_eagle.h.

Referenced by ensureLoadedLibrary().

m_totalCount

unsigned SCH_IO_EAGLE::m_totalCount

private

for progress reporting

Definition at line 244 of file sch_io_eagle.h.

Referenced by checkpoint(), and loadSchematic().

m_userValue

std::unordered_map<wxString, bool> SCH_IO_EAGLE::m_userValue

private

deviceset/@uservalue for device.

Definition at line 237 of file sch_io_eagle.h.

Referenced by loadLibrary().

m_version

wxString SCH_IO_EAGLE::m_version

private

Eagle file version.

Definition at line 229 of file sch_io_eagle.h.

Referenced by ensureLoadedLibrary(), and LoadSchematicFile().

m_wireIntersections

std::vector<VECTOR2I> SCH_IO_EAGLE::m_wireIntersections

private

Wires and labels of a single connection (segment in Eagle nomenclature)

Definition at line 253 of file sch_io_eagle.h.

Referenced by adjustNetLabels(), and loadSegments().

---

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

• sch_io_eagle.h
• sch_io_eagle.cpp