#include <ltspice_schematic.h>

Classes
struct	ARC
	The ARC is represented inside a rectangle whose opposite site are given. More...

struct	BUSTAP

struct	CIRCLE
	The CIRCLE is represented in Ltpsice inside a rectangle whose two opposite points and line style are given. More...

struct	DATAFLAG

struct	FLAG

struct	IOPIN
	IOPIN is special contact on symbol used for IO operations. More...

struct	LINE

struct	LT_ASC
	A struct to hold .asc file definition. More...

struct	LT_PIN

struct	LT_SYMBOL
	A struct to hold SYMBOL definition. More...

struct	LT_WINDOW

struct	RECTANGLE
	A 4-sided polygon with opposite equal sides, used in representing shapes. More...

struct	TEXT

struct	WIRE
	A metallic connection, used for transfer, between two points or pin. More...

Public Types
enum class	LINESTYLE { SOLID = 0 , DASH = 1 , DOT = 2 , DASHDOT = 3 , DASHDOTDOT = 4 }

enum class	LINEWIDTH { Normal = 5 , Wide = 10 }

enum class	POLARITY { INPUT , OUTPUT , BIDIR }
	Polarity enum represents polarity of pin. More...

enum class	SYMBOLTYPE { CELL , BLOCK }
	Type of Symbol loaded from asc and asy file. More...

enum class	JUSTIFICATION { NONE , BOTTOM , LEFT , RIGHT , CENTER , TOP , VBOTTOM , VLEFT , VRIGHT , VCENTER , VTOP }
	Defines in what ways the PIN or TEXT can be justified. More...

enum class	ORIENTATION { R0 , R90 , R180 , R270 , M0 , M90 , M180 , M270 }
	Defines different types or rotation and mirror operation can be applied to a LT_SYMBOL. More...

Public Member Functions
	LTSPICE_SCHEMATIC (const wxString &aFilename, const wxFileName &aLTspiceDataDir, REPORTER aReporter, PROGRESS_REPORTER aProgressReporter)

	~LTSPICE_SCHEMATIC ()

void	Load (SCHEMATIC aSchematic, SCH_SHEET aRootSheet, const wxFileName &aLibraryFileName, REPORTER *aReporter)
	The main function responsible for loading the .asc and .asy files.

void	GetAscAndAsyFilePaths (const wxDir &aDir, bool aRecursive, std::map< wxString, wxString > &aMapOfAscFiles, std::map< wxString, wxString > &aMapOfAsyFiles, const wxString &aBase=wxEmptyString)
	Used to get file path for Asc and Asy files.

std::vector< LTSPICE_FILE >	GetSchematicElements (const wxString &aAscFile)
	Used to get symbols list present in asc file.

bool	IsAsySubsheet (const wxString &aAsyFile)
	Check if the asy file content indicates that we need to load subsheet.

std::map< wxString, wxString >	ReadAsyFiles (const std::vector< LTSPICE_FILE > &aSourceFiles, const std::map< wxString, wxString > &aAsyFileMap)
	The function returns a map.

std::map< wxString, wxString >	ReadAsyFile (const LTSPICE_FILE &aSourceFile, const std::map< wxString, wxString > &aAsyFileMap)

std::vector< LT_ASC >	StructureBuilder ()
	Build Intermediate data structure.

LT_SYMBOL	SymbolBuilder (const wxString &aAscFileName, LT_ASC &aAscFile)

LT_SYMBOL	SymbolBuilder (const wxString &aAscFileName, const wxString &aAsyFileContent, LT_ASC &aAscFile)

const wxFileName &	GetLTspiceDataDir ()

Static Private Member Functions
static void	aggregateAttributeValue (wxArrayString &aTokens, int aIndex)
	Join value present across multiple tokens into one.

static int	integerCheck (const wxString &aToken, int aLineNumber, const wxString &aFileName)
	Used to check if the given token in integer or not.

static VECTOR2I	pointCheck (const wxString &aTokenX, const wxString &aTokenY, int aLineNumber, const wxString &aFileName)

static void	tokensSizeRangeCheck (size_t aActualSize, int aExpectedMin, int aExpectedMax, int aLineNumber, const wxString &aFileName)
	Used to check size of the token generated from split function.

static void	removeCarriageReturn (wxString &elementFromLine)

static LINESTYLE	getLineStyle (int aValue)

static LINEWIDTH	getLineWidth (const wxString &aValue)

static POLARITY	getPolarity (const wxString &aValue)

