The <class_descriptor> in the specctra spec. More...

#include <specctra.h>

Inheritance diagram for DSN::CLASS:

Public Member Functions
	CLASS (ELEM *aParent)

	~CLASS ()

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_class_id

std::vector< std::string >	m_net_ids

std::vector< std::string >	m_circuit
	circuit descriptor list

RULE *	m_rules

boost::ptr_vector< LAYER_RULE >	m_layer_rules

TOPOLOGY *	m_topology

Friends
class	SPECCTRA_DB

Detailed Description

The <class_descriptor> in the specctra spec.

Definition at line 2705 of file specctra.h.

Constructor & Destructor Documentation

◆ CLASS()

DSN::CLASS::CLASS ( ELEM * aParent )

inline

Definition at line 2708 of file specctra.h.

References DSN::ELEM::ELEM(), m_rules, and m_topology.

◆ ~CLASS()

DSN::CLASS::~CLASS ( )

inline

Definition at line 2715 of file specctra.h.

References m_rules, and m_topology.

Member Function Documentation

◆ Format()

void DSN::CLASS::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 2721 of file specctra.h.

References OUTPUTFORMATTER::GetQuoteChar(), m_circuit, m_class_id, m_layer_rules, m_net_ids, m_rules, m_topology, DSN::ELEM::Name(), 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 241 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 3771 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 262 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 3766 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 246 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 209 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 2779 of file specctra.h.

References SPECCTRA_DB.

Referenced by SPECCTRA_DB.

Member Data Documentation

◆ m_circuit

std::vector<std::string> DSN::CLASS::m_circuit

private

circuit descriptor list

Definition at line 2785 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doCLASS(), DSN::SPECCTRA_DB::exportNETCLASS(), and Format().

◆ m_class_id

std::string DSN::CLASS::m_class_id

private

Definition at line 2781 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doCLASS(), DSN::SPECCTRA_DB::exportNETCLASS(), and Format().

◆ m_layer_rules

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

private

Definition at line 2788 of file specctra.h.

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

◆ m_net_ids

std::vector<std::string> DSN::CLASS::m_net_ids

private

Definition at line 2782 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doCLASS(), DSN::SPECCTRA_DB::exportNETCLASS(), and Format().

◆ m_rules

RULE* DSN::CLASS::m_rules

private

Definition at line 2787 of file specctra.h.

Referenced by CLASS(), DSN::SPECCTRA_DB::doCLASS(), DSN::SPECCTRA_DB::exportNETCLASS(), Format(), and ~CLASS().

◆ m_topology

TOPOLOGY* DSN::CLASS::m_topology

private

Definition at line 2789 of file specctra.h.

Referenced by CLASS(), DSN::SPECCTRA_DB::doCLASS(), Format(), and ~CLASS().

◆ parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 275 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 272 of file specctra.h.

Referenced by makeHash().

◆ type

DSN_T DSN::ELEM::type

protectedinherited

Definition at line 274 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

◆ CLASS()

◆ ~CLASS()

Member Function Documentation

◆ Format()

◆ FormatContents()

◆ GetUnits()

◆ makeHash()

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Symbol Documentation

◆ SPECCTRA_DB

Member Data Documentation

◆ m_circuit

◆ m_class_id

◆ m_layer_rules

◆ m_net_ids

◆ m_rules

◆ m_topology

◆ parent

◆ sf

◆ type