A <net_descriptor> in the DSN spec. More...

#include <specctra.h>

Inheritance diagram for DSN::NET:

Public Member Functions
	NET (ELEM *aParent)

	~NET ()

int	FindPIN_REF (const std::string &aComponent)

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

DSN_T	Type () const

const char *	Name () const

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

virtual void	FormatContents (OUTPUTFORMATTER *out, int nestLevel)
	Write the contents 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
std::string	m_net_id

bool	m_unassigned

int	m_net_number

DSN_T	m_pins_type
	T_pins \| T_order, type of field 'pins' below.

std::vector< PIN_REF >	m_pins

std::vector< PIN_REF >	m_expose

std::vector< PIN_REF >	m_noexpose

std::vector< PIN_REF >	m_source

std::vector< PIN_REF >	m_load

std::vector< PIN_REF >	m_terminator

DSN_T	m_type
	T_fix \| T_normal.

DSN_T	m_supply
	T_power \| T_ground.

RULE *	m_rules

boost::ptr_vector< LAYER_RULE >	m_layer_rules

boost::ptr_vector< FROMTO >	m_fromtos

COMP_ORDER *	m_comp_order

Friends
class	SPECCTRA_DB

Detailed Description

A <net_descriptor> in the DSN spec.

Definition at line 2574 of file specctra.h.

Constructor & Destructor Documentation

◆ NET()

DSN::NET::NET ( ELEM * aParent )

inline

Definition at line 2577 of file specctra.h.

References DSN::ELEM::ELEM(), m_comp_order, m_net_number, m_pins_type, m_rules, m_supply, m_type, and m_unassigned.

◆ ~NET()

DSN::NET::~NET ( )

inline

Definition at line 2591 of file specctra.h.

References m_comp_order, and m_rules.

Member Function Documentation

◆ FindPIN_REF()

int DSN::NET::FindPIN_REF ( const std::string & aComponent )

inline

Definition at line 2597 of file specctra.h.

References m_pins.

◆ Format()

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

inlineoverridevirtual

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 from DSN::ELEM.

Definition at line 2608 of file specctra.h.

References OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), m_comp_order, m_fromtos, m_layer_rules, m_net_id, m_net_number, m_pins, m_pins_type, m_rules, m_type, m_unassigned, DSN::ELEM::Name(), pin, and OUTPUTFORMATTER::Print().

◆ 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

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::CLASS_CLASS, DSN::CLASSES, DSN::COMPONENT, DSN::ELEM_HOLDER, DSN::HISTORY, DSN::IMAGE, DSN::LIBRARY, DSN::NETWORK, DSN::PADSTACK, DSN::PARSER, DSN::PLACEMENT, DSN::REGION, DSN::ROUTE, DSN::STRUCTURE, DSN::STRUCTURE_OUT, DSN::TOPOLOGY, DSN::WAS_IS, and DSN::WIRING.

Definition at line 260 of file specctra.h.

Referenced by Format(), and makeHash().

◆ GetUnits()

UNIT_RES * DSN::ELEM::GetUnits ( ) const

virtualinherited

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 in DSN::IMAGE, DSN::LIBRARY, DSN::PADSTACK, DSN::PCB, DSN::PLACEMENT, DSN::ROUTE, DSN::STRUCTURE, and DSN::WIRING.

Definition at line 3795 of file specctra.cpp.

References DSN::UNIT_RES::Default, and parent.

Referenced by DSN::SPECCTRA_DB::FromSESSION(), DSN::IMAGE::GetUnits(), DSN::LIBRARY::GetUnits(), DSN::PADSTACK::GetUnits(), DSN::PCB::GetUnits(), DSN::PLACEMENT::GetUnits(), DSN::ROUTE::GetUnits(), DSN::STRUCTURE::GetUnits(), and DSN::WIRING::GetUnits().

◆ 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 281 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 3790 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 265 of file specctra.h.

References ELEM(), and parent.

Referenced by DSN::LIBRARY::AddPadstack(), DSN::KEEPOUT::AddWindow(), DSN::WIRE::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 228 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 2671 of file specctra.h.

References SPECCTRA_DB.

Referenced by SPECCTRA_DB.

Member Data Documentation

◆ m_comp_order

COMP_ORDER* DSN::NET::m_comp_order

private

Definition at line 2692 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), Format(), NET(), and ~NET().

◆ m_expose

std::vector<PIN_REF> DSN::NET::m_expose

private

Definition at line 2680 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET().

◆ m_fromtos

boost::ptr_vector<FROMTO> DSN::NET::m_fromtos

private

Definition at line 2691 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), and Format().

◆ m_layer_rules

boost::ptr_vector<LAYER_RULE> DSN::NET::m_layer_rules

private

Definition at line 2690 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), and Format().

◆ m_load

std::vector<PIN_REF> DSN::NET::m_load

private

Definition at line 2683 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET().

◆ m_net_id

std::string DSN::NET::m_net_id

private

Definition at line 2673 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), Format(), and DSN::SPECCTRA_DB::FromBOARD().

◆ m_net_number

int DSN::NET::m_net_number

private

Definition at line 2675 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), Format(), and NET().

◆ m_noexpose

std::vector<PIN_REF> DSN::NET::m_noexpose

private

Definition at line 2681 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET().

◆ m_pins

std::vector<PIN_REF> DSN::NET::m_pins

private

Definition at line 2678 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), FindPIN_REF(), Format(), and DSN::SPECCTRA_DB::FromBOARD().

◆ m_pins_type

DSN_T DSN::NET::m_pins_type

private

T_pins | T_order, type of field 'pins' below.

Definition at line 2677 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), Format(), and NET().

◆ m_rules

RULE* DSN::NET::m_rules

private

Definition at line 2688 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), Format(), NET(), and ~NET().

◆ m_source

std::vector<PIN_REF> DSN::NET::m_source

private

Definition at line 2682 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET().

◆ m_supply

DSN_T DSN::NET::m_supply

private

T_power | T_ground.

Definition at line 2687 of file specctra.h.

Referenced by NET().

◆ m_terminator

std::vector<PIN_REF> DSN::NET::m_terminator

private

Definition at line 2684 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET().

◆ m_type

DSN_T DSN::NET::m_type

private

T_fix | T_normal.

Definition at line 2686 of file specctra.h.

Referenced by Format(), and NET().

◆ m_unassigned

bool DSN::NET::m_unassigned

private

Definition at line 2674 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), Format(), and NET().

◆ parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 294 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 291 of file specctra.h.

Referenced by makeHash().

◆ type

DSN_T DSN::ELEM::type

protectedinherited

Definition at line 293 of file specctra.h.

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

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

◆ NET()

◆ ~NET()

Member Function Documentation

◆ FindPIN_REF()

◆ Format()

◆ FormatContents()

◆ GetUnits()

◆ makeHash()

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Symbol Documentation

◆ SPECCTRA_DB

Member Data Documentation

◆ m_comp_order

◆ m_expose

◆ m_fromtos

◆ m_layer_rules

◆ m_load

◆ m_net_id

◆ m_net_number

◆ m_noexpose

◆ m_pins

◆ m_pins_type

◆ m_rules

◆ m_source

◆ m_supply

◆ m_terminator

◆ m_type

◆ m_unassigned

◆ parent

◆ sf

◆ type