static ORIENTATION	getSymbolRotationOrMirror (const wxString &aValue)

static JUSTIFICATION	getTextJustification (const wxString &aValue)

static JUSTIFICATION	getPinJustification (const wxString &aValue)

static SYMBOLTYPE	getSymbolType (const wxString &aValue)

Private Attributes
REPORTER *	m_reporter

SCHEMATIC *	m_schematic

wxFileName	m_ltspiceDataDir

PROGRESS_REPORTER *	m_progressReporter

std::map< wxString, std::map< wxString, wxString > >	m_fileCache

Detailed Description

Definition at line 58 of file ltspice_schematic.h.

Member Enumeration Documentation

◆ JUSTIFICATION

enum class LTSPICE_SCHEMATIC::JUSTIFICATION

strong

Defines in what ways the PIN or TEXT can be justified.

Enumerator
NONE
BOTTOM
LEFT
RIGHT
CENTER
TOP
VBOTTOM
VLEFT
VRIGHT
VCENTER
VTOP

Definition at line 101 of file ltspice_schematic.h.

◆ LINESTYLE

enum class LTSPICE_SCHEMATIC::LINESTYLE

strong

Enumerator
SOLID
DASH
DOT
DASHDOT
DASHDOTDOT

Definition at line 61 of file ltspice_schematic.h.

◆ LINEWIDTH

enum class LTSPICE_SCHEMATIC::LINEWIDTH

strong

Enumerator
Normal
Wide

Definition at line 70 of file ltspice_schematic.h.

◆ ORIENTATION

enum class LTSPICE_SCHEMATIC::ORIENTATION

strong

Defines different types or rotation and mirror operation can be applied to a LT_SYMBOL.

Enumerator
R0
R90
R180
R270
M0
M90
M180
M270

Definition at line 119 of file ltspice_schematic.h.

◆ POLARITY

enum class LTSPICE_SCHEMATIC::POLARITY

strong

Polarity enum represents polarity of pin.

Enumerator
INPUT
OUTPUT
BIDIR

Definition at line 79 of file ltspice_schematic.h.

◆ SYMBOLTYPE

enum class LTSPICE_SCHEMATIC::SYMBOLTYPE

strong

Type of Symbol loaded from asc and asy file.

NOTE: Currently we have only found CELL and BLOCK type of symbol components others, we are not able to reproduce till now.

Enumerator
CELL
BLOCK

Definition at line 92 of file ltspice_schematic.h.

Constructor & Destructor Documentation

◆ LTSPICE_SCHEMATIC()

LTSPICE_SCHEMATIC::LTSPICE_SCHEMATIC	(	const wxString &	aFilename,
		const wxFileName &	aLTspiceDataDir,
		REPORTER *	aReporter,
		PROGRESS_REPORTER *	aProgressReporter
	)

inlineexplicit

Definition at line 280 of file ltspice_schematic.h.

◆ ~LTSPICE_SCHEMATIC()

LTSPICE_SCHEMATIC::~LTSPICE_SCHEMATIC ( )

inline

Definition at line 288 of file ltspice_schematic.h.

Member Function Documentation

◆ aggregateAttributeValue()

void LTSPICE_SCHEMATIC::aggregateAttributeValue	(	wxArrayString &	aTokens,
		int	aIndex
	)

staticprivate

Join value present across multiple tokens into one.

Parameters

aTokens	an array of tokenised data.
aIndex	from where the tokens should be concatenated.

Definition at line 396 of file ltspice_schematic.cpp.

Referenced by StructureBuilder(), and SymbolBuilder().

◆ GetAscAndAsyFilePaths()

void LTSPICE_SCHEMATIC::GetAscAndAsyFilePaths	(	const wxDir &	aDir,
		bool	aRecursive,
		std::map< wxString, wxString > &	aMapOfAscFiles,
		std::map< wxString, wxString > &	aMapOfAsyFiles,
		const wxString &	aBase = `wxEmptyString`
	)

Used to get file path for Asc and Asy files.

Parameters

aMapOfAscFiles	map of string containing content from asc files.
aMapOfAsyFiles	map of string containing content from asy files.

Definition at line 199 of file ltspice_schematic.cpp.

References _, GetAscAndAsyFilePaths(), m_reporter, path, and REPORTER::Report().

Referenced by GetAscAndAsyFilePaths(), and Load().

◆ getLineStyle()

LTSPICE_SCHEMATIC::LINESTYLE LTSPICE_SCHEMATIC::getLineStyle ( int aValue )

staticprivate

