EURN Struct Reference

Container that parses Eagle library file "urn" definitions. More...

#include <eagle_parser.h>

Inheritance diagram for EURN:

Public Member Functions
	EURN ()
	EURN (const wxString &aUrn)
	Parse an Eagle "urn" string.
void	Parse (const wxString &aUrn)
bool	IsValid () const
	Check if the string passed to the ctor was a valid Eagle urn.
void	Report (const wxString &aMsg, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
	Send a message to the IO_BASE REPORTER object if one exists.
void	AdvanceProgressPhase ()

Public Attributes
wxString	host
	Should always be "urn".
wxString	path
	Path to the asset type below.
wxString	assetType
	Must be "symbol", "footprint", "package", "component", or "library".
wxString	assetId
	The unique asset identifier for the asset type.
wxString	assetVersion
	May be empty depending on the asset type.
IO_BASE *	io

Detailed Description

Container that parses Eagle library file "urn" definitions.

According to the eagle.dtd, the "urn" definition is as follows:

<!ENTITY % Urn "%String;">

Definition at line 432 of file eagle_parser.h.

Constructor & Destructor Documentation

EURN() [1/2]

EURN::EURN ( )

inline

Definition at line 434 of file eagle_parser.h.

EURN() [2/2]

EURN::EURN

(

const wxString &

aUrn

)

Parse an Eagle "urn" string.

Definition at line 293 of file eagle_parser.cpp.

References Parse().

Member Function Documentation

AdvanceProgressPhase()

void EAGLE_BASE::AdvanceProgressPhase ( )

inherited

Definition at line 558 of file eagle_parser.cpp.

References IO_BASE::AdvanceProgressPhase(), and EAGLE_BASE::io.

Referenced by EAGLE_DOC::EAGLE_DOC(), EAPPROVED::EAPPROVED(), EATTR::EATTR(), EBUS::EBUS(), ECIRCLE::ECIRCLE(), ECLASS::ECLASS(), ECOMPATIBILITY::ECOMPATIBILITY(), ECONNECT::ECONNECT(), EDESCRIPTION::EDESCRIPTION(), EDEVICE::EDEVICE(), EDEVICE_SET::EDEVICE_SET(), EDIMENSION::EDIMENSION(), EDRAWING::EDRAWING(), EFILTER::EFILTER(), EFRAME::EFRAME(), EGATE::EGATE(), EGRID::EGRID(), EHOLE::EHOLE(), EINSTANCE::EINSTANCE(), EJUNCTION::EJUNCTION(), ELABEL::ELABEL(), ELAYER::ELAYER(), ELIBRARY::ELIBRARY(), EMODEL::EMODEL(), EMODULE::EMODULE(), EMODULEINST::EMODULEINST(), ENET::ENET(), ENOTE::ENOTE(), EPACKAGE::EPACKAGE(), EPACKAGE3D::EPACKAGE3D(), EPACKAGE3DINST::EPACKAGE3DINST(), EPACKAGEINSTANCE::EPACKAGEINSTANCE(), EPAD::EPAD(), EPART::EPART(), EPIN::EPIN(), EPINMAP::EPINMAP(), EPINMAPPING::EPINMAPPING(), EPINREF::EPINREF(), EPLAIN::EPLAIN(), EPOLYGON::EPOLYGON(), EPORT::EPORT(), EPORTREF::EPORTREF(), EPROBE::EPROBE(), ERECT::ERECT(), ESCHEMATIC::ESCHEMATIC(), ESCHEMATIC_GROUP::ESCHEMATIC_GROUP(), ESEGMENT::ESEGMENT(), ESETTING::ESETTING(), ESHEET::ESHEET(), ESMD::ESMD(), ESPICE::ESPICE(), ESPLINE::ESPLINE(), ESYMBOL::ESYMBOL(), ETECHNOLOGY::ETECHNOLOGY(), ETEXT::ETEXT(), EVARIANT::EVARIANT(), EVARIANTDEF::EVARIANTDEF(), EVERTEX::EVERTEX(), EVIA::EVIA(), and EWIRE::EWIRE().

IsValid()

bool EURN::IsValid

(

)

const

Check if the string passed to the ctor was a valid Eagle urn.

Return values

true	if the urn string is valid.
false	if the urn string is not valid.

Definition at line 315 of file eagle_parser.cpp.

References assetId, assetType, host, and path.

Referenced by ELIBRARY::GetName().

Parse()

void EURN::Parse

(

const wxString &

aUrn

)

Definition at line 299 of file eagle_parser.cpp.

References assetId, assetType, assetVersion, host, and path.

Referenced by EURN().

Report()

void EAGLE_BASE::Report ( const wxString &  aMsg, SEVERITY  aSeverity = RPT_SEVERITY_UNDEFINED  )

inherited

Send a message to the IO_BASE REPORTER object if one exists.

Parameters

aMsg	is the message to send to the REPORTER object.

Definition at line 549 of file eagle_parser.cpp.

References EAGLE_BASE::io, and IO_BASE::Report().

Member Data Documentation

assetId

wxString EURN::assetId

The unique asset identifier for the asset type.

Definition at line 452 of file eagle_parser.h.

Referenced by ELIBRARY::GetName(), IsValid(), PCB_IO_EAGLE::loadElements(), and Parse().

assetType

wxString EURN::assetType

Must be "symbol", "footprint", "package", "component", or "library".

Definition at line 451 of file eagle_parser.h.

Referenced by IsValid(), and Parse().

assetVersion

wxString EURN::assetVersion

May be empty depending on the asset type.

Definition at line 453 of file eagle_parser.h.

Referenced by Parse().

host

wxString EURN::host

Should always be "urn".

Definition at line 449 of file eagle_parser.h.

Referenced by IsValid(), and Parse().

io

IO_BASE* EAGLE_BASE::io

inherited

Definition at line 405 of file eagle_parser.h.

Referenced by EAGLE_BASE::AdvanceProgressPhase(), and EAGLE_BASE::Report().

path

wxString EURN::path

Path to the asset type below.

Definition at line 450 of file eagle_parser.h.

Referenced by IsValid(), and Parse().

---

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

• eagle_parser.h
• eagle_parser.cpp