A <wiring_descriptor> in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::WIRING:

Public Member Functions
	WIRING (ELEM *aParent)

	~WIRING ()

void	FormatContents (OUTPUTFORMATTER *out, int nestLevel) override
	Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.

UNIT_RES *	GetUnits () const override
	Return the units for this section.

DSN_T	Type () const

const char *	Name () const

virtual void	Format (OUTPUTFORMATTER *out, int nestLevel)
	Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.

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.

Protected Attributes
DSN_T	type

ELEM *	parent

Static Protected Attributes
static STRING_FORMATTER	sf

Private Attributes
UNIT_RES *	unit

WIRES	wires

WIRE_VIAS	wire_vias

Friends
class	SPECCTRA_DB

Detailed Description

A <wiring_descriptor> in the specctra dsn spec.

Definition at line 3139 of file specctra.h.

Constructor & Destructor Documentation

◆ WIRING()

DSN::WIRING::WIRING ( ELEM * aParent )

inline

Definition at line 3142 of file specctra.h.

References DSN::ELEM::ELEM(), and unit.

◆ ~WIRING()

DSN::WIRING::~WIRING ( )

inline

Definition at line 3148 of file specctra.h.

References unit.

Member Function Documentation

◆ Format()

void DSN::ELEM::Format	(	OUTPUTFORMATTER *	out,
		int	nestLevel )

virtualinherited

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

Parameters

out	The formatter to write to.
nestLevel	A multiple of the number of spaces to precede the output with.

Exceptions

IO_ERROR if a system error writing the output, such as a full disk.

Reimplemented in DSN::ANCESTOR, DSN::BOUNDARY, DSN::CIRCLE, DSN::CLASS, DSN::COMP_ORDER, DSN::COMPONENT, DSN::CONTROL, DSN::FROMTO, DSN::GRID, DSN::IMAGE, DSN::KEEPOUT, DSN::LAYER, DSN::LAYER_NOISE_WEIGHT, DSN::LAYER_RULE, DSN::NET, DSN::NET_OUT, DSN::PADSTACK, DSN::PATH, DSN::PCB, DSN::PIN, DSN::PLACE, DSN::QARC, DSN::RECTANGLE, DSN::RULE, DSN::SESSION, DSN::SHAPE, DSN::SPECCTRA_LAYER_PAIR, DSN::STRINGPROP, DSN::SUPPLY_PIN, DSN::TOKPROP, DSN::UNIT_RES, DSN::VIA, DSN::WINDOW, DSN::WIRE, and DSN::WIRE_VIA.

Definition at line 3782 of file specctra.cpp.

References FormatContents(), Name(), and OUTPUTFORMATTER::Print().

Referenced by DSN::CONTROL::Format(), DSN::ELEM_HOLDER::FormatContents(), and DSN::STRUCTURE::FormatContents().

◆ FormatContents()

void DSN::WIRING::FormatContents	(	OUTPUTFORMATTER *	out,
		int	nestLevel )

inlineoverridevirtual

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

out	The formatter to write to.
nestLevel	A multiple of the number of spaces to precede the output with.

Exceptions

IO_ERROR if a system error writing the output, such as a full disk.

Reimplemented from DSN::ELEM.

Definition at line 3153 of file specctra.h.

References unit, wire_vias, and wires.

◆ GetUnits()

UNIT_RES * DSN::WIRING::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 3165 of file specctra.h.

References DSN::ELEM::GetUnits(), and 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 268 of file specctra.h.

References FormatContents(), and sf.

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

◆ Name()

const char * DSN::ELEM::Name ( ) const

inherited

Definition at line 3768 of file specctra.cpp.

References type.

Referenced by DSN::ANCESTOR::Format(), DSN::BOUNDARY::Format(), DSN::CIRCLE::Format(), DSN::CLASS::Format(), DSN::COMP_ORDER::Format(), DSN::COMPONENT::Format(), DSN::CONTROL::Format(), Format(), DSN::FROMTO::Format(), DSN::GRID::Format(), DSN::IMAGE::Format(), DSN::KEEPOUT::Format(), DSN::LAYER::Format(), DSN::LAYER_NOISE_WEIGHT::Format(), DSN::LAYER_RULE::Format(), DSN::NET::Format(), DSN::PADSTACK::Format(), DSN::PATH::Format(), DSN::PCB::Format(), DSN::PLACE::Format(), DSN::QARC::Format(), DSN::RECTANGLE::Format(), DSN::RULE::Format(), DSN::SESSION::Format(), DSN::SHAPE::Format(), DSN::SPECCTRA_LAYER_PAIR::Format(), DSN::STRINGPROP::Format(), DSN::SUPPLY_PIN::Format(), DSN::TOKPROP::Format(), DSN::UNIT_RES::Format(), DSN::VIA::Format(), DSN::WINDOW::Format(), DSN::WIRE::Format(), and DSN::WIRE_VIA::Format().

◆ SetParent()

void DSN::ELEM::SetParent ( ELEM * aParent )

inlineinherited

Definition at line 252 of file specctra.h.

References ELEM(), and parent.

Referenced by DSN::LIBRARY::AddPadstack(), DSN::KEEPOUT::AddWindow(), DSN::LIBRARY::AppendIMAGE(), DSN::LIBRARY::AppendPADSTACK(), DSN::LIBRARY::AppendVia(), DSN::KEEPOUT::SetShape(), DSN::WINDOW::SetShape(), and DSN::WIRE::SetShape().

◆ Type()

DSN_T DSN::ELEM::Type ( ) const

inlineinherited

Definition at line 215 of file specctra.h.

References type.

Referenced by DSN::SPECCTRA_DB::doCLASS_CLASS(), DSN::ELEM_HOLDER::FindElem(), DSN::SPECCTRA_DB::FromSESSION(), DSN::SPECCTRA_DB::makeVIA(), DSN::KEEPOUT::SetShape(), DSN::WINDOW::SetShape(), and DSN::WIRE::SetShape().

Friends And Related Symbol Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB

friend

Definition at line 3174 of file specctra.h.

References SPECCTRA_DB.

Referenced by SPECCTRA_DB.

Member Data Documentation

◆ parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 281 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 278 of file specctra.h.

Referenced by makeHash().

◆ type

DSN_T DSN::ELEM::type

protectedinherited

Definition at line 280 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), ELEM(), DSN::UNIT_RES::Format(), Name(), and Type().

◆ unit

UNIT_RES* DSN::WIRING::unit

private

Definition at line 3176 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRING(), FormatContents(), GetUnits(), WIRING(), and ~WIRING().

◆ wire_vias

WIRE_VIAS DSN::WIRING::wire_vias

private

Definition at line 3178 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRING(), and FormatContents().

◆ wires

WIRES DSN::WIRING::wires

private

Definition at line 3177 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRING(), FormatContents(), and DSN::SPECCTRA_DB::FromBOARD().

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

specctra.h

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ WIRING()

◆ ~WIRING()

Member Function Documentation

◆ Format()

◆ FormatContents()

◆ GetUnits()

◆ makeHash()

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Symbol Documentation

◆ SPECCTRA_DB

Member Data Documentation

◆ parent

◆ sf

◆ type

◆ unit

◆ wire_vias

◆ wires