Parameters

aValue integer value between 0-3

Returns: LINESTYLE enum

Definition at line 404 of file ltspice_schematic.cpp.

References _, DASH, DASHDOT, DASHDOTDOT, DOT, SOLID, and THROW_IO_ERROR.

Referenced by StructureBuilder(), and SymbolBuilder().

◆ getLineWidth()

LTSPICE_SCHEMATIC::LINEWIDTH LTSPICE_SCHEMATIC::getLineWidth ( const wxString & aValue )

staticprivate

Parameters

aValue string value

Returns: LINEWIDTH enum

Definition at line 421 of file ltspice_schematic.cpp.

References _, Normal, THROW_IO_ERROR, and Wide.

Referenced by StructureBuilder(), and SymbolBuilder().

◆ GetLTspiceDataDir()

const wxFileName & LTSPICE_SCHEMATIC::GetLTspiceDataDir ( )

inline

Definition at line 352 of file ltspice_schematic.h.

References m_ltspiceDataDir.

Referenced by SCH_IO_LTSPICE_PARSER::CreateFields(), and SCH_IO_LTSPICE_PARSER::readIncludes().

◆ getPinJustification()

LTSPICE_SCHEMATIC::JUSTIFICATION LTSPICE_SCHEMATIC::getPinJustification ( const wxString & aValue )

staticprivate

Parameters

aValue string value

Returns: JUSTIFICATION enum

Definition at line 496 of file ltspice_schematic.cpp.

References _, BOTTOM, LEFT, NONE, RIGHT, THROW_IO_ERROR, TOP, VBOTTOM, VCENTER, VLEFT, VRIGHT, and VTOP.

Referenced by SymbolBuilder().

◆ getPolarity()

LTSPICE_SCHEMATIC::POLARITY LTSPICE_SCHEMATIC::getPolarity ( const wxString & aValue )

staticprivate

Parameters

aValue string value

Returns: POLARITY enum

Definition at line 435 of file ltspice_schematic.cpp.

References _, BIDIR, INPUT, OUTPUT, and THROW_IO_ERROR.

Referenced by StructureBuilder().

◆ GetSchematicElements()

std::vector< LTSPICE_FILE > LTSPICE_SCHEMATIC::GetSchematicElements ( const wxString & aAscFile )

Used to get symbols list present in asc file.

Parameters

aFilePath	path where file to be read is kept.
aReadType	specifies in which type the file is to be read eg. r specifies file is use open for reading.

Definition at line 305 of file ltspice_schematic.cpp.

Referenced by Load().

◆ getSymbolRotationOrMirror()

LTSPICE_SCHEMATIC::ORIENTATION LTSPICE_SCHEMATIC::getSymbolRotationOrMirror ( const wxString & aValue )

staticprivate

Parameters

aValue string value

Returns: ORIENTATION enum

Definition at line 453 of file ltspice_schematic.cpp.

References _, M0, M180, M270, M90, R0, R180, R270, R90, and THROW_IO_ERROR.

Referenced by StructureBuilder().

◆ getSymbolType()

LTSPICE_SCHEMATIC::SYMBOLTYPE LTSPICE_SCHEMATIC::getSymbolType ( const wxString & aValue )

staticprivate

Parameters

aValue string value

Returns: SYMBOLTYPE enum

Definition at line 518 of file ltspice_schematic.cpp.

References _, BLOCK, CELL, and THROW_IO_ERROR.

Referenced by SymbolBuilder().

◆ getTextJustification()

LTSPICE_SCHEMATIC::JUSTIFICATION LTSPICE_SCHEMATIC::getTextJustification ( const wxString & aValue )

staticprivate

Parameters

aValue string value

Returns: JUSTIFICATION enum

Definition at line 474 of file ltspice_schematic.cpp.

References _, BOTTOM, CENTER, LEFT, RIGHT, THROW_IO_ERROR, TOP, VBOTTOM, VCENTER, VLEFT, VRIGHT, and VTOP.

Referenced by StructureBuilder(), and SymbolBuilder().

◆ integerCheck()

int LTSPICE_SCHEMATIC::integerCheck	(	const wxString &	aToken,
		int	aLineNumber,
		const wxString &	aFileName
	)

staticprivate

Used to check if the given token in integer or not.

Parameters

aToken	token to be verified.
aLineNumber	gives on which line number the check is called.
aFileName	gives in which file the check is been called.

Returns: the integer value.

Exceptions

IO_ERROR if the token is not an integer.

