SCH_ALTIUM_PLUGIN Class Reference

SCH_ALTIUM_PLUGIN is a SCH_PLUGIN derivation for loading Altium .SchDoc schematic files. More...

#include <sch_altium_plugin.h>

Inheritance diagram for SCH_ALTIUM_PLUGIN:

Public Member Functions
	SCH_ALTIUM_PLUGIN ()
	~SCH_ALTIUM_PLUGIN ()
const wxString	GetName () const override
	Return a brief hard coded name for this SCH_PLUGIN. More...
void	SetReporter (REPORTER *aReporter) override
	Set an optional reporter for warnings/errors. More...
const wxString	GetFileExtension () const override
	Return the file extension for the SCH_PLUGIN. More...
const wxString	GetLibraryFileExtension () const override
	Return the library file extension for the SCH_PLUGIN object. More...
int	GetModifyHash () const override
	Return the modification hash from the library cache. More...
SCH_SHEET *	Load (const wxString &aFileName, SCHEMATIC *aSchematic, SCH_SHEET *aAppendToMe=nullptr, const PROPERTIES *aProperties=nullptr) override
	Load information from some input file format that this SCH_PLUGIN implementation knows about, into either a new SCH_SHEET or an existing one. More...
bool	CheckHeader (const wxString &aFileName) override
	Return true if the first line in aFileName begins with the expected header. More...
wxString	getLibName ()
wxFileName	getLibFileName ()
void	ParseAltiumSch (const wxString &aFileName)
void	Parse (const CFB::CompoundFileReader &aReader)
virtual void	SaveLibrary (const wxString &aFileName, const PROPERTIES *aProperties=nullptr)
virtual void	Save (const wxString &aFileName, SCH_SHEET *aSheet, SCHEMATIC *aSchematic, const PROPERTIES *aProperties=nullptr)
	Write aSchematic to a storage file in a format that this SCH_PLUGIN implementation knows about, or it can be used to write a portion of aSchematic to a special kind of export file. More...
virtual void	EnumerateSymbolLib (wxArrayString &aSymbolNameList, const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr)
	Populate a list of LIB_PART alias names contained within the library aLibraryPath. More...
virtual void	EnumerateSymbolLib (std::vector< LIB_PART * > &aSymbolList, const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr)
	Populate a list of LIB_PART aliases contained within the library aLibraryPath. More...
virtual LIB_PART *	LoadSymbol (const wxString &aLibraryPath, const wxString &aPartName, const PROPERTIES *aProperties=nullptr)
	Load a LIB_PART object having aPartName from the aLibraryPath containing a library format that this SCH_PLUGIN knows about. More...
virtual void	SaveSymbol (const wxString &aLibraryPath, const LIB_PART *aSymbol, const PROPERTIES *aProperties=nullptr)
	Write aSymbol to an existing library located at aLibraryPath. More...
virtual void	DeleteSymbol (const wxString &aLibraryPath, const wxString &aSymbolName, const PROPERTIES *aProperties=nullptr)
	Delete the entire LIB_PART associated with aAliasName from the library aLibraryPath. More...
virtual void	CreateSymbolLib (const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr)
	Create a new empty symbol library at aLibraryPath. More...
virtual bool	DeleteSymbolLib (const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr)
	Delete an existing symbol library and returns true if successful, 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. More...
virtual bool	IsSymbolLibWritable (const wxString &aLibraryPath)
	Return true if the library at aLibraryPath is writable. More...
virtual void	SymbolLibOptions (PROPERTIES *aListToAppendTo) const
	Append supported SCH_PLUGIN options to aListToAppenTo along with internationalized descriptions. More...
virtual const wxString &	GetError () const
	Return an error string to the caller. More...

Private Member Functions
bool	IsComponentPartVisible (int aOwnerindex, int aOwnerpartdisplaymode) const
void	ParseComponent (int aIndex, const std::map< wxString, wxString > &aProperties)
void	ParsePin (const std::map< wxString, wxString > &aProperties)
void	ParseLabel (const std::map< wxString, wxString > &aProperties)
void	ParseBezier (const std::map< wxString, wxString > &aProperties)
void	ParsePolyline (const std::map< wxString, wxString > &aProperties)
void	ParsePolygon (const std::map< wxString, wxString > &aProperties)
void	ParseRoundRectangle (const std::map< wxString, wxString > &aProperties)
void	ParseArc (const std::map< wxString, wxString > &aProperties)
void	ParseLine (const std::map< wxString, wxString > &aProperties)
void	ParseRectangle (const std::map< wxString, wxString > &aProperties)
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	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	ParseBusEntry (const std::map< wxString, wxString > &aProperties)
void	ParseParameter (const std::map< wxString, wxString > &aProperties)

Private Attributes
REPORTER *	m_reporter
SCH_SHEET *	m_rootSheet
SCH_SHEET *	m_currentSheet
SCHEMATIC *	m_schematic
wxString	m_libName
SCH_PLUGIN::SCH_PLUGIN_RELEASER	m_pi
std::unique_ptr< PROPERTIES >	m_properties
std::unique_ptr< TITLE_BLOCK >	m_currentTitleBlock
wxPoint	m_sheetOffset
std::unique_ptr< ASCH_SHEET >	m_altiumSheet
std::map< int, SCH_COMPONENT * >	m_components
std::map< int, SCH_SHEET * >	m_sheets
std::map< int, LIB_PART * >	m_symbols
std::map< wxString, LIB_PART * >	m_powerSymbols
std::map< int, ASCH_COMPONENT >	m_altiumComponents
std::vector< ASCH_PORT >	m_altiumPortsCurrentSheet

Detailed Description

SCH_ALTIUM_PLUGIN is a SCH_PLUGIN derivation for loading Altium .SchDoc schematic files.

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

Definition at line 50 of file sch_altium_plugin.h.

Constructor & Destructor Documentation

SCH_ALTIUM_PLUGIN()

SCH_ALTIUM_PLUGIN::SCH_ALTIUM_PLUGIN

(

)

Definition at line 79 of file sch_altium_plugin.cpp.

{
    m_rootSheet    = nullptr;
    m_currentSheet = nullptr;
    m_schematic    = nullptr;

    m_reporter     = &WXLOG_REPORTER::GetInstance();
}

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

~SCH_ALTIUM_PLUGIN()

SCH_ALTIUM_PLUGIN::~SCH_ALTIUM_PLUGIN

(

)

Definition at line 89 of file sch_altium_plugin.cpp.

{
}

Member Function Documentation

CheckHeader()

bool SCH_ALTIUM_PLUGIN::CheckHeader ( const wxString &  aFileName )

overridevirtual

Return true if the first line in aFileName begins with the expected header.

Parameters

aFileName

is the name of the file to use as input

Reimplemented from SCH_PLUGIN.

Definition at line 118 of file sch_altium_plugin.cpp.

{
    // TODO

    return true;
}

CreateSymbolLib()

