KiCad PCB EDA Suite
Loading...
Searching...
No Matches
DSN::PCB Class Reference

#include <specctra.h>

Inheritance diagram for DSN::PCB:
DSN::ELEM

Public Member Functions

 PCB (ELEM *aParent=nullptr)
 
 ~PCB ()
 
void Format (OUTPUTFORMATTER *out, int nestLevel) override
 Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
UNIT_RESGetUnits () const override
 Return the units for this section. More...
 
DSN_T Type () const
 
const char * Name () const
 
virtual void FormatContents (OUTPUTFORMATTER *out, int nestLevel)
 Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
void SetParent (ELEM *aParent)
 

Protected Member Functions

std::string makeHash ()
 Return a string which uniquely represents this ELEM among other ELEMs of the same derived class as "this" one. More...
 

Protected Attributes

DSN_T type
 
ELEMparent
 

Static Protected Attributes

static STRING_FORMATTER sf
 

Private Attributes

std::string m_pcbname
 
PARSERm_parser
 
UNIT_RESm_resolution
 
UNIT_RESm_unit
 
STRUCTUREm_structure
 
PLACEMENTm_placement
 
LIBRARYm_library
 
NETWORKm_network
 
WIRINGm_wiring
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 3172 of file specctra.h.

Constructor & Destructor Documentation

◆ PCB()

DSN::PCB::PCB ( ELEM aParent = nullptr)
inline

Definition at line 3175 of file specctra.h.

References m_library, m_network, m_parser, m_placement, m_resolution, m_structure, m_unit, and m_wiring.

◆ ~PCB()

DSN::PCB::~PCB ( )
inline

Definition at line 3188 of file specctra.h.

References m_library, m_network, m_parser, m_placement, m_resolution, m_structure, m_unit, and m_wiring.

Member Function Documentation

◆ Format()

void DSN::PCB::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
inlineoverridevirtual

Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.

Parameters
outThe formatter to write to.
nestLevelA multiple of the number of spaces to precede the output with.
Exceptions
IO_ERRORif a system error writing the output, such as a full disk.

Reimplemented from DSN::ELEM.

Definition at line 3200 of file specctra.h.

References DSN::ELEM::Format(), DSN::UNIT_RES::Format(), OUTPUTFORMATTER::GetQuoteChar(), m_library, m_network, m_parser, m_pcbname, m_placement, m_resolution, m_structure, m_unit, m_wiring, DSN::ELEM::Name(), and OUTPUTFORMATTER::Print().

Referenced by DSN::SPECCTRA_DB::ExportPCB(), and main().

◆ FormatContents()

virtual void DSN::ELEM::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
inlinevirtualinherited

Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.

This is the same as Format() except that the outer wrapper is not included.

Parameters
outThe formatter to write to.
nestLevelA multiple of the number of spaces to precede the output with.
Exceptions
IO_ERRORif a system error writing the output, such as a full disk.

Reimplemented in DSN::ELEM_HOLDER, DSN::PARSER, DSN::CLASSES, DSN::CLASS_CLASS, DSN::REGION, DSN::STRUCTURE_OUT, DSN::STRUCTURE, DSN::COMPONENT, DSN::PLACEMENT, DSN::IMAGE, DSN::PADSTACK, DSN::LIBRARY, DSN::TOPOLOGY, DSN::NETWORK, DSN::WIRING, DSN::HISTORY, DSN::ROUTE, and DSN::WAS_IS.

Definition at line 241 of file specctra.h.

Referenced by DSN::ELEM::Format(), and DSN::ELEM::makeHash().

◆ GetUnits()

UNIT_RES * DSN::PCB::GetUnits ( ) const
inlineoverridevirtual

Return the units for this section.

Derived classes may override this to check for section specific overrides.

Returns
an element from a local or parent scope.

Reimplemented from DSN::ELEM.

Definition at line 3233 of file specctra.h.

References DSN::ELEM::GetUnits(), m_resolution, and m_unit.

◆ makeHash()

std::string DSN::ELEM::makeHash ( )
inlineprotectedinherited

Return a string which uniquely represents this ELEM among other ELEMs of the same derived class as "this" one.

It is not usable for all derived classes, only those which plan for it by implementing a FormatContents() function that captures all info which will be used in the subsequent string compare. THIS SHOULD NORMALLY EXCLUDE THE TYPENAME, AND INSTANCE NAME OR ID AS WELL.

Definition at line 262 of file specctra.h.

References STRING_FORMATTER::Clear(), DSN::ELEM::FormatContents(), STRING_FORMATTER::GetString(), DSN::ELEM::sf, and STRING_FORMATTER::StripUseless().

Referenced by DSN::IMAGE::Compare(), and DSN::PADSTACK::Compare().

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 3245 of file specctra.h.

Member Data Documentation

◆ m_library

LIBRARY* DSN::PCB::m_library
private

◆ m_network

◆ m_parser

PARSER* DSN::PCB::m_parser
private

◆ m_pcbname

std::string DSN::PCB::m_pcbname
private

Definition at line 3247 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPCB(), DSN::SPECCTRA_DB::ExportPCB(), and Format().

◆ m_placement

PLACEMENT* DSN::PCB::m_placement
private

◆ m_resolution

UNIT_RES* DSN::PCB::m_resolution
private

◆ m_structure

◆ m_unit

UNIT_RES* DSN::PCB::m_unit
private

◆ m_wiring

WIRING* DSN::PCB::m_wiring
private

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 275 of file specctra.h.

Referenced by DSN::ELEM::GetUnits(), and DSN::ELEM::SetParent().

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 272 of file specctra.h.

Referenced by DSN::ELEM::makeHash().

◆ type

DSN_T DSN::ELEM::type
protectedinherited

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