Definition at line 353 of file ltspice_schematic.cpp.

References _, and THROW_IO_ERROR.

Referenced by pointCheck(), StructureBuilder(), and SymbolBuilder().

◆ IsAsySubsheet()

bool LTSPICE_SCHEMATIC::IsAsySubsheet ( const wxString & aAsyFile )

Check if the asy file content indicates that we need to load subsheet.

Parameters

aAsyFile contents of .asy file.

Definition at line 334 of file ltspice_schematic.cpp.

Referenced by Load().

◆ Load()

void LTSPICE_SCHEMATIC::Load	(	SCHEMATIC *	aSchematic,
		SCH_SHEET *	aRootSheet,
		const wxFileName &	aLibraryFileName,
		REPORTER *	aReporter
	)

The main function responsible for loading the .asc and .asy files.

Loads the asc file and asy files.

Parameters

aSchematic	is the schematic object.
aRootSheet	is the root sheet referencing variable.
aLibraryFileName	is the name of the library which gets created when the plugin runs.

Definition at line 36 of file ltspice_schematic.cpp.

References SCH_IO_LTSPICE_PARSER::CreateSymbol(), alg::delete_if(), LTSPICE_FILE::ElementName, GetAscAndAsyFilePaths(), LIB_SYMBOL::GetBoundingBox(), SCH_SHEET::GetFields(), BOX2< Vec >::GetOrigin(), PROJECT::GetProjectPath(), GetSchematicElements(), SCH_SHEET::GetScreen(), BOX2< Vec >::GetSize(), IsAsySubsheet(), m_fileCache, m_ltspiceDataDir, m_schematic, SCH_IO_LTSPICE_PARSER::Parse(), SCHEMATIC::Prj(), SCH_SHEET_PATH::push_back(), ReadAsyFile(), ReadAsyFiles(), REPORTER::Report(), RPT_SEVERITY_ERROR, SafeReadFile(), LTSPICE_FILE::Screen, SCH_SCREEN::SetFileName(), EDA_ITEM::SetParent(), SCH_SHEET::SetPosition(), SCH_SHEET::SetScreen(), SCH_SHEET::SetSize(), SCH_FIELD::SetText(), LTSPICE_FILE::Sheet, SHEETFILENAME, SHEETNAME, StructureBuilder(), SymbolBuilder(), SCH_IO_LTSPICE_PARSER::ToKicadCoords(), and IO_ERROR::What().

Referenced by SCH_IO_LTSPICE::LoadSchematicFile().

◆ pointCheck()

VECTOR2I LTSPICE_SCHEMATIC::pointCheck	(	const wxString &	aTokenX,
		const wxString &	aTokenY,
		int	aLineNumber,
		const wxString &	aFileName
	)

staticprivate

Definition at line 369 of file ltspice_schematic.cpp.

References integerCheck().

Referenced by StructureBuilder(), and SymbolBuilder().

◆ ReadAsyFile()

std::map< wxString, wxString > LTSPICE_SCHEMATIC::ReadAsyFile	(	const LTSPICE_FILE &	aSourceFile,
		const std::map< wxString, wxString > &	aAsyFileMap
	)

Definition at line 273 of file ltspice_schematic.cpp.

References LTSPICE_FILE::ElementName, and SafeReadFile().

Referenced by Load().

◆ ReadAsyFiles()

std::map< wxString, wxString > LTSPICE_SCHEMATIC::ReadAsyFiles	(	const std::vector< LTSPICE_FILE > &	aSourceFiles,
		const std::map< wxString, wxString > &	aAsyFileMap
	)

The function returns a map.

This map has all the asy files in form of string. For asy files the key will be symbol name.

Parameters

aFilenames contains all the symbols for which we we have to load the .asy files

Returns: a map of String having all .asy files

Definition at line 288 of file ltspice_schematic.cpp.

References SafeReadFile().

Referenced by Load().

◆ removeCarriageReturn()

void LTSPICE_SCHEMATIC::removeCarriageReturn ( wxString & elementFromLine )

staticprivate

Definition at line 532 of file ltspice_schematic.cpp.

Referenced by StructureBuilder(), and SymbolBuilder().

◆ StructureBuilder()

std::vector< LTSPICE_SCHEMATIC::LT_ASC > LTSPICE_SCHEMATIC::StructureBuilder ( )

Build Intermediate data structure.

Returns: LT_ASC struct filled with all info from asc and asy files.

The Arc is enclosed in the square given by above coordinates and its start and end coordinates are given. The arc is drawn counterclockwise from the starting point to the ending point.