void SCH_PLUGIN::CreateSymbolLib ( const wxString &  aLibraryPath, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

Create a new empty symbol library at aLibraryPath.

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 footprints.
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 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 library, or creating it.

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 110 of file sch_plugin.cpp.

{
    // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
    not_implemented( this, __FUNCTION__ );
}

References not_implemented().

DeleteSymbol()

void SCH_PLUGIN::DeleteSymbol ( const wxString &  aLibraryPath, const wxString &  aSymbolName, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

Delete the entire LIB_PART 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_PART associated with it's root LIB_PART 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_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 102 of file sch_plugin.cpp.

{
    // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
    not_implemented( this, __FUNCTION__ );
}

References not_implemented().

Referenced by SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer().

DeleteSymbolLib()

bool SCH_PLUGIN::DeleteSymbolLib ( const wxString &  aLibraryPath, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

Delete an existing symbol library and returns true if successful, 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 symbols.
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 or false if library did not exist.

Exceptions

IO_ERROR

if there is a problem deleting an existing library.

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 117 of file sch_plugin.cpp.

{
    // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
    not_implemented( this, __FUNCTION__ );
    return false;
}

References not_implemented().

EnumerateSymbolLib() [1/2]

void SCH_PLUGIN::EnumerateSymbolLib ( wxArrayString &  aSymbolNameList, const wxString &  aLibraryPath, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

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

Parameters

aSymbolNameList	is an array to populate with the LIB_PART names associated with the library.
aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing one or more LIB_PART 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 in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 67 of file sch_plugin.cpp.

{
    // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
    not_implemented( this, __FUNCTION__ );
}

References not_implemented().

EnumerateSymbolLib() [2/2]

void SCH_PLUGIN::EnumerateSymbolLib ( std::vector< LIB_PART * > &  aSymbolList, const wxString &  aLibraryPath, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

Populate a list of LIB_PART 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_PART pointers associated with the library.
aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing one or more LIB_PART 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 in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 76 of file sch_plugin.cpp.

{
    // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
    not_implemented( this, __FUNCTION__ );
}

References not_implemented().

GetError()

const wxString & SCH_PLUGIN::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_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 177 of file sch_plugin.cpp.

{
    // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
    not_implemented( this, __FUNCTION__ );
    static wxString error;
    return error;
}

References not_implemented().

Referenced by TEST_SCH_SHEET_LIST_FIXTURE::loadSchematic(), and TEST_NETLISTS_FIXTURE::loadSchematic().

GetFileExtension()

const wxString SCH_ALTIUM_PLUGIN::GetFileExtension ( ) const

overridevirtual

Return the file extension for the SCH_PLUGIN.

Implements SCH_PLUGIN.

Definition at line 100 of file sch_altium_plugin.cpp.

{
    return "SchDoc";
}

Referenced by ParseFileName().

getLibFileName()

wxFileName SCH_ALTIUM_PLUGIN::getLibFileName

(

)

Definition at line 150 of file sch_altium_plugin.cpp.

{
    wxFileName fn( m_schematic->Prj().GetProjectPath(), getLibName(), KiCadSymbolLibFileExtension );

    return fn;
}

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

Referenced by Load(), Parse(), and ParsePowerPort().

getLibName()

wxString SCH_ALTIUM_PLUGIN::getLibName

(

)

Definition at line 126 of file sch_altium_plugin.cpp.

{
    if( m_libName.IsEmpty() )
    {
        // Try to come up with a meaningful name
        m_libName = m_schematic->Prj().GetProjectName();

        if( m_libName.IsEmpty() )
        {
            wxFileName fn( m_rootSheet->GetFileName() );
            m_libName = fn.GetName();
        }

        if( m_libName.IsEmpty() )
            m_libName = "noname";

        m_libName += "-altium-import";
        m_libName = LIB_ID::FixIllegalChars( m_libName, true );
    }

    return m_libName;
}

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

Referenced by getLibFileName(), Load(), ParseComponent(), and ParsePowerPort().

GetLibraryFileExtension()

const wxString SCH_ALTIUM_PLUGIN::GetLibraryFileExtension ( ) const

overridevirtual

Return the library file extension for the SCH_PLUGIN object.

Implements SCH_PLUGIN.

Definition at line 106 of file sch_altium_plugin.cpp.

{
    return "SchLib";
}

GetModifyHash()

int SCH_ALTIUM_PLUGIN::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_PLUGIN.

Definition at line 112 of file sch_altium_plugin.cpp.

{
    return 0;
}

GetName()

const wxString SCH_ALTIUM_PLUGIN::GetName ( ) const

overridevirtual

Return a brief hard coded name for this SCH_PLUGIN.

Implements SCH_PLUGIN.

Definition at line 94 of file sch_altium_plugin.cpp.

{
    return "Altium";
}

IsComponentPartVisible()

bool SCH_ALTIUM_PLUGIN::IsComponentPartVisible ( int  aOwnerindex, int  aOwnerpartdisplaymode  ) const

private

Definition at line 485 of file sch_altium_plugin.cpp.

{
    const auto& component = m_altiumComponents.find( aOwnerindex );

    if( component == m_altiumComponents.end() )
        return false;

    return component->second.displaymode == aOwnerpartdisplaymode;
}

References m_altiumComponents.

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

IsSymbolLibWritable()

bool SCH_PLUGIN::IsSymbolLibWritable ( const wxString &  aLibraryPath )

virtualinherited

Return true if the library at aLibraryPath is writable.

(Often system libraries are read only because of where they are installed.)

Parameters

aLibraryPath

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

Exceptions

IO_ERROR

if no library at aLibraryPath exists.

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 125 of file sch_plugin.cpp.

{
    // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
    not_implemented( this, __FUNCTION__ );
    return false;
}

References not_implemented().

Load()

SCH_SHEET * SCH_ALTIUM_PLUGIN::Load ( const wxString &  aFileName, SCHEMATIC *  aSchematic, SCH_SHEET *  aAppendToMe = nullptr, const PROPERTIES *  aProperties = nullptr  )

overridevirtual

Load information from some input file format that this SCH_PLUGIN 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 component 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_PLUGIN.

Definition at line 158 of file sch_altium_plugin.cpp.

{
    wxASSERT( !aFileName || aSchematic != NULL );

    wxFileName fileName( aFileName );
    fileName.SetExt( KiCadSchematicFileExtension );
    m_schematic = aSchematic;

    // Delete on exception, if I own m_rootSheet, according to aAppendToMe
    std::unique_ptr<SCH_SHEET> deleter( aAppendToMe ? nullptr : m_rootSheet );

    if( aAppendToMe )
    {
        wxCHECK_MSG( aSchematic->IsValid(), nullptr, "Can't append to a schematic with no root!" );
        m_rootSheet = &aSchematic->Root();
    }
    else
    {
        m_rootSheet = new SCH_SHEET( aSchematic );
        m_rootSheet->SetFileName( fileName.GetFullPath() );
    }

    if( !m_rootSheet->GetScreen() )
    {
        SCH_SCREEN* screen = new SCH_SCREEN( m_schematic );
        screen->SetFileName( aFileName );
        m_rootSheet->SetScreen( screen );
    }

    SYMBOL_LIB_TABLE* libTable = m_schematic->Prj().SchSymbolLibTable();

    wxCHECK_MSG( libTable, NULL, "Could not load symbol lib table." );

    m_pi.set( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );

    if( !libTable->HasLibrary( getLibName() ) )
    {
        // Create a new empty symbol library.
        m_pi->CreateSymbolLib( getLibFileName().GetFullPath() );
        wxString libTableUri = "${KIPRJMOD}/" + getLibFileName().GetFullName();

        // Add the new library to the project symbol library table.
        libTable->InsertRow( new SYMBOL_LIB_TABLE_ROW( getLibName(), libTableUri,
                                                       wxString( "KiCad" ) ) );

        // Save project symbol library table.
        wxFileName fn( m_schematic->Prj().GetProjectPath(),
                       SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );

        // So output formatter goes out of scope and closes the file before reloading.
        {
            FILE_OUTPUTFORMATTER formatter( fn.GetFullPath() );
            libTable->Format( &formatter, 0 );
        }

        // Reload the symbol library table.
        m_schematic->Prj().SetElem( PROJECT::ELEM_SYMBOL_LIB_TABLE, NULL );
        m_schematic->Prj().SchSymbolLibTable();
    }

    m_currentSheet = m_rootSheet;
    ParseAltiumSch( aFileName );

    m_pi->SaveLibrary( getLibFileName().GetFullPath() );

    SCH_SCREENS allSheets( m_rootSheet );
    allSheets.UpdateSymbolLinks(); // Update all symbol library links for all sheets.

    return m_rootSheet;
}

References PROJECT::ELEM_SYMBOL_LIB_TABLE, SYMBOL_LIB_TABLE::Format(), getLibFileName(), getLibName(), PROJECT::GetProjectPath(), SCH_SHEET::GetScreen(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), LIB_TABLE::HasLibrary(), LIB_TABLE::InsertRow(), SCHEMATIC::IsValid(), KiCadSchematicFileExtension, m_currentSheet, m_pi, m_rootSheet, m_schematic, NULL, ParseAltiumSch(), SCHEMATIC::Prj(), SCHEMATIC::Root(), SCH_PLUGIN::SCH_PLUGIN_RELEASER::set(), PROJECT::SetElem(), SCH_SCREEN::SetFileName(), SCH_SHEET::SetFileName(), SCH_SHEET::SetScreen(), and SCH_SCREENS::UpdateSymbolLinks().

LoadSymbol()

LIB_PART * SCH_PLUGIN::LoadSymbol ( const wxString &  aLibraryPath, const wxString &  aPartName, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

Load a LIB_PART object having aPartName from the aLibraryPath containing a library format that this SCH_PLUGIN 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_PART 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 in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 85 of file sch_plugin.cpp.

{
    // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
    not_implemented( this, __FUNCTION__ );
    return NULL;
}

References not_implemented(), and NULL.

Referenced by SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer().

Parse()

void SCH_ALTIUM_PLUGIN::Parse

(

const CFB::CompoundFileReader &

aReader

)

Definition at line 282 of file sch_altium_plugin.cpp.

{
    const CFB::COMPOUND_FILE_ENTRY* file = FindStream( aReader, "FileHeader" );

    if( file == nullptr )
        THROW_IO_ERROR( "FileHeader not found" );

    ALTIUM_PARSER reader( aReader, file );

    if( reader.GetRemainingBytes() <= 0 )
    {
        THROW_IO_ERROR( "FileHeader does not contain any data" );
    }
    else
    {
        std::map<wxString, wxString> properties = reader.ReadProperties();

        int               recordId = ALTIUM_PARSER::PropertiesReadInt( properties, "RECORD", 0 );
        ALTIUM_SCH_RECORD record   = static_cast<ALTIUM_SCH_RECORD>( recordId );

        if( record != ALTIUM_SCH_RECORD::HEADER )
            THROW_IO_ERROR( "Header expected" );
    }

    // Prepare some local variables
    wxASSERT( m_altiumPortsCurrentSheet.empty() );
    wxASSERT( !m_currentTitleBlock );

    m_currentTitleBlock = std::make_unique<TITLE_BLOCK>();

    // index is required required to resolve OWNERINDEX
    for( int index = 0; reader.GetRemainingBytes() > 0; index++ )
    {
        std::map<wxString, wxString> properties = reader.ReadProperties();

        int               recordId = ALTIUM_PARSER::PropertiesReadInt( properties, "RECORD", 0 );
        ALTIUM_SCH_RECORD record   = static_cast<ALTIUM_SCH_RECORD>( recordId );

        // see: https://github.com/vadmium/python-altium/blob/master/format.md
        switch( record )
        {
        case ALTIUM_SCH_RECORD::HEADER:
            THROW_IO_ERROR( "Header already parsed" );
        case ALTIUM_SCH_RECORD::COMPONENT:
            ParseComponent( index, properties );
            break;
        case ALTIUM_SCH_RECORD::PIN:
            ParsePin( properties );
            break;
        case ALTIUM_SCH_RECORD::IEEE_SYMBOL:
            break;
        case ALTIUM_SCH_RECORD::LABEL:
            ParseLabel( properties );
            break;
        case ALTIUM_SCH_RECORD::BEZIER:
            ParseBezier( properties );
            break;
        case ALTIUM_SCH_RECORD::POLYLINE:
            ParsePolyline( properties );
            break;
        case ALTIUM_SCH_RECORD::POLYGON:
            ParsePolygon( properties );
            break;
        case ALTIUM_SCH_RECORD::ELLIPSE:
            break;
        case ALTIUM_SCH_RECORD::PIECHART:
            break;
        case ALTIUM_SCH_RECORD::ROUND_RECTANGLE:
            ParseRoundRectangle( properties );
            break;
        case ALTIUM_SCH_RECORD::ELLIPTICAL_ARC:
            break;
        case ALTIUM_SCH_RECORD::ARC:
            ParseArc( properties );
            break;
        case ALTIUM_SCH_RECORD::LINE:
            ParseLine( properties );
            break;
        case ALTIUM_SCH_RECORD::RECTANGLE:
            ParseRectangle( properties );
            break;
        case ALTIUM_SCH_RECORD::SHEET_SYMBOL:
            ParseSheetSymbol( index, properties );
            break;
        case ALTIUM_SCH_RECORD::SHEET_ENTRY:
            ParseSheetEntry( properties );
            break;
        case ALTIUM_SCH_RECORD::POWER_PORT:
            ParsePowerPort( properties );
            break;
        case ALTIUM_SCH_RECORD::PORT:
            // Ports are parsed after the sheet was parsed
            // This is required because we need all electrical connection points before placing.
            m_altiumPortsCurrentSheet.emplace_back( properties );
            break;
        case ALTIUM_SCH_RECORD::NO_ERC:
            ParseNoERC( properties );
            break;
        case ALTIUM_SCH_RECORD::NET_LABEL:
            ParseNetLabel( properties );
            break;
        case ALTIUM_SCH_RECORD::BUS:
            ParseBus( properties );
            break;
        case ALTIUM_SCH_RECORD::WIRE:
            ParseWire( properties );
            break;
        case ALTIUM_SCH_RECORD::TEXT_FRAME:
            break;
        case ALTIUM_SCH_RECORD::JUNCTION:
            ParseJunction( properties );
            break;
        case ALTIUM_SCH_RECORD::IMAGE:
            break;
        case ALTIUM_SCH_RECORD::SHEET:
            ParseSheet( properties );
            break;
        case ALTIUM_SCH_RECORD::SHEET_NAME:
            ParseSheetName( properties );
            break;
        case ALTIUM_SCH_RECORD::FILE_NAME:
            ParseFileName( properties );
            break;
        case ALTIUM_SCH_RECORD::DESIGNATOR:
            ParseDesignator( properties );
            break;
        case ALTIUM_SCH_RECORD::BUS_ENTRY:
            ParseBusEntry( properties );
            break;
        case ALTIUM_SCH_RECORD::TEMPLATE:
            break;
        case ALTIUM_SCH_RECORD::PARAMETER:
            ParseParameter( properties );
            break;
        case ALTIUM_SCH_RECORD::WARNING_SIGN:
            break;
        case ALTIUM_SCH_RECORD::IMPLEMENTATION_LIST:
            break;
        case ALTIUM_SCH_RECORD::IMPLEMENTATION:
            break;
        case ALTIUM_SCH_RECORD::RECORD_46:
            break;
        case ALTIUM_SCH_RECORD::RECORD_47:
            break;
        case ALTIUM_SCH_RECORD::RECORD_48:
            break;
        case ALTIUM_SCH_RECORD::RECORD_209:
            break;
        case ALTIUM_SCH_RECORD::RECORD_215:
            break;
        case ALTIUM_SCH_RECORD::RECORD_216:
            break;
        case ALTIUM_SCH_RECORD::RECORD_217:
            break;
        case ALTIUM_SCH_RECORD::RECORD_218:
            break;
        case ALTIUM_SCH_RECORD::RECORD_226:
            break;
        default:
            m_reporter->Report( wxString::Format( _( "Unknown Record id: %d." ), recordId ),
                                RPT_SEVERITY_ERROR );
            break;
        }
    }

    if( reader.HasParsingError() )
        THROW_IO_ERROR( "stream was not parsed correctly!" );

    if( reader.GetRemainingBytes() != 0 )
        THROW_IO_ERROR( "stream is not fully parsed" );

    // assign LIB_PART -> COMPONENT
    for( auto component : m_components )
    {
        auto kpart = m_symbols.find( component.first );

        if( kpart == m_symbols.end() )
            THROW_IO_ERROR( "every component should have a symbol attached" );

        m_pi->SaveSymbol( getLibFileName().GetFullPath(), new LIB_PART( *( kpart->second ) ),
                          m_properties.get() );

        component.second->SetLibSymbol( kpart->second );
    }

    // Handle title blocks
    m_currentSheet->GetScreen()->SetTitleBlock( *m_currentTitleBlock );
    m_currentTitleBlock.reset();

    // Handle Ports
    for( const ASCH_PORT& port : m_altiumPortsCurrentSheet )
        ParsePort( port );

    m_altiumPortsCurrentSheet.clear();

    m_components.clear();
    m_symbols.clear();

    // Otherwise we cannot save the imported sheet?
    m_currentSheet->SetModified();
}

References _, ARC, BEZIER, BUS, BUS_ENTRY, COMPONENT, DESIGNATOR, ELLIPSE, ELLIPTICAL_ARC, FILE_NAME, FindStream(), Format(), getLibFileName(), ALTIUM_PARSER::GetRemainingBytes(), SCH_SHEET::GetScreen(), ALTIUM_PARSER::HasParsingError(), HEADER, IEEE_SYMBOL, IMAGE, IMPLEMENTATION, IMPLEMENTATION_LIST, JUNCTION, LABEL, LINE, m_altiumPortsCurrentSheet, m_components, m_currentSheet, m_currentTitleBlock, m_pi, m_properties, m_reporter, m_symbols, NET_LABEL, NO_ERC, PARAMETER, ParseArc(), ParseBezier(), ParseBus(), ParseBusEntry(), ParseComponent(), ParseDesignator(), ParseFileName(), ParseJunction(), ParseLabel(), ParseLine(), ParseNetLabel(), ParseNoERC(), ParseParameter(), ParsePin(), ParsePolygon(), ParsePolyline(), ParsePort(), ParsePowerPort(), ParseRectangle(), ParseRoundRectangle(), ParseSheet(), ParseSheetEntry(), ParseSheetName(), ParseSheetSymbol(), ParseWire(), PIECHART, PIN, POLYGON, POLYLINE, PORT, POWER_PORT, ALTIUM_PARSER::PropertiesReadInt(), ALTIUM_PARSER::ReadProperties(), RECORD_209, RECORD_215, RECORD_216, RECORD_217, RECORD_218, RECORD_226, RECORD_46, RECORD_47, RECORD_48, RECTANGLE, REPORTER::Report(), ROUND_RECTANGLE, RPT_SEVERITY_ERROR, EDA_ITEM::SetModified(), SCH_SCREEN::SetTitleBlock(), SHEET, SHEET_ENTRY, SHEET_NAME, SHEET_SYMBOL, TEMPLATE, TEXT_FRAME, THROW_IO_ERROR, WARNING_SIGN, and WIRE.

Referenced by ParseAltiumSch().

ParseAltiumSch()

void SCH_ALTIUM_PLUGIN::ParseAltiumSch

(

const wxString &

aFileName

)

Definition at line 240 of file sch_altium_plugin.cpp.

{
    // Open file
    FILE* fp = wxFopen( aFileName, "rb" );

    if( fp == nullptr )
    {
        m_reporter->Report( wxString::Format( _( "Cannot open file '%s'." ), aFileName ),
                            RPT_SEVERITY_ERROR );
        return;
    }

    fseek( fp, 0, SEEK_END );
    long len = ftell( fp );

    if( len < 0 )
    {
        fclose( fp );
        THROW_IO_ERROR( "Reading error, cannot determine length of file" );
    }

    std::unique_ptr<unsigned char[]> buffer( new unsigned char[len] );
    fseek( fp, 0, SEEK_SET );

    size_t bytesRead = fread( buffer.get(), sizeof( unsigned char ), len, fp );
    fclose( fp );

    if( static_cast<size_t>( len ) != bytesRead )
        THROW_IO_ERROR( "Reading error" );

    try
    {
        CFB::CompoundFileReader reader( buffer.get(), bytesRead );
        Parse( reader );
    }
    catch( CFB::CFBException& exception )
    {
        THROW_IO_ERROR( exception.what() );
    }
}

References _, Format(), m_reporter, Parse(), REPORTER::Report(), RPT_SEVERITY_ERROR, and THROW_IO_ERROR.

Referenced by Load().

ParseArc()

void SCH_ALTIUM_PLUGIN::ParseArc ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 1104 of file sch_altium_plugin.cpp.

{
    ASCH_ARC elem( aProperties );

    if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
    {
        m_reporter->Report( _( "Arc drawing is not possible for now on schematic." ),
                            RPT_SEVERITY_ERROR );
    }
    else
    {
        const auto& symbol = m_symbols.find( elem.ownerindex );
        if( symbol == m_symbols.end() )
        {
            // TODO: e.g. can depend on Template (RECORD=39
            m_reporter->Report( wxString::Format( _( "Arc has non-existent ownerindex %d." ),
                                                  elem.ownerindex ),
                                RPT_SEVERITY_WARNING );
            return;
        }

        if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
            return;

        const auto& component = m_components.at( symbol->first );

        if( elem.startAngle == 0 && ( elem.endAngle == 0 || elem.endAngle == 360 ) )
        {
            LIB_CIRCLE* circle = new LIB_CIRCLE( symbol->second );
            symbol->second->AddDrawItem( circle );

            circle->SetUnit( elem.ownerpartid );

            circle->SetPosition( GetRelativePosition( elem.center + m_sheetOffset, component ) );
            circle->SetRadius( elem.radius );
            circle->SetWidth( elem.lineWidth );
        }
        else
        {
            LIB_ARC* arc = new LIB_ARC( symbol->second );
            symbol->second->AddDrawItem( arc );

            arc->SetUnit( elem.ownerpartid );

            // TODO: correct?
            arc->SetPosition( GetRelativePosition( elem.center + m_sheetOffset, component ) );
            arc->SetRadius( elem.radius );
            arc->SetFirstRadiusAngle( elem.startAngle * 10. );
            arc->SetSecondRadiusAngle( elem.endAngle * 10. );
        }
    }
}

References _, ALTIUM_COMPONENT_NONE, ASCH_ARC::center, ASCH_ARC::endAngle, Format(), GetRelativePosition(), IsComponentPartVisible(), ASCH_ARC::lineWidth, m_components, m_reporter, m_sheetOffset, m_symbols, ASCH_ARC::ownerindex, ASCH_ARC::ownerpartdisplaymode, ASCH_ARC::ownerpartid, ASCH_ARC::radius, REPORTER::Report(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, LIB_ARC::SetFirstRadiusAngle(), LIB_ITEM::SetPosition(), LIB_CIRCLE::SetRadius(), LIB_ARC::SetRadius(), LIB_ARC::SetSecondRadiusAngle(), LIB_ITEM::SetUnit(), LIB_CIRCLE::SetWidth(), and ASCH_ARC::startAngle.

Referenced by Parse().

ParseBezier()

void SCH_ALTIUM_PLUGIN::ParseBezier ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 779 of file sch_altium_plugin.cpp.

{
    ASCH_BEZIER elem( aProperties );

    if( elem.points.size() < 2 )
    {
        m_reporter->Report( wxString::Format( _( "Bezier has %d control points. At least 2 are "
                                                 "expected." ),
                                              static_cast<int>( elem.points.size() ) ),
                            RPT_SEVERITY_WARNING );
        return;
    }

    if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
    {
        for( size_t i = 0; i + 1 < elem.points.size(); i += 3 )
        {
            if( i + 2 == elem.points.size() )
            {
                // special case: single line
                SCH_LINE* line = new SCH_LINE( elem.points.at( i ) + m_sheetOffset,
                                               SCH_LAYER_ID::LAYER_NOTES );

                line->SetEndPoint( elem.points.at( i + 1 ) + m_sheetOffset );
                line->SetLineWidth( elem.lineWidth );
                line->SetLineStyle( PLOT_DASH_TYPE::SOLID );

                line->SetFlags( IS_NEW );
                m_currentSheet->GetScreen()->Append( line );
            }
            else
            {
                // simulate bezier using line segments
                std::vector<wxPoint> bezierPoints;
                std::vector<wxPoint> polyPoints;
                for( size_t j = i; j < elem.points.size() && j < i + 4; j++ )
                {
                    bezierPoints.push_back( elem.points.at( j ) + m_sheetOffset );
                }

                BEZIER_POLY converter( bezierPoints );
                converter.GetPoly( polyPoints );

                for( size_t k = 0; k + 1 < polyPoints.size(); k++ )
                {
                    SCH_LINE* line = new SCH_LINE( polyPoints.at( k ) + m_sheetOffset,
                                                   SCH_LAYER_ID::LAYER_NOTES );

                    line->SetEndPoint( polyPoints.at( k + 1 ) + m_sheetOffset );
                    line->SetLineWidth( elem.lineWidth );

                    line->SetFlags( IS_NEW );
                    m_currentSheet->GetScreen()->Append( line );
                }
            }
        }
    }
    else
    {
        const auto& symbol = m_symbols.find( elem.ownerindex );

        if( symbol == m_symbols.end() )
        {
            // TODO: e.g. can depend on Template (RECORD=39
            m_reporter->Report( wxString::Format( _( "Bezier has non-existent ownerindex %d." ),
                                                  elem.ownerindex ),
                                RPT_SEVERITY_WARNING );
            return;
        }

        if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
            return;

        const auto& component = m_components.at( symbol->first );

        for( size_t i = 0; i + 1 < elem.points.size(); i += 3 )
        {
            if( i + 2 == elem.points.size() )
            {
                // special case: single line
                LIB_POLYLINE* line = new LIB_POLYLINE( symbol->second );
                symbol->second->AddDrawItem( line );

                line->SetUnit( elem.ownerpartid );

                for( size_t j = i; j < elem.points.size() && j < i + 2; j++ )
                {
                    line->AddPoint( GetRelativePosition( elem.points.at( j ) + m_sheetOffset,
                                                         component ) );
                }

                line->SetWidth( elem.lineWidth );
            }
            else
            {
                // bezier always has maximum of 4 control points
                LIB_BEZIER* bezier = new LIB_BEZIER( symbol->second );
                symbol->second->AddDrawItem( bezier );

                bezier->SetUnit( elem.ownerpartid );

                for( size_t j = i; j < elem.points.size() && j < i + 4; j++ )
                {
                    bezier->AddPoint( GetRelativePosition( elem.points.at( j ) + m_sheetOffset,
                                      component ) );
                }

                bezier->SetWidth( elem.lineWidth );
            }
        }
    }
}

References _, LIB_POLYLINE::AddPoint(), LIB_BEZIER::AddPoint(), ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), Format(), BEZIER_POLY::GetPoly(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, IsComponentPartVisible(), LAYER_NOTES, ASCH_BEZIER::lineWidth, m_components, m_currentSheet, m_reporter, m_sheetOffset, m_symbols, ASCH_BEZIER::ownerindex, ASCH_BEZIER::ownerpartdisplaymode, ASCH_BEZIER::ownerpartid, ASCH_BEZIER::points, REPORTER::Report(), RPT_SEVERITY_WARNING, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineStyle(), SCH_LINE::SetLineWidth(), LIB_ITEM::SetUnit(), LIB_BEZIER::SetWidth(), LIB_POLYLINE::SetWidth(), and SOLID.

Referenced by Parse().

ParseBus()

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

private

Definition at line 1832 of file sch_altium_plugin.cpp.

{
    ASCH_BUS elem( aProperties );

    for( size_t i = 0; i + 1 < elem.points.size(); i++ )
    {
        SCH_LINE* bus =
                new SCH_LINE( elem.points.at( i ) + m_sheetOffset, SCH_LAYER_ID::LAYER_BUS );
        bus->SetEndPoint( elem.points.at( i + 1 ) + m_sheetOffset );
        bus->SetLineWidth( elem.lineWidth );

        bus->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( bus );
    }
}

References SCH_SCREEN::Append(), SCH_SHEET::GetScreen(), IS_NEW, LAYER_BUS, ASCH_BUS::lineWidth, m_currentSheet, m_sheetOffset, ASCH_BUS::points, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), and SCH_LINE::SetLineWidth().

Referenced by Parse().

ParseBusEntry()

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

private

Definition at line 2062 of file sch_altium_plugin.cpp.

{
    ASCH_BUS_ENTRY elem( aProperties );

    SCH_BUS_WIRE_ENTRY* busWireEntry = new SCH_BUS_WIRE_ENTRY( elem.location + m_sheetOffset );

    wxPoint vector = elem.corner - elem.location;
    busWireEntry->SetSize( { vector.x, vector.y } );

    busWireEntry->SetFlags( IS_NEW );
    m_currentSheet->GetScreen()->Append( busWireEntry );
}

References SCH_SCREEN::Append(), ASCH_BUS_ENTRY::corner, SCH_SHEET::GetScreen(), IS_NEW, ASCH_BUS_ENTRY::location, m_currentSheet, m_sheetOffset, EDA_ITEM::SetFlags(), and SCH_BUS_ENTRY_BASE::SetSize().

Referenced by Parse().

ParseComponent()

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

private

Definition at line 496 of file sch_altium_plugin.cpp.

{
    auto pair = m_altiumComponents.insert( { aIndex, ASCH_COMPONENT( aProperties ) } );
    const ASCH_COMPONENT& elem = pair.first->second;

    // TODO: this is a hack until we correctly apply all transformations to every element
    wxString name = wxString::Format( "%d%s_%s",
                                      elem.orientation,
                                      elem.isMirrored ? "_mirrored" : "",
                                      elem.libreference );
    LIB_ID libId = AltiumToKiCadLibID( getLibName(), name );

    LIB_PART* kpart = new LIB_PART( wxEmptyString );
    kpart->SetName( name );
    kpart->SetDescription( elem.componentdescription );
    kpart->SetLibId( libId );
    m_symbols.insert( { aIndex, kpart } );

    // each component has its own symbol for now
    SCH_COMPONENT* component = new SCH_COMPONENT();

    component->SetPosition( elem.location + m_sheetOffset );
    //component->SetOrientation( elem.orientation ); // TODO: keep it simple for now, and only set position
    component->SetLibId( libId );
    //component->SetLibSymbol( kpart ); // this has to be done after parsing the LIB_PART!

    component->SetUnit( elem.currentpartid );

    m_currentSheet->GetScreen()->Append( component );

    m_components.insert( { aIndex, component } );
}

References AltiumToKiCadLibID(), SCH_SCREEN::Append(), ASCH_COMPONENT::componentdescription, ASCH_COMPONENT::currentpartid, Format(), getLibName(), SCH_SHEET::GetScreen(), ASCH_COMPONENT::isMirrored, ASCH_COMPONENT::libreference, ASCH_COMPONENT::location, m_altiumComponents, m_components, m_currentSheet, m_sheetOffset, m_symbols, name, ASCH_COMPONENT::orientation, LIB_PART::SetDescription(), LIB_PART::SetLibId(), SCH_COMPONENT::SetLibId(), LIB_PART::SetName(), SCH_COMPONENT::SetPosition(), and SCH_COMPONENT::SetUnit().

Referenced by Parse().

ParseDesignator()

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

private

Definition at line 2029 of file sch_altium_plugin.cpp.

{
    ASCH_DESIGNATOR elem( aProperties );

    const auto& symbol = m_symbols.find( elem.ownerindex );
    if( symbol == m_symbols.end() )
    {
        // TODO: e.g. can depend on Template (RECORD=39
        m_reporter->Report( wxString::Format( _( "Designator has non-existent ownerindex %d." ),
                                              elem.ownerindex ),
                            RPT_SEVERITY_WARNING );
        return;
    }

    const auto& component = m_components.at( symbol->first );

    SCH_SHEET_PATH sheetpath;
    m_rootSheet->LocatePathOfScreen( m_currentSheet->GetScreen(), &sheetpath );

    component->SetRef( &sheetpath, elem.text );

    SCH_FIELD* refField = component->GetField( REFERENCE_FIELD );

    refField->SetPosition( elem.location + m_sheetOffset );
    refField->SetVisible( true );

    refField->SetHorizJustify( EDA_TEXT_HJUSTIFY_T::GR_TEXT_HJUSTIFY_LEFT );
    refField->SetVertJustify( EDA_TEXT_VJUSTIFY_T::GR_TEXT_VJUSTIFY_BOTTOM );

    SetFieldOrientation( *refField, elem.orientation );
}

References _, Format(), SCH_SHEET::GetScreen(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_BOTTOM, SCH_SHEET::LocatePathOfScreen(), ASCH_DESIGNATOR::location, m_components, m_currentSheet, m_reporter, m_rootSheet, m_sheetOffset, m_symbols, ASCH_DESIGNATOR::orientation, ASCH_DESIGNATOR::ownerindex, REFERENCE_FIELD, REPORTER::Report(), RPT_SEVERITY_WARNING, SetFieldOrientation(), EDA_TEXT::SetHorizJustify(), SCH_FIELD::SetPosition(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), and ASCH_DESIGNATOR::text.

Referenced by Parse().

ParseFileName()

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

private

Definition at line 1995 of file sch_altium_plugin.cpp.

{
    ASCH_FILE_NAME elem( aProperties );

    const auto& sheet = m_sheets.find( elem.ownerindex );
    if( sheet == m_sheets.end() )
    {
        wxLogError( wxString::Format( "File Name has non-existent ownerindex %d",
                                      elem.ownerindex ) );
        return;
    }

    SCH_FIELD& filenameField = sheet->second->GetFields()[SHEETFILENAME];

    filenameField.SetPosition( elem.location + m_sheetOffset );

    // If last symbols are ".sChDoC", change them to ".kicad_sch"
    if( ( elem.text.Right( GetFileExtension().length() + 1 ).Lower() ) == ( "." + GetFileExtension().Lower() ))
    {
        elem.text.RemoveLast( GetFileExtension().length() );
        elem.text += KiCadSchematicFileExtension;
    }

    filenameField.SetText( elem.text );

    filenameField.SetVisible( !elem.isHidden );

    filenameField.SetHorizJustify( EDA_TEXT_HJUSTIFY_T::GR_TEXT_HJUSTIFY_LEFT );
    filenameField.SetVertJustify( EDA_TEXT_VJUSTIFY_T::GR_TEXT_VJUSTIFY_BOTTOM );

    SetFieldOrientation( filenameField, elem.orientation );
}

References Format(), GetFileExtension(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_BOTTOM, ASCH_FILE_NAME::isHidden, KiCadSchematicFileExtension, ASCH_FILE_NAME::location, m_sheetOffset, m_sheets, ASCH_FILE_NAME::orientation, ASCH_FILE_NAME::ownerindex, SetFieldOrientation(), EDA_TEXT::SetHorizJustify(), SCH_FIELD::SetPosition(), EDA_TEXT::SetText(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), SHEETFILENAME, and ASCH_FILE_NAME::text.

Referenced by Parse().

ParseJunction()

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

private

Definition at line 1866 of file sch_altium_plugin.cpp.

{
    ASCH_JUNCTION elem( aProperties );

    SCH_JUNCTION* junction = new SCH_JUNCTION( elem.location + m_sheetOffset );

    junction->SetFlags( IS_NEW );
    m_currentSheet->GetScreen()->Append( junction );
}

References SCH_SCREEN::Append(), SCH_SHEET::GetScreen(), IS_NEW, ASCH_JUNCTION::location, m_currentSheet, m_sheetOffset, and EDA_ITEM::SetFlags().

Referenced by Parse().

ParseLabel()

void SCH_ALTIUM_PLUGIN::ParseLabel ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 718 of file sch_altium_plugin.cpp.

{
    ASCH_LABEL elem( aProperties );

    // TODO: text variable support
    if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
    {
        SCH_TEXT* text = new SCH_TEXT( elem.location + m_sheetOffset, elem.text );

        SetEdaTextJustification( text, elem.justification );

        size_t fontId = static_cast<int>( elem.fontId );

        if( m_altiumSheet && fontId > 0 && fontId <= m_altiumSheet->fonts.size() )
        {
            const ASCH_SHEET_FONT& font = m_altiumSheet->fonts.at( fontId - 1 );
            text->SetItalic( font.italic );
            text->SetBold( font.bold );
            text->SetTextSize( { font.size / 2, font.size / 2 } );
        }

        text->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( text );
    }
    else
    {
        const auto& symbol = m_symbols.find( elem.ownerindex );

        if( symbol == m_symbols.end() )
        {
            // TODO: e.g. can depend on Template (RECORD=39
            m_reporter->Report( wxString::Format( _( "Label has non-existent ownerindex %d." ),
                                                  elem.ownerindex ),
                                RPT_SEVERITY_WARNING );
            return;
        }

        const auto& component = m_components.at( symbol->first );

        LIB_TEXT* text = new LIB_TEXT( symbol->second );
        symbol->second->AddDrawItem( text );

        text->SetUnit( elem.ownerpartid );

        text->SetPosition( GetRelativePosition( elem.location + m_sheetOffset, component ) );
        text->SetText( elem.text );
        SetEdaTextJustification( text, elem.justification );

        size_t fontId = static_cast<int>( elem.fontId );

        if( m_altiumSheet && fontId > 0 && fontId <= m_altiumSheet->fonts.size() )
        {
            const ASCH_SHEET_FONT& font = m_altiumSheet->fonts.at( fontId - 1 );
            text->SetItalic( font.italic );
            text->SetBold( font.bold );
            text->SetTextSize( { font.size / 2, font.size / 2 } );
        }
    }
}

References _, ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ASCH_SHEET_FONT::bold, ASCH_LABEL::fontId, fonts, Format(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, ASCH_SHEET_FONT::italic, ASCH_LABEL::justification, ASCH_LABEL::location, m_altiumSheet, m_components, m_currentSheet, m_reporter, m_sheetOffset, m_symbols, ASCH_LABEL::ownerindex, ASCH_LABEL::ownerpartid, REPORTER::Report(), RPT_SEVERITY_WARNING, SetEdaTextJustification(), ASCH_SHEET_FONT::size, ASCH_LABEL::text, and text.

Referenced by Parse().

ParseLine()

void SCH_ALTIUM_PLUGIN::ParseLine ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 1158 of file sch_altium_plugin.cpp.

{
    ASCH_LINE elem( aProperties );

    if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
    {
        // close polygon
        SCH_LINE* line = new SCH_LINE( elem.point1 + m_sheetOffset, SCH_LAYER_ID::LAYER_NOTES );
        line->SetEndPoint( elem.point2 + m_sheetOffset );
        line->SetLineWidth( elem.lineWidth );
        line->SetLineStyle( PLOT_DASH_TYPE::SOLID ); // TODO?

        line->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( line );
    }
    else
    {
        const auto& symbol = m_symbols.find( elem.ownerindex );

        if( symbol == m_symbols.end() )
        {
            // TODO: e.g. can depend on Template (RECORD=39
            m_reporter->Report( wxString::Format( _( "Line has non-existent ownerindex %d." ),
                                                  elem.ownerindex ),
                                RPT_SEVERITY_WARNING );
            return;
        }

        if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
            return;

        const auto& component = m_components.at( symbol->first );

        LIB_POLYLINE* line = new LIB_POLYLINE( symbol->second );
        symbol->second->AddDrawItem( line );

        line->SetUnit( elem.ownerpartid );

        line->AddPoint( GetRelativePosition( elem.point1 + m_sheetOffset, component ) );
        line->AddPoint( GetRelativePosition( elem.point2 + m_sheetOffset, component ) );

        line->SetWidth( elem.lineWidth );
    }
}

References _, LIB_POLYLINE::AddPoint(), ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), Format(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, IsComponentPartVisible(), LAYER_NOTES, ASCH_LINE::lineWidth, m_components, m_currentSheet, m_reporter, m_sheetOffset, m_symbols, ASCH_LINE::ownerindex, ASCH_LINE::ownerpartdisplaymode, ASCH_LINE::ownerpartid, ASCH_LINE::point1, ASCH_LINE::point2, REPORTER::Report(), RPT_SEVERITY_WARNING, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineStyle(), SCH_LINE::SetLineWidth(), LIB_ITEM::SetUnit(), LIB_POLYLINE::SetWidth(), and SOLID.

Referenced by Parse().

ParseNetLabel()

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

private

Definition at line 1803 of file sch_altium_plugin.cpp.

{
    ASCH_NET_LABEL elem( aProperties );

    SCH_LABEL* label = new SCH_LABEL( elem.location + m_sheetOffset, elem.text );

    switch( elem.orientation )
    {
    case ASCH_RECORD_ORIENTATION::RIGHTWARDS:
        label->SetLabelSpinStyle( LABEL_SPIN_STYLE::RIGHT );
        break;
    case ASCH_RECORD_ORIENTATION::UPWARDS:
        label->SetLabelSpinStyle( LABEL_SPIN_STYLE::UP );
        break;
    case ASCH_RECORD_ORIENTATION::LEFTWARDS:
        label->SetLabelSpinStyle( LABEL_SPIN_STYLE::LEFT );
        break;
    case ASCH_RECORD_ORIENTATION::DOWNWARDS:
        label->SetLabelSpinStyle( LABEL_SPIN_STYLE::BOTTOM );
        break;
    default:
        break;
    }

    label->SetFlags( IS_NEW );
    m_currentSheet->GetScreen()->Append( label );
}

References SCH_SCREEN::Append(), LABEL_SPIN_STYLE::BOTTOM, DOWNWARDS, SCH_SHEET::GetScreen(), IS_NEW, LABEL_SPIN_STYLE::LEFT, LEFTWARDS, ASCH_NET_LABEL::location, m_currentSheet, m_sheetOffset, ASCH_NET_LABEL::orientation, LABEL_SPIN_STYLE::RIGHT, RIGHTWARDS, EDA_ITEM::SetFlags(), SCH_TEXT::SetLabelSpinStyle(), ASCH_NET_LABEL::text, LABEL_SPIN_STYLE::UP, and UPWARDS.

Referenced by Parse().

ParseNoERC()

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

private

Definition at line 1789 of file sch_altium_plugin.cpp.

{
    ASCH_NO_ERC elem( aProperties );

    if( elem.isActive )
    {
        SCH_NO_CONNECT* noConnect = new SCH_NO_CONNECT( elem.location + m_sheetOffset );

        noConnect->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( noConnect );
    }
}

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

Referenced by Parse().

ParseParameter()

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

private

Definition at line 2076 of file sch_altium_plugin.cpp.

{
    ASCH_PARAMETER elem( aProperties );

    // TODO: fill in replacements from variant, sheet and project
    altium_override_map_t stringReplacement = {
        { "Comment", "${VALUE}" },
        { "Value", "${Altium_Value}" },
    };

    if( elem.ownerindex <= 0 && elem.ownerpartid == ALTIUM_COMPONENT_NONE )
    {
        // This is some sheet parameter
        if( elem.text == "*" )
            return; // indicates parameter not set?

        SCH_SHEET_PATH sheetpath;
        m_rootSheet->LocatePathOfScreen( m_currentSheet->GetScreen(), &sheetpath );

        if( elem.name == "SheetNumber" )
            m_rootSheet->SetPageNumber( sheetpath, elem.text );
        else if( elem.name == "Title" )
            m_currentTitleBlock->SetTitle( elem.text );
        else if( elem.name == "Revision" )
            m_currentTitleBlock->SetRevision( elem.text );
        else if( elem.name == "Date" )
            m_currentTitleBlock->SetDate( elem.text );
        else if( elem.name == "CompanyName" )
            m_currentTitleBlock->SetCompany( elem.text );
        // TODO: parse other parameters
        // TODO: handle parameters in labels
    }
    else
    {
        const auto& symbol = m_symbols.find( elem.ownerindex );
        if( symbol == m_symbols.end() )
        {
            // TODO: e.g. can depend on Template (RECORD=39
            return;
        }

        const auto& component = m_components.at( symbol->first );

        // TODO: location not correct?
        const wxPoint position = elem.location + m_sheetOffset;

        SCH_FIELD* field = nullptr;
        if( elem.name == "Comment" )
        {
            field = component->GetField( VALUE_FIELD );
            field->SetPosition( position );
        }
        else
        {
            int fieldIdx = component->GetFieldCount();
            wxString fieldName = elem.name.IsSameAs( "Value", false ) ? "Altium_Value" : elem.name;
            field = component->AddField( { position, fieldIdx, component, fieldName } );
        }

        wxString kicadText = AltiumSpecialStringsToKiCadVariables( elem.text, stringReplacement );
        field->SetText( kicadText );

        field->SetVisible( !elem.isHidden );
        field->SetHorizJustify( EDA_TEXT_HJUSTIFY_T::GR_TEXT_HJUSTIFY_LEFT );

        switch( elem.orientation )
        {
        case ASCH_RECORD_ORIENTATION::RIGHTWARDS: field->SetTextAngle( 0 ); break;
        case ASCH_RECORD_ORIENTATION::UPWARDS: field->SetTextAngle( 90 ); break;
        case ASCH_RECORD_ORIENTATION::LEFTWARDS: field->SetTextAngle( 180 ); break;
        case ASCH_RECORD_ORIENTATION::DOWNWARDS: field->SetTextAngle( 270 ); break;
        default:
            break;
        }
    }
}

References ALTIUM_COMPONENT_NONE, AltiumSpecialStringsToKiCadVariables(), DOWNWARDS, SCH_SHEET::GetScreen(), GR_TEXT_HJUSTIFY_LEFT, ASCH_PARAMETER::isHidden, LEFTWARDS, SCH_SHEET::LocatePathOfScreen(), ASCH_PARAMETER::location, m_components, m_currentSheet, m_currentTitleBlock, m_rootSheet, m_sheetOffset, m_symbols, ASCH_PARAMETER::name, ASCH_PARAMETER::orientation, ASCH_PARAMETER::ownerindex, ASCH_PARAMETER::ownerpartid, RIGHTWARDS, EDA_TEXT::SetHorizJustify(), SCH_SHEET::SetPageNumber(), SCH_FIELD::SetPosition(), EDA_TEXT::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetVisible(), ASCH_PARAMETER::text, UPWARDS, and VALUE_FIELD.

Referenced by Parse().

ParsePin()

void SCH_ALTIUM_PLUGIN::ParsePin ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 531 of file sch_altium_plugin.cpp.

{
    ASCH_PIN elem( aProperties );

    const auto& symbol = m_symbols.find( elem.ownerindex );

    if( symbol == m_symbols.end() )
    {
        // TODO: e.g. can depend on Template (RECORD=39
        m_reporter->Report( wxString::Format( _( "Pin has non-existent ownerindex %d." ),
                                              elem.ownerindex ),
                            RPT_SEVERITY_WARNING );
        return;
    }

    if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
        return;

    const auto& component = m_components.at( symbol->first );

    LIB_PIN* pin = new LIB_PIN( symbol->second );
    symbol->second->AddDrawItem( pin );

    pin->SetUnit( elem.ownerpartid );

    pin->SetName( elem.name );
    pin->SetNumber( elem.designator );
    pin->SetLength( elem.pinlength );

    wxPoint pinLocation = elem.location; // the location given is not the connection point!

    switch( elem.orientation )
    {
    case ASCH_RECORD_ORIENTATION::RIGHTWARDS:
        pin->SetOrientation( DrawPinOrient::PIN_LEFT );
        pinLocation.x += elem.pinlength;
        break;
    case ASCH_RECORD_ORIENTATION::UPWARDS:
        pin->SetOrientation( DrawPinOrient::PIN_DOWN );
        pinLocation.y -= elem.pinlength;
        break;
    case ASCH_RECORD_ORIENTATION::LEFTWARDS:
        pin->SetOrientation( DrawPinOrient::PIN_RIGHT );
        pinLocation.x -= elem.pinlength;
        break;
    case ASCH_RECORD_ORIENTATION::DOWNWARDS:
        pin->SetOrientation( DrawPinOrient::PIN_UP );
        pinLocation.y += elem.pinlength;
        break;
    default:
        m_reporter->Report( _( "Pin has unexpected orientation." ), RPT_SEVERITY_WARNING );
        break;
    }

    // TODO: position can be sometimes off a little bit!
    pin->SetPosition( GetRelativePosition( pinLocation + m_sheetOffset, component ) );
    // TODO: the following fix is even worse for now?
    // pin->SetPosition( GetRelativePosition( elem.kicadLocation, component ) );

    switch( elem.electrical )
    {
    case ASCH_PIN_ELECTRICAL::INPUT:
        pin->SetType( ELECTRICAL_PINTYPE::PT_INPUT );
        break;
    case ASCH_PIN_ELECTRICAL::BIDI:
        pin->SetType( ELECTRICAL_PINTYPE::PT_BIDI );
        break;
    case ASCH_PIN_ELECTRICAL::OUTPUT:
        pin->SetType( ELECTRICAL_PINTYPE::PT_OUTPUT );
        break;
    case ASCH_PIN_ELECTRICAL::OPEN_COLLECTOR:
        pin->SetType( ELECTRICAL_PINTYPE::PT_OPENCOLLECTOR );
        break;
    case ASCH_PIN_ELECTRICAL::PASSIVE:
        pin->SetType( ELECTRICAL_PINTYPE::PT_PASSIVE );
        break;
    case ASCH_PIN_ELECTRICAL::TRISTATE:
        pin->SetType( ELECTRICAL_PINTYPE::PT_TRISTATE );
        break;
    case ASCH_PIN_ELECTRICAL::OPEN_EMITTER:
        pin->SetType( ELECTRICAL_PINTYPE::PT_OPENEMITTER );
        break;
    case ASCH_PIN_ELECTRICAL::POWER:
        pin->SetType( ELECTRICAL_PINTYPE::PT_POWER_IN );
        break;
    case ASCH_PIN_ELECTRICAL::UNKNOWN:
    default:
        pin->SetType( ELECTRICAL_PINTYPE::PT_UNSPECIFIED );
        m_reporter->Report( _( "Pin has unexpected electrical type." ), RPT_SEVERITY_WARNING );
        break;
    }

    if( elem.symbolOuterEdge == ASCH_PIN_SYMBOL_OUTEREDGE::UNKNOWN )
        m_reporter->Report( _( "Pin has unexpected outer edge type." ), RPT_SEVERITY_WARNING );

    if( elem.symbolInnerEdge == ASCH_PIN_SYMBOL_INNEREDGE::UNKNOWN )
        m_reporter->Report( _( "Pin has unexpected inner edge type." ), RPT_SEVERITY_WARNING );

    if( elem.symbolOuterEdge == ASCH_PIN_SYMBOL_OUTEREDGE::NEGATED )
    {
        switch( elem.symbolInnerEdge )
        {
        case ASCH_PIN_SYMBOL_INNEREDGE::CLOCK:
            pin->SetShape( GRAPHIC_PINSHAPE::INVERTED_CLOCK );
            break;
        default:
            pin->SetShape( GRAPHIC_PINSHAPE::INVERTED );
            break;
        }
    }
    else if( elem.symbolOuterEdge == ASCH_PIN_SYMBOL_OUTEREDGE::LOW_INPUT )
    {
        switch( elem.symbolInnerEdge )
        {
        case ASCH_PIN_SYMBOL_INNEREDGE::CLOCK:
            pin->SetShape( GRAPHIC_PINSHAPE::CLOCK_LOW );
            break;
        default:
            pin->SetShape( GRAPHIC_PINSHAPE::INPUT_LOW );
            break;
        }
    }
    else if( elem.symbolOuterEdge == ASCH_PIN_SYMBOL_OUTEREDGE::LOW_OUTPUT )
    {
        pin->SetShape( GRAPHIC_PINSHAPE::OUTPUT_LOW );
    }
    else
    {
        switch( elem.symbolInnerEdge )
        {
        case ASCH_PIN_SYMBOL_INNEREDGE::CLOCK:
            pin->SetShape( GRAPHIC_PINSHAPE::CLOCK );
            break;
        default:
            pin->SetShape( GRAPHIC_PINSHAPE::LINE ); // nothing to do
            break;
        }
    }
}

References _, BIDI, CLOCK, CLOCK_LOW, ASCH_PIN::designator, DOWNWARDS, ASCH_PIN::electrical, Format(), GetRelativePosition(), INPUT, INPUT_LOW, INVERTED, INVERTED_CLOCK, IsComponentPartVisible(), LEFTWARDS, LINE, ASCH_PIN::location, LOW_INPUT, LOW_OUTPUT, m_components, m_reporter, m_sheetOffset, m_symbols, ASCH_PIN::name, NEGATED, OPEN_COLLECTOR, OPEN_EMITTER, ASCH_PIN::orientation, OUTPUT, OUTPUT_LOW, ASCH_PIN::ownerindex, ASCH_PIN::ownerpartdisplaymode, ASCH_PIN::ownerpartid, PASSIVE, pin, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, ASCH_PIN::pinlength, POWER, PT_BIDI, PT_INPUT, PT_OPENCOLLECTOR, PT_OPENEMITTER, PT_OUTPUT, PT_PASSIVE, PT_POWER_IN, PT_TRISTATE, PT_UNSPECIFIED, REPORTER::Report(), RIGHTWARDS, RPT_SEVERITY_WARNING, ASCH_PIN::symbolInnerEdge, ASCH_PIN::symbolOuterEdge, TRISTATE, UNKNOWN, and UPWARDS.

Referenced by Parse().

ParsePolygon()

void SCH_ALTIUM_PLUGIN::ParsePolygon ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 954 of file sch_altium_plugin.cpp.

{
    ASCH_POLYGON elem( aProperties );

    if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
    {
        // TODO: we cannot fill this polygon, only draw it for now
        for( size_t i = 0; i + 1 < elem.points.size(); i++ )
        {
            SCH_LINE* line =
                    new SCH_LINE( elem.points.at( i ) + m_sheetOffset, SCH_LAYER_ID::LAYER_NOTES );
            line->SetEndPoint( elem.points.at( i + 1 ) + m_sheetOffset );
            line->SetLineWidth( elem.lineWidth );
            line->SetLineStyle( PLOT_DASH_TYPE::SOLID );

            line->SetFlags( IS_NEW );
            m_currentSheet->GetScreen()->Append( line );
        }

        // close polygon
        SCH_LINE* line =
                new SCH_LINE( elem.points.front() + m_sheetOffset, SCH_LAYER_ID::LAYER_NOTES );
        line->SetEndPoint( elem.points.back() + m_sheetOffset );
        line->SetLineWidth( elem.lineWidth );
        line->SetLineStyle( PLOT_DASH_TYPE::SOLID );

        line->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( line );
    }
    else
    {
        const auto& symbol = m_symbols.find( elem.ownerindex );

        if( symbol == m_symbols.end() )
        {
            // TODO: e.g. can depend on Template (RECORD=39
            m_reporter->Report( wxString::Format( _( "Polygon has non-existent ownerindex %d." ),
                                                  elem.ownerindex ),
                                RPT_SEVERITY_WARNING );
            return;
        }

        if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
            return;

        const auto& component = m_components.at( symbol->first );

        LIB_POLYLINE* line = new LIB_POLYLINE( symbol->second );
        symbol->second->AddDrawItem( line );

        line->SetUnit( elem.ownerpartid );

        for( wxPoint& point : elem.points )
            line->AddPoint( GetRelativePosition( point + m_sheetOffset, component ) );

        line->AddPoint( GetRelativePosition( elem.points.front() + m_sheetOffset, component ) );

        line->SetWidth( elem.lineWidth );

        if( !elem.isSolid )
            line->SetFillMode( FILL_TYPE::NO_FILL );
        else if( elem.color == elem.areacolor )
            line->SetFillMode( FILL_TYPE::FILLED_SHAPE );
        else
            line->SetFillMode( FILL_TYPE::FILLED_WITH_BG_BODYCOLOR );
    }
}

References _, LIB_POLYLINE::AddPoint(), ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ASCH_POLYGON::areacolor, ASCH_POLYGON::color, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, Format(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, IsComponentPartVisible(), ASCH_POLYGON::isSolid, LAYER_NOTES, ASCH_POLYGON::lineWidth, m_components, m_currentSheet, m_reporter, m_sheetOffset, m_symbols, NO_FILL, ASCH_POLYGON::ownerindex, ASCH_POLYGON::ownerpartdisplaymode, ASCH_POLYGON::ownerpartid, ASCH_POLYGON::points, REPORTER::Report(), RPT_SEVERITY_WARNING, SCH_LINE::SetEndPoint(), LIB_ITEM::SetFillMode(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineStyle(), SCH_LINE::SetLineWidth(), LIB_ITEM::SetUnit(), LIB_POLYLINE::SetWidth(), and SOLID.

Referenced by Parse().

ParsePolyline()

void SCH_ALTIUM_PLUGIN::ParsePolyline ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 893 of file sch_altium_plugin.cpp.

{
    ASCH_POLYLINE elem( aProperties );

    if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
    {
        PLOT_DASH_TYPE dashType = PLOT_DASH_TYPE::DEFAULT;
        switch( elem.linestyle )
        {
        default:
        case ASCH_POLYLINE_LINESTYLE::SOLID:       dashType = PLOT_DASH_TYPE::SOLID;   break;
        case ASCH_POLYLINE_LINESTYLE::DASHED:      dashType = PLOT_DASH_TYPE::DASH;    break;
        case ASCH_POLYLINE_LINESTYLE::DOTTED:      dashType = PLOT_DASH_TYPE::DOT;     break;
        case ASCH_POLYLINE_LINESTYLE::DASH_DOTTED: dashType = PLOT_DASH_TYPE::DASHDOT; break;
        }

        for( size_t i = 0; i + 1 < elem.points.size(); i++ )
        {
            SCH_LINE* line = new SCH_LINE( elem.points.at( i ) + m_sheetOffset,
                                           SCH_LAYER_ID::LAYER_NOTES );

            line->SetEndPoint( elem.points.at( i + 1 ) + m_sheetOffset );
            line->SetLineWidth( elem.lineWidth );
            line->SetLineStyle( dashType );

            line->SetFlags( IS_NEW );
            m_currentSheet->GetScreen()->Append( line );
        }
    }
    else
    {
        const auto& symbol = m_symbols.find( elem.ownerindex );
        if( symbol == m_symbols.end() )
        {
            // TODO: e.g. can depend on Template (RECORD=39
            m_reporter->Report( wxString::Format( _( "Polyline has non-existent ownerindex %d." ),
                                                  elem.ownerindex ),
                                RPT_SEVERITY_WARNING );
            return;
        }

        if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
            return;

        const auto& component = m_components.at( symbol->first );

        LIB_POLYLINE* line = new LIB_POLYLINE( symbol->second );
        symbol->second->AddDrawItem( line );

        line->SetUnit( elem.ownerpartid );

        for( wxPoint& point : elem.points )
        {
            line->AddPoint( GetRelativePosition( point + m_sheetOffset, component ) );
        }

        line->SetWidth( elem.lineWidth );
    }
}

References _, LIB_POLYLINE::AddPoint(), ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), DASH, DASH_DOTTED, DASHDOT, DASHED, DEFAULT, DOT, DOTTED, Format(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, IsComponentPartVisible(), LAYER_NOTES, ASCH_POLYLINE::linestyle, ASCH_POLYLINE::lineWidth, m_components, m_currentSheet, m_reporter, m_sheetOffset, m_symbols, ASCH_POLYLINE::ownerindex, ASCH_POLYLINE::ownerpartdisplaymode, ASCH_POLYLINE::ownerpartid, ASCH_POLYLINE::points, REPORTER::Report(), RPT_SEVERITY_WARNING, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineStyle(), SCH_LINE::SetLineWidth(), LIB_ITEM::SetUnit(), LIB_POLYLINE::SetWidth(), and SOLID.

Referenced by Parse().

ParsePort()

void SCH_ALTIUM_PLUGIN::ParsePort ( const ASCH_PORT &  aElem )

private

Definition at line 1674 of file sch_altium_plugin.cpp.

{
    // Get both connection points where we could connect to
    wxPoint start = aElem.location + m_sheetOffset;
    wxPoint end   = start;

    switch( aElem.style )
    {
    default:
    case ASCH_PORT_STYLE::NONE_HORIZONTAL:
    case ASCH_PORT_STYLE::LEFT:
    case ASCH_PORT_STYLE::RIGHT:
    case ASCH_PORT_STYLE::LEFT_RIGHT:
        end.x += aElem.width;
        break;
    case ASCH_PORT_STYLE::NONE_VERTICAL:
    case ASCH_PORT_STYLE::TOP:
    case ASCH_PORT_STYLE::BOTTOM:
    case ASCH_PORT_STYLE::TOP_BOTTOM:
        end.y -= aElem.width;
        break;
    }

    // Check which connection points exists in the schematic
    SCH_SCREEN* screen = m_currentSheet->GetScreen();

    bool startIsWireTerminal = screen->IsTerminalPoint( start, LAYER_WIRE );
    bool startIsBusTerminal  = screen->IsTerminalPoint( start, LAYER_BUS );

    bool endIsWireTerminal = screen->IsTerminalPoint( end, LAYER_WIRE );
    bool endIsBusTerminal  = screen->IsTerminalPoint( end, LAYER_BUS );

    // check if any of the points is a terminal point
    // TODO: there seems a problem to detect approximated connections towards component pins?
    bool connectionFound = startIsWireTerminal
                            || startIsBusTerminal
                            || endIsWireTerminal
                            || endIsBusTerminal;

    if( !connectionFound )
    {
        wxLogError( wxString::Format( "There is a Port for \"%s\", but no connections towards it?",
                                      aElem.name ) );
    }

    // Select label position. In case both match, we will add a line later.
    wxPoint position = ( startIsWireTerminal || startIsBusTerminal ) ? start : end;

    SCH_TEXT* const label = new SCH_GLOBALLABEL( position, aElem.name );
    // TODO: detect correct label type depending on sheet settings, etc.
    // label = new SCH_HIERLABEL( elem.location + m_sheetOffset, elem.name );

    switch( aElem.iotype )
    {
    default:
    case ASCH_PORT_IOTYPE::UNSPECIFIED:
        label->SetShape( PINSHEETLABEL_SHAPE::PS_UNSPECIFIED );
        break;
    case ASCH_PORT_IOTYPE::OUTPUT:
        label->SetShape( PINSHEETLABEL_SHAPE::PS_OUTPUT );
        break;
    case ASCH_PORT_IOTYPE::INPUT:
        label->SetShape( PINSHEETLABEL_SHAPE::PS_INPUT );
        break;
    case ASCH_PORT_IOTYPE::BIDI:
        label->SetShape( PINSHEETLABEL_SHAPE::PS_BIDI );
        break;
    }

    switch( aElem.style )
    {
    default:
    case ASCH_PORT_STYLE::NONE_HORIZONTAL:
    case ASCH_PORT_STYLE::LEFT:
    case ASCH_PORT_STYLE::RIGHT:
    case ASCH_PORT_STYLE::LEFT_RIGHT:
        if( ( startIsWireTerminal || startIsBusTerminal ) )
            label->SetLabelSpinStyle( LABEL_SPIN_STYLE::RIGHT );
        else
            label->SetLabelSpinStyle( LABEL_SPIN_STYLE::LEFT );
        break;
    case ASCH_PORT_STYLE::NONE_VERTICAL:
    case ASCH_PORT_STYLE::TOP:
    case ASCH_PORT_STYLE::BOTTOM:
    case ASCH_PORT_STYLE::TOP_BOTTOM:
        if( ( startIsWireTerminal || startIsBusTerminal ) )
            label->SetLabelSpinStyle( LABEL_SPIN_STYLE::UP );
        else
            label->SetLabelSpinStyle( LABEL_SPIN_STYLE::BOTTOM );
        break;
    }

    label->SetFlags( IS_NEW );
    m_currentSheet->GetScreen()->Append( label );

    // This is a hack, for the case both connection points are valid: add a small wire
    if( ( startIsWireTerminal && endIsWireTerminal ) || !connectionFound )
    {
        SCH_LINE* wire = new SCH_LINE( start, SCH_LAYER_ID::LAYER_WIRE );
        wire->SetEndPoint( end );
        wire->SetLineWidth( Mils2iu( 2 ) );
        wire->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( wire );
    }
    else if( startIsBusTerminal && endIsBusTerminal )
    {
        SCH_LINE* wire = new SCH_LINE( start, SCH_LAYER_ID::LAYER_BUS );
        wire->SetEndPoint( end );
        wire->SetLineWidth( Mils2iu( 2 ) );
        wire->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( wire );
    }
}

References SCH_SCREEN::Append(), BIDI, LABEL_SPIN_STYLE::BOTTOM, BOTTOM, Format(), SCH_SHEET::GetScreen(), INPUT, ASCH_PORT::iotype, IS_NEW, SCH_SCREEN::IsTerminalPoint(), LAYER_BUS, LAYER_WIRE, LABEL_SPIN_STYLE::LEFT, LEFT, LEFT_RIGHT, ASCH_PORT::location, m_currentSheet, m_sheetOffset, ASCH_PORT::name, NONE_HORIZONTAL, NONE_VERTICAL, OUTPUT, PS_BIDI, PS_INPUT, PS_OUTPUT, PS_UNSPECIFIED, LABEL_SPIN_STYLE::RIGHT, RIGHT, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), SCH_TEXT::SetLabelSpinStyle(), SCH_LINE::SetLineWidth(), SCH_TEXT::SetShape(), ASCH_PORT::style, TOP, TOP_BOTTOM, UNSPECIFIED, LABEL_SPIN_STYLE::UP, and ASCH_PORT::width.

Referenced by Parse().

ParsePowerPort()

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

private

Definition at line 1578 of file sch_altium_plugin.cpp.

{
    ASCH_POWER_PORT elem( aProperties );

    LIB_ID libId = AltiumToKiCadLibID( getLibName(), elem.text );

    LIB_PART* kpart = nullptr;

    const auto& symbol = m_powerSymbols.find( elem.text );
    if( symbol != m_powerSymbols.end() )
    {
        kpart = symbol->second; // cache hit
    }
    else
    {
        kpart = new LIB_PART( wxEmptyString );
        kpart->SetPower();
        kpart->SetName( elem.text );
        kpart->GetReferenceField().SetText( "#PWR" );
        kpart->GetValueField().SetText( elem.text );
        kpart->GetValueField().SetVisible( true ); // TODO: why does this not work?
        kpart->SetDescription( wxString::Format( _( "Power symbol creates a global label with name '%s'" ),
                                                 elem.text ) );
        kpart->SetKeyWords( "power-flag" );
        kpart->SetLibId( libId );

        // generate graphic
        LIB_PIN* pin = new LIB_PIN( kpart );
        kpart->AddDrawItem( pin );

        pin->SetName( elem.text );
        pin->SetPosition( { 0, 0 } );
        pin->SetLength( 0 );

        // marks the pin as a global label
        pin->SetType( ELECTRICAL_PINTYPE::PT_POWER_IN );
        pin->SetVisible( false );

        wxPoint valueFieldPos = HelperGeneratePowerPortGraphics( kpart, elem.style, m_reporter );

        kpart->GetValueField().SetPosition( valueFieldPos );

        // this has to be done after parsing the LIB_PART!
        m_pi->SaveSymbol( getLibFileName().GetFullPath(), kpart, m_properties.get() );
        m_powerSymbols.insert( { elem.text, kpart } );
    }

    SCH_SHEET_PATH sheetpath;
    m_rootSheet->LocatePathOfScreen( m_currentSheet->GetScreen(), &sheetpath );

    // each component has its own symbol for now
    SCH_COMPONENT* component = new SCH_COMPONENT();
    component->SetRef( &sheetpath, "#PWR?" );
    component->SetValue( elem.text );
    component->SetLibId( libId );
    component->SetLibSymbol( new LIB_PART( *kpart ) );

    SCH_FIELD* valueField = component->GetField( VALUE_FIELD );

    // TODO: Why do I need to set those a second time?
    valueField->SetVisible( true );
    valueField->SetPosition( kpart->GetValueField().GetPosition() );

    component->SetPosition( elem.location + m_sheetOffset );

    switch( elem.orientation )
    {
    case ASCH_RECORD_ORIENTATION::RIGHTWARDS:
        component->SetOrientation( COMPONENT_ORIENTATION_T::CMP_ORIENT_90 );
        valueField->SetTextAngle( -900. );
        valueField->SetHorizJustify( EDA_TEXT_HJUSTIFY_T::GR_TEXT_HJUSTIFY_LEFT );
        break;
    case ASCH_RECORD_ORIENTATION::UPWARDS:
        component->SetOrientation( COMPONENT_ORIENTATION_T::CMP_ORIENT_180 );
        valueField->SetTextAngle( -1800. );
        valueField->SetHorizJustify( EDA_TEXT_HJUSTIFY_T::GR_TEXT_HJUSTIFY_CENTER );
        break;
    case ASCH_RECORD_ORIENTATION::LEFTWARDS:
        component->SetOrientation( COMPONENT_ORIENTATION_T::CMP_ORIENT_270 );
        valueField->SetTextAngle( -2700. );
        valueField->SetHorizJustify( EDA_TEXT_HJUSTIFY_T::GR_TEXT_HJUSTIFY_RIGHT );
        break;
    case ASCH_RECORD_ORIENTATION::DOWNWARDS:
        component->SetOrientation( COMPONENT_ORIENTATION_T::CMP_ORIENT_0 );
        valueField->SetTextAngle( 0. );
        valueField->SetHorizJustify( EDA_TEXT_HJUSTIFY_T::GR_TEXT_HJUSTIFY_CENTER );
        break;
    default:
        m_reporter->Report( _( "Pin has unexpected orientation." ), RPT_SEVERITY_WARNING );
        break;
    }

    m_currentSheet->GetScreen()->Append( component );
}

References _, LIB_PART::AddDrawItem(), AltiumToKiCadLibID(), SCH_SCREEN::Append(), CMP_ORIENT_0, CMP_ORIENT_180, CMP_ORIENT_270, CMP_ORIENT_90, DOWNWARDS, Format(), SCH_COMPONENT::GetField(), getLibFileName(), getLibName(), LIB_FIELD::GetPosition(), LIB_PART::GetReferenceField(), SCH_SHEET::GetScreen(), LIB_PART::GetValueField(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, HelperGeneratePowerPortGraphics(), LEFTWARDS, SCH_SHEET::LocatePathOfScreen(), ASCH_POWER_PORT::location, m_currentSheet, m_pi, m_powerSymbols, m_properties, m_reporter, m_rootSheet, m_sheetOffset, ASCH_POWER_PORT::orientation, pin, PT_POWER_IN, REPORTER::Report(), RIGHTWARDS, RPT_SEVERITY_WARNING, LIB_PART::SetDescription(), EDA_TEXT::SetHorizJustify(), LIB_PART::SetKeyWords(), LIB_PART::SetLibId(), SCH_COMPONENT::SetLibId(), SCH_COMPONENT::SetLibSymbol(), LIB_PART::SetName(), SCH_COMPONENT::SetOrientation(), SCH_FIELD::SetPosition(), LIB_ITEM::SetPosition(), SCH_COMPONENT::SetPosition(), LIB_PART::SetPower(), SCH_COMPONENT::SetRef(), EDA_TEXT::SetText(), EDA_TEXT::SetTextAngle(), SCH_COMPONENT::SetValue(), EDA_TEXT::SetVisible(), ASCH_POWER_PORT::style, ASCH_POWER_PORT::text, UPWARDS, and VALUE_FIELD.

Referenced by Parse().

ParseRectangle()

void SCH_ALTIUM_PLUGIN::ParseRectangle ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 1204 of file sch_altium_plugin.cpp.

{
    ASCH_RECTANGLE elem( aProperties );

    wxPoint sheetTopRight   = elem.topRight + m_sheetOffset;
    wxPoint sheetBottomLeft = elem.bottomLeft + m_sheetOffset;

    if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
    {
        const wxPoint topLeft     = { sheetBottomLeft.x, sheetTopRight.y };
        const wxPoint bottomRight = { sheetTopRight.x, sheetBottomLeft.y };

        // TODO: we cannot fill this rectangle, only draw it for now
        SCH_LINE* lineTop = new SCH_LINE( sheetTopRight, SCH_LAYER_ID::LAYER_NOTES );
        lineTop->SetEndPoint( topLeft );
        lineTop->SetLineWidth( elem.lineWidth );
        lineTop->SetLineStyle( PLOT_DASH_TYPE::SOLID );
        lineTop->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( lineTop );

        SCH_LINE* lineBottom = new SCH_LINE( sheetBottomLeft, SCH_LAYER_ID::LAYER_NOTES );
        lineBottom->SetEndPoint( bottomRight );
        lineBottom->SetLineWidth( elem.lineWidth );
        lineBottom->SetLineStyle( PLOT_DASH_TYPE::SOLID );
        lineBottom->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( lineBottom );

        SCH_LINE* lineRight = new SCH_LINE( sheetTopRight, SCH_LAYER_ID::LAYER_NOTES );
        lineRight->SetEndPoint( bottomRight );
        lineRight->SetLineWidth( elem.lineWidth );
        lineRight->SetLineStyle( PLOT_DASH_TYPE::SOLID );
        lineRight->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( lineRight );

        SCH_LINE* lineLeft = new SCH_LINE( sheetBottomLeft, SCH_LAYER_ID::LAYER_NOTES );
        lineLeft->SetEndPoint( topLeft );
        lineLeft->SetLineWidth( elem.lineWidth );
        lineLeft->SetLineStyle( PLOT_DASH_TYPE::SOLID );
        lineLeft->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( lineLeft );
    }
    else
    {
        const auto& symbol = m_symbols.find( elem.ownerindex );

        if( symbol == m_symbols.end() )
        {
            // TODO: e.g. can depend on Template (RECORD=39
            m_reporter->Report( wxString::Format( _( "Rectangle has non-existent ownerindex %d." ),
                                                  elem.ownerindex ),
                                RPT_SEVERITY_WARNING );
            return;
        }

        if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
            return;

        const auto& component = m_components.at( symbol->first );

        LIB_RECTANGLE* rect = new LIB_RECTANGLE( symbol->second );
        symbol->second->AddDrawItem( rect );

        rect->SetUnit( elem.ownerpartid );

        rect->SetPosition( GetRelativePosition( sheetTopRight, component ) );
        rect->SetEnd( GetRelativePosition( sheetBottomLeft, component ) );
        rect->SetWidth( elem.lineWidth );

        if( !elem.isSolid )
            rect->SetFillMode( FILL_TYPE::NO_FILL );
        else if( elem.color == elem.areacolor )
            rect->SetFillMode( FILL_TYPE::FILLED_SHAPE );
        else
            rect->SetFillMode( FILL_TYPE::FILLED_WITH_BG_BODYCOLOR );
    }
}

References _, ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ASCH_RECTANGLE::areacolor, ASCH_RECTANGLE::bottomLeft, ASCH_RECTANGLE::color, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, Format(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, IsComponentPartVisible(), ASCH_RECTANGLE::isSolid, LAYER_NOTES, ASCH_RECTANGLE::lineWidth, m_components, m_currentSheet, m_reporter, m_sheetOffset, m_symbols, NO_FILL, ASCH_RECTANGLE::ownerindex, ASCH_RECTANGLE::ownerpartdisplaymode, ASCH_RECTANGLE::ownerpartid, REPORTER::Report(), RPT_SEVERITY_WARNING, LIB_RECTANGLE::SetEnd(), SCH_LINE::SetEndPoint(), LIB_ITEM::SetFillMode(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineStyle(), SCH_LINE::SetLineWidth(), LIB_ITEM::SetPosition(), LIB_ITEM::SetUnit(), LIB_RECTANGLE::SetWidth(), SOLID, and ASCH_RECTANGLE::topRight.

Referenced by Parse().

ParseRoundRectangle()

void SCH_ALTIUM_PLUGIN::ParseRoundRectangle ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 1023 of file sch_altium_plugin.cpp.

{
    ASCH_ROUND_RECTANGLE elem( aProperties );

    wxPoint sheetTopRight   = elem.topRight + m_sheetOffset;
    wxPoint sheetBottomLeft = elem.bottomLeft + m_sheetOffset;

    if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
    {
        const wxPoint topLeft     = { sheetBottomLeft.x, sheetTopRight.y };
        const wxPoint bottomRight = { sheetTopRight.x, sheetBottomLeft.y };

        // TODO: we cannot fill this rectangle, only draw it for now
        // TODO: misses rounded edges
        SCH_LINE* lineTop = new SCH_LINE( sheetTopRight, SCH_LAYER_ID::LAYER_NOTES );
        lineTop->SetEndPoint( topLeft );
        lineTop->SetLineWidth( elem.lineWidth );
        lineTop->SetLineStyle( PLOT_DASH_TYPE::SOLID );
        lineTop->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( lineTop );

        SCH_LINE* lineBottom = new SCH_LINE( sheetBottomLeft, SCH_LAYER_ID::LAYER_NOTES );
        lineBottom->SetEndPoint( bottomRight );
        lineBottom->SetLineWidth( elem.lineWidth );
        lineBottom->SetLineStyle( PLOT_DASH_TYPE::SOLID );
        lineBottom->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( lineBottom );

        SCH_LINE* lineRight = new SCH_LINE( sheetTopRight, SCH_LAYER_ID::LAYER_NOTES );
        lineRight->SetEndPoint( bottomRight );
        lineRight->SetLineWidth( elem.lineWidth );
        lineRight->SetLineStyle( PLOT_DASH_TYPE::SOLID );
        lineRight->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( lineRight );

        SCH_LINE* lineLeft = new SCH_LINE( sheetBottomLeft, SCH_LAYER_ID::LAYER_NOTES );
        lineLeft->SetEndPoint( topLeft );
        lineLeft->SetLineWidth( elem.lineWidth );
        lineLeft->SetLineStyle( PLOT_DASH_TYPE::SOLID );
        lineLeft->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( lineLeft );
    }
    else
    {
        const auto& symbol = m_symbols.find( elem.ownerindex );

        if( symbol == m_symbols.end() )
        {
            // TODO: e.g. can depend on Template (RECORD=39
            m_reporter->Report( wxString::Format( _( "Rounded rectangle has non-existent "
                                                     "ownerindex %d." ),
                                                  elem.ownerindex ),
                                RPT_SEVERITY_WARNING );
            return;
        }

        if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
            return;

        const auto& component = m_components.at( symbol->first );

        // TODO: misses rounded edges
        LIB_RECTANGLE* rect = new LIB_RECTANGLE( symbol->second );
        symbol->second->AddDrawItem( rect );

        rect->SetUnit( elem.ownerpartid );

        rect->SetPosition( GetRelativePosition( elem.topRight + m_sheetOffset, component ) );
        rect->SetEnd( GetRelativePosition( elem.bottomLeft + m_sheetOffset, component ) );
        rect->SetWidth( elem.lineWidth );

        if( !elem.isSolid )
            rect->SetFillMode( FILL_TYPE::NO_FILL );
        else if( elem.color == elem.areacolor )
            rect->SetFillMode( FILL_TYPE::FILLED_SHAPE );
        else
            rect->SetFillMode( FILL_TYPE::FILLED_WITH_BG_BODYCOLOR );
    }
}

References _, ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ASCH_ROUND_RECTANGLE::areacolor, ASCH_ROUND_RECTANGLE::bottomLeft, ASCH_ROUND_RECTANGLE::color, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, Format(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, IsComponentPartVisible(), ASCH_ROUND_RECTANGLE::isSolid, LAYER_NOTES, ASCH_ROUND_RECTANGLE::lineWidth, m_components, m_currentSheet, m_reporter, m_sheetOffset, m_symbols, NO_FILL, ASCH_ROUND_RECTANGLE::ownerindex, ASCH_ROUND_RECTANGLE::ownerpartdisplaymode, ASCH_ROUND_RECTANGLE::ownerpartid, REPORTER::Report(), RPT_SEVERITY_WARNING, LIB_RECTANGLE::SetEnd(), SCH_LINE::SetEndPoint(), LIB_ITEM::SetFillMode(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineStyle(), SCH_LINE::SetLineWidth(), LIB_ITEM::SetPosition(), LIB_ITEM::SetUnit(), LIB_RECTANGLE::SetWidth(), SOLID, and ASCH_ROUND_RECTANGLE::topRight.

Referenced by Parse().

ParseSheet()

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

private

Definition at line 1877 of file sch_altium_plugin.cpp.

{
    m_altiumSheet = std::make_unique<ASCH_SHEET>( aProperties );

    PAGE_INFO pageInfo;

    bool isPortrait = m_altiumSheet->sheetOrientation == ASCH_SHEET_WORKSPACEORIENTATION::PORTRAIT;
    switch( m_altiumSheet->sheetSize )
    {
    default:
    case ASCH_SHEET_SIZE::A4:
        pageInfo.SetType( "A4", isPortrait );
        break;
    case ASCH_SHEET_SIZE::A3:
        pageInfo.SetType( "A3", isPortrait );
        break;
    case ASCH_SHEET_SIZE::A2:
        pageInfo.SetType( "A2", isPortrait );
        break;
    case ASCH_SHEET_SIZE::A1:
        pageInfo.SetType( "A1", isPortrait );
        break;
    case ASCH_SHEET_SIZE::A0:
        pageInfo.SetType( "A0", isPortrait );
        break;
    case ASCH_SHEET_SIZE::A:
        pageInfo.SetType( "A", isPortrait );
        break;
    case ASCH_SHEET_SIZE::B:
        pageInfo.SetType( "B", isPortrait );
        break;
    case ASCH_SHEET_SIZE::C:
        pageInfo.SetType( "C", isPortrait );
        break;
    case ASCH_SHEET_SIZE::D:
        pageInfo.SetType( "D", isPortrait );
        break;
    case ASCH_SHEET_SIZE::E:
        pageInfo.SetType( "E", isPortrait );
        break;
    case ASCH_SHEET_SIZE::LETTER:
        pageInfo.SetType( "USLetter", isPortrait );
        break;
    case ASCH_SHEET_SIZE::LEGAL:
        pageInfo.SetType( "USLegal", isPortrait );
        break;
    case ASCH_SHEET_SIZE::TABLOID:
        pageInfo.SetType( "A3", isPortrait ); // TODO: use User
        break;
    case ASCH_SHEET_SIZE::ORCAD_A:
        pageInfo.SetType( "A", isPortrait );
        break;
    case ASCH_SHEET_SIZE::ORCAD_B:
        pageInfo.SetType( "B", isPortrait );
        break;
    case ASCH_SHEET_SIZE::ORCAD_C:
        pageInfo.SetType( "C", isPortrait );
        break;
    case ASCH_SHEET_SIZE::ORCAD_D:
        pageInfo.SetType( "D", isPortrait );
        break;
    case ASCH_SHEET_SIZE::ORCAD_E:
        pageInfo.SetType( "E", isPortrait );
        break;
    }

    m_currentSheet->GetScreen()->SetPageSettings( pageInfo );

    m_sheetOffset = { 0, pageInfo.GetHeightIU() };
}

References A, A0, A1, A2, A3, A4, B, C, D, E, SCH_SHEET::GetScreen(), LEGAL, LETTER, m_altiumSheet, m_currentSheet, m_sheetOffset, ORCAD_A, ORCAD_B, ORCAD_C, ORCAD_D, ORCAD_E, PORTRAIT, SCH_SCREEN::SetPageSettings(), PAGE_INFO::SetType(), and TABLOID.

Referenced by Parse().

ParseSheetEntry()

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

private

Definition at line 1305 of file sch_altium_plugin.cpp.

{
    ASCH_SHEET_ENTRY elem( aProperties );

    const auto& sheet = m_sheets.find( elem.ownerindex );
    if( sheet == m_sheets.end() )
    {
        wxLogError( wxString::Format( "Sheet Entry has non-existent ownerindex %d",
                                      elem.ownerindex ) );
        return;
    }

    SCH_SHEET_PIN* sheetPin = new SCH_SHEET_PIN( sheet->second );
    sheet->second->AddPin( sheetPin );

    sheetPin->SetText( elem.name );
    sheetPin->SetShape( PINSHEETLABEL_SHAPE::PS_UNSPECIFIED );
    //sheetPin->SetLabelSpinStyle( getSpinStyle( term.OrientAngle, false ) );
    //sheetPin->SetPosition( getKiCadPoint( term.Position ) );

    wxPoint pos  = sheet->second->GetPosition();
    wxSize  size = sheet->second->GetSize();

    switch( elem.side )
    {
    default:
    case ASCH_SHEET_ENTRY_SIDE::LEFT:
        sheetPin->SetPosition( { pos.x, pos.y + elem.distanceFromTop } );
        sheetPin->SetLabelSpinStyle( LABEL_SPIN_STYLE::LEFT );
        sheetPin->SetEdge( SHEET_SIDE::SHEET_LEFT_SIDE );
        break;
    case ASCH_SHEET_ENTRY_SIDE::RIGHT:
        sheetPin->SetPosition( { pos.x + size.x, pos.y + elem.distanceFromTop } );
        sheetPin->SetLabelSpinStyle( LABEL_SPIN_STYLE::RIGHT );
        sheetPin->SetEdge( SHEET_SIDE::SHEET_RIGHT_SIDE );
        break;
    case ASCH_SHEET_ENTRY_SIDE::TOP:
        sheetPin->SetPosition( { pos.x + elem.distanceFromTop, pos.y } );
        sheetPin->SetLabelSpinStyle( LABEL_SPIN_STYLE::UP );
        sheetPin->SetEdge( SHEET_SIDE::SHEET_TOP_SIDE );
        break;
    case ASCH_SHEET_ENTRY_SIDE::BOTTOM:
        sheetPin->SetPosition( { pos.x + elem.distanceFromTop, pos.y + size.y } );
        sheetPin->SetLabelSpinStyle( LABEL_SPIN_STYLE::BOTTOM );
        sheetPin->SetEdge( SHEET_SIDE::SHEET_BOTTOM_SIDE );
        break;
    }

    switch( elem.iotype )
    {
    default:
    case ASCH_PORT_IOTYPE::UNSPECIFIED:
        sheetPin->SetShape( PINSHEETLABEL_SHAPE::PS_UNSPECIFIED );
        break;
    case ASCH_PORT_IOTYPE::OUTPUT:
        sheetPin->SetShape( PINSHEETLABEL_SHAPE::PS_OUTPUT );
        break;
    case ASCH_PORT_IOTYPE::INPUT:
        sheetPin->SetShape( PINSHEETLABEL_SHAPE::PS_INPUT );
        break;
    case ASCH_PORT_IOTYPE::BIDI:
        sheetPin->SetShape( PINSHEETLABEL_SHAPE::PS_BIDI );
        break;
    }
}

References BIDI, LABEL_SPIN_STYLE::BOTTOM, BOTTOM, ASCH_SHEET_ENTRY::distanceFromTop, Format(), INPUT, ASCH_SHEET_ENTRY::iotype, LABEL_SPIN_STYLE::LEFT, LEFT, m_sheets, ASCH_SHEET_ENTRY::name, OUTPUT, ASCH_SHEET_ENTRY::ownerindex, PS_BIDI, PS_INPUT, PS_OUTPUT, PS_UNSPECIFIED, LABEL_SPIN_STYLE::RIGHT, RIGHT, SCH_SHEET_PIN::SetEdge(), SCH_HIERLABEL::SetLabelSpinStyle(), SCH_SHEET_PIN::SetPosition(), SCH_TEXT::SetShape(), EDA_TEXT::SetText(), SHEET_BOTTOM_SIDE, SHEET_LEFT_SIDE, SHEET_RIGHT_SIDE, SHEET_TOP_SIDE, ASCH_SHEET_ENTRY::side, TOP, UNSPECIFIED, and LABEL_SPIN_STYLE::UP.

Referenced by Parse().

ParseSheetName()

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

private

Definition at line 1970 of file sch_altium_plugin.cpp.

{
    ASCH_SHEET_NAME elem( aProperties );

    const auto& sheet = m_sheets.find( elem.ownerindex );
    if( sheet == m_sheets.end() )
    {
        wxLogError( wxString::Format( "Sheet Name has non-existent ownerindex %d",
                                      elem.ownerindex ) );
        return;
    }

    SCH_FIELD& sheetNameField = sheet->second->GetFields()[SHEETNAME];

    sheetNameField.SetPosition( elem.location + m_sheetOffset );
    sheetNameField.SetText( elem.text );
    sheetNameField.SetVisible( !elem.isHidden );

    sheetNameField.SetHorizJustify( EDA_TEXT_HJUSTIFY_T::GR_TEXT_HJUSTIFY_LEFT );
    sheetNameField.SetVertJustify( EDA_TEXT_VJUSTIFY_T::GR_TEXT_VJUSTIFY_BOTTOM );

    SetFieldOrientation( sheetNameField, elem.orientation );
}

References Format(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_BOTTOM, ASCH_SHEET_NAME::isHidden, ASCH_SHEET_NAME::location, m_sheetOffset, m_sheets, ASCH_SHEET_NAME::orientation, ASCH_SHEET_NAME::ownerindex, SetFieldOrientation(), EDA_TEXT::SetHorizJustify(), SCH_FIELD::SetPosition(), EDA_TEXT::SetText(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), SHEETNAME, and ASCH_SHEET_NAME::text.

Referenced by Parse().

ParseSheetSymbol()

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

private

Definition at line 1282 of file sch_altium_plugin.cpp.

{
    ASCH_SHEET_SYMBOL elem( aProperties );

    SCH_SHEET*  sheet  = new SCH_SHEET( m_currentSheet, elem.location + m_sheetOffset );
    SCH_SCREEN* screen = new SCH_SCREEN( m_schematic );

    sheet->SetSize( elem.size );

    sheet->SetBorderColor( GetColorFromInt( elem.color ) );
    if( elem.isSolid )
        sheet->SetBackgroundColor( GetColorFromInt( elem.areacolor ) );

    sheet->SetScreen( screen );

    sheet->SetFlags( IS_NEW );
    m_currentSheet->GetScreen()->Append( sheet );

    m_sheets.insert( { aIndex, sheet } );
}

References SCH_SCREEN::Append(), ASCH_SHEET_SYMBOL::areacolor, ASCH_SHEET_SYMBOL::color, GetColorFromInt(), SCH_SHEET::GetScreen(), IS_NEW, ASCH_SHEET_SYMBOL::isSolid, ASCH_SHEET_SYMBOL::location, m_currentSheet, m_schematic, m_sheetOffset, m_sheets, SCH_SHEET::SetBackgroundColor(), SCH_SHEET::SetBorderColor(), EDA_ITEM::SetFlags(), SCH_SHEET::SetScreen(), SCH_SHEET::SetSize(), and ASCH_SHEET_SYMBOL::size.

Referenced by Parse().

ParseWire()

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

private

Definition at line 1849 of file sch_altium_plugin.cpp.

{
    ASCH_WIRE elem( aProperties );

    for( size_t i = 0; i + 1 < elem.points.size(); i++ )
    {
        SCH_LINE* wire =
                new SCH_LINE( elem.points.at( i ) + m_sheetOffset, SCH_LAYER_ID::LAYER_WIRE );
        wire->SetEndPoint( elem.points.at( i + 1 ) + m_sheetOffset );
        wire->SetLineWidth( elem.lineWidth );

        wire->SetFlags( IS_NEW );
        m_currentSheet->GetScreen()->Append( wire );
    }
}

References SCH_SCREEN::Append(), SCH_SHEET::GetScreen(), IS_NEW, LAYER_WIRE, ASCH_WIRE::lineWidth, m_currentSheet, m_sheetOffset, ASCH_WIRE::points, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), and SCH_LINE::SetLineWidth().

Referenced by Parse().

Save()

void SCH_PLUGIN::Save ( const wxString &  aFileName, SCH_SHEET *  aSheet, SCHEMATIC *  aSchematic, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

Write aSchematic to a storage file in a format that this SCH_PLUGIN 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_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 59 of file sch_plugin.cpp.

{
    // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
    not_implemented( this, __FUNCTION__ );
}

References not_implemented().

SaveLibrary()

void SCH_PLUGIN::SaveLibrary ( const wxString &  aFileName, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 45 of file sch_plugin.cpp.

{
    not_implemented( this, __FUNCTION__ );
}

References not_implemented().

SaveSymbol()

void SCH_PLUGIN::SaveSymbol ( const wxString &  aLibraryPath, const LIB_PART *  aSymbol, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

Write aSymbol to an existing library located at aLibraryPath.

If a LIB_PART by the same name already exists or there are any conflicting alias names, the new LIB_PART 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_PART 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_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 94 of file sch_plugin.cpp.

{
    // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
    not_implemented( this, __FUNCTION__ );
}

References not_implemented().

Referenced by SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer().

SetReporter()

void SCH_ALTIUM_PLUGIN::SetReporter ( REPORTER *  aReporter )

inlineoverridevirtual

Set an optional reporter for warnings/errors.

Reimplemented from SCH_PLUGIN.

Definition at line 58 of file sch_altium_plugin.h.

{ m_reporter = aReporter; }

References m_reporter.

SymbolLibOptions()

void SCH_PLUGIN::SymbolLibOptions ( PROPERTIES *  aListToAppendTo ) const

virtualinherited

Append supported SCH_PLUGIN options to aListToAppenTo along with internationalized descriptions.

Options are typically appended so that a derived SCH_PLUGIN 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_PLUGINs.) 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_FP_SCH_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_PLUGIN, which has been avoided to date.

Definition at line 133 of file sch_plugin.cpp.

{
    // disable all these in another couple of months, after everyone has seen them:
#if 1
    (*aListToAppendTo)["debug_level"] = UTF8( _(
        "Enable <b>debug</b> logging for Symbol*() functions in this SCH_PLUGIN."
        ) );

    (*aListToAppendTo)["read_filter_regex"] = UTF8( _(
        "Regular expression <b>symbol name</b> filter."
        ) );

    (*aListToAppendTo)["enable_transaction_logging"] = UTF8( _(
        "Enable transaction logging. The mere presence of this option turns on the "
        "logging, no need to set a Value."
        ) );

    (*aListToAppendTo)["username"] = UTF8( _(
        "User name for <b>login</b> to some special library server."
        ) );

    (*aListToAppendTo)["password"] = UTF8( _(
        "Password for <b>login</b> to some special library server."
        ) );
#endif

#if 1
    // Suitable for a C++ to python SCH_PLUGIN::Footprint*() adapter, move it to the adapter
    // if and when implemented.
    (*aListToAppendTo)["python_symbol_plugin"] = UTF8( _(
        "Enter the python symbol which implements the SCH_PLUGIN::Symbol*() functions."
        ) );
#endif
}

References _.

Member Data Documentation

m_altiumComponents

std::map<int, ASCH_COMPONENT> SCH_ALTIUM_PLUGIN::m_altiumComponents

private

Definition at line 160 of file sch_altium_plugin.h.

Referenced by IsComponentPartVisible(), and ParseComponent().

m_altiumPortsCurrentSheet

std::vector<ASCH_PORT> SCH_ALTIUM_PLUGIN::m_altiumPortsCurrentSheet

private

Definition at line 161 of file sch_altium_plugin.h.

Referenced by Parse().

m_altiumSheet

std::unique_ptr<ASCH_SHEET> SCH_ALTIUM_PLUGIN::m_altiumSheet

private

Definition at line 153 of file sch_altium_plugin.h.

Referenced by ParseLabel(), and ParseSheet().

m_components

std::map<int, SCH_COMPONENT*> SCH_ALTIUM_PLUGIN::m_components

private

Definition at line 154 of file sch_altium_plugin.h.

Referenced by Parse(), ParseArc(), ParseBezier(), ParseComponent(), ParseDesignator(), ParseLabel(), ParseLine(), ParseParameter(), ParsePin(), ParsePolygon(), ParsePolyline(), ParseRectangle(), and ParseRoundRectangle().

m_currentSheet

SCH_SHEET* SCH_ALTIUM_PLUGIN::m_currentSheet

private

Definition at line 142 of file sch_altium_plugin.h.

Referenced by Load(), Parse(), ParseBezier(), ParseBus(), ParseBusEntry(), ParseComponent(), ParseDesignator(), ParseJunction(), ParseLabel(), ParseLine(), ParseNetLabel(), ParseNoERC(), ParseParameter(), ParsePolygon(), ParsePolyline(), ParsePort(), ParsePowerPort(), ParseRectangle(), ParseRoundRectangle(), ParseSheet(), ParseSheetSymbol(), ParseWire(), and SCH_ALTIUM_PLUGIN().

m_currentTitleBlock

std::unique_ptr<TITLE_BLOCK> SCH_ALTIUM_PLUGIN::m_currentTitleBlock

private

Definition at line 149 of file sch_altium_plugin.h.

Referenced by Parse(), and ParseParameter().

m_libName

wxString SCH_ALTIUM_PLUGIN::m_libName

private

Definition at line 144 of file sch_altium_plugin.h.

Referenced by getLibName().

m_pi

SCH_PLUGIN::SCH_PLUGIN_RELEASER SCH_ALTIUM_PLUGIN::m_pi

private

Definition at line 146 of file sch_altium_plugin.h.

Referenced by Load(), Parse(), and ParsePowerPort().

m_powerSymbols

std::map<wxString, LIB_PART*> SCH_ALTIUM_PLUGIN::m_powerSymbols

private

Definition at line 158 of file sch_altium_plugin.h.

Referenced by ParsePowerPort().

m_properties

std::unique_ptr<PROPERTIES> SCH_ALTIUM_PLUGIN::m_properties

private

Definition at line 147 of file sch_altium_plugin.h.

Referenced by Parse(), and ParsePowerPort().

m_reporter

REPORTER* SCH_ALTIUM_PLUGIN::m_reporter

private

Definition at line 139 of file sch_altium_plugin.h.

Referenced by Parse(), ParseAltiumSch(), ParseArc(), ParseBezier(), ParseDesignator(), ParseLabel(), ParseLine(), ParsePin(), ParsePolygon(), ParsePolyline(), ParsePowerPort(), ParseRectangle(), ParseRoundRectangle(), SCH_ALTIUM_PLUGIN(), and SetReporter().

m_rootSheet

SCH_SHEET* SCH_ALTIUM_PLUGIN::m_rootSheet

private

Definition at line 141 of file sch_altium_plugin.h.

Referenced by getLibName(), Load(), ParseDesignator(), ParseParameter(), ParsePowerPort(), and SCH_ALTIUM_PLUGIN().

m_schematic

SCHEMATIC* SCH_ALTIUM_PLUGIN::m_schematic

private

Definition at line 143 of file sch_altium_plugin.h.

Referenced by getLibFileName(), getLibName(), Load(), ParseSheetSymbol(), and SCH_ALTIUM_PLUGIN().

m_sheetOffset

wxPoint SCH_ALTIUM_PLUGIN::m_sheetOffset

private

Definition at line 152 of file sch_altium_plugin.h.

Referenced by ParseArc(), ParseBezier(), ParseBus(), ParseBusEntry(), ParseComponent(), ParseDesignator(), ParseFileName(), ParseJunction(), ParseLabel(), ParseLine(), ParseNetLabel(), ParseNoERC(), ParseParameter(), ParsePin(), ParsePolygon(), ParsePolyline(), ParsePort(), ParsePowerPort(), ParseRectangle(), ParseRoundRectangle(), ParseSheet(), ParseSheetName(), ParseSheetSymbol(), and ParseWire().

m_sheets

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

private

Definition at line 155 of file sch_altium_plugin.h.

Referenced by ParseFileName(), ParseSheetEntry(), ParseSheetName(), and ParseSheetSymbol().

m_symbols

std::map<int, LIB_PART*> SCH_ALTIUM_PLUGIN::m_symbols

private

Definition at line 156 of file sch_altium_plugin.h.

Referenced by Parse(), ParseArc(), ParseBezier(), ParseComponent(), ParseDesignator(), ParseLabel(), ParseLine(), ParseParameter(), ParsePin(), ParsePolygon(), ParsePolyline(), ParseRectangle(), and ParseRoundRectangle().

---

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

• sch_altium_plugin.h
• sch_altium_plugin.cpp