Definition at line 774 of file ltspice_schematic.cpp.

Referenced by Load().

◆ SymbolBuilder() [1/2]

LTSPICE_SCHEMATIC::LT_SYMBOL LTSPICE_SCHEMATIC::SymbolBuilder	(	const wxString &	aAscFileName,
		const wxString &	aAsyFileContent,
		LT_ASC &	aAscFile
	)

The Circle is enclosed in the square which is represented by bottomRight and topLeft coordinates.

The Arc is enclosed in the square given by above coordinates and its start and end coordinates are given. The arc is drawn counterclockwise from the starting point to the ending point.

Definition at line 550 of file ltspice_schematic.cpp.

◆ SymbolBuilder() [2/2]

LTSPICE_SCHEMATIC::LT_SYMBOL LTSPICE_SCHEMATIC::SymbolBuilder	(	const wxString &	aAscFileName,
		LT_ASC &	aAscFile
	)

Definition at line 539 of file ltspice_schematic.cpp.

References _, m_fileCache, SymbolBuilder(), and THROW_IO_ERROR.

Referenced by SCH_IO_LTSPICE_PARSER::CreateKicadSYMBOLs(), Load(), StructureBuilder(), and SymbolBuilder().

◆ tokensSizeRangeCheck()

void LTSPICE_SCHEMATIC::tokensSizeRangeCheck	(	size_t	aActualSize,
		int	aExpectedMin,
		int	aExpectedMax,
		int	aLineNumber,
		const wxString &	aFileName
	)

staticprivate

Used to check size of the token generated from split function.

Parameters

aActualSize	actual size of array of token.
aExpectedMin	expected lower range(i.e size) of array of token.
aExpectedMax	expected higher range(i.e size) of array of token.
aLineNumber	gives on which line number the check is called.
aFileName	gives in which file the check is been called.

Exceptions

IO_ERROR if the actualSize is not within expected lower range..higher range.

Definition at line 377 of file ltspice_schematic.cpp.

References _, and THROW_IO_ERROR.

Referenced by StructureBuilder(), and SymbolBuilder().

Member Data Documentation

◆ m_fileCache

std::map<wxString, std::map<wxString, wxString> > LTSPICE_SCHEMATIC::m_fileCache

private

Definition at line 439 of file ltspice_schematic.h.

Referenced by Load(), StructureBuilder(), and SymbolBuilder().

◆ m_ltspiceDataDir

wxFileName LTSPICE_SCHEMATIC::m_ltspiceDataDir

private

Definition at line 436 of file ltspice_schematic.h.

Referenced by GetLTspiceDataDir(), and Load().

◆ m_progressReporter

PROGRESS_REPORTER* LTSPICE_SCHEMATIC::m_progressReporter

private

Definition at line 437 of file ltspice_schematic.h.

◆ m_reporter

REPORTER* LTSPICE_SCHEMATIC::m_reporter

private

Definition at line 434 of file ltspice_schematic.h.

Referenced by GetAscAndAsyFilePaths().

◆ m_schematic

SCHEMATIC* LTSPICE_SCHEMATIC::m_schematic

private

Definition at line 435 of file ltspice_schematic.h.

Referenced by Load().

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

Classes

Public Types

Public Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ JUSTIFICATION

◆ LINESTYLE

◆ LINEWIDTH

◆ ORIENTATION

◆ POLARITY

◆ SYMBOLTYPE

Constructor & Destructor Documentation

◆ LTSPICE_SCHEMATIC()

◆ ~LTSPICE_SCHEMATIC()

Member Function Documentation

◆ aggregateAttributeValue()

◆ GetAscAndAsyFilePaths()

◆ getLineStyle()

◆ getLineWidth()

◆ GetLTspiceDataDir()

◆ getPinJustification()

◆ getPolarity()

◆ GetSchematicElements()

◆ getSymbolRotationOrMirror()

◆ getSymbolType()

◆ getTextJustification()

◆ integerCheck()

◆ IsAsySubsheet()

◆ Load()

◆ pointCheck()

◆ ReadAsyFile()

◆ ReadAsyFiles()

◆ removeCarriageReturn()

◆ StructureBuilder()

◆ SymbolBuilder() [1/2]

◆ SymbolBuilder() [2/2]

◆ tokensSizeRangeCheck()

Member Data Documentation

◆ m_fileCache

◆ m_ltspiceDataDir

◆ m_progressReporter

◆ m_reporter

◆ m_schematic