#include <specctra.h>

Inheritance diagram for DSN::CLASS_CLASS:

Public Member Functions
	CLASS_CLASS (ELEM *aParent, DSN_T aType)

	~CLASS_CLASS ()

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

int	FindElem (DSN_T aType, int instanceNum=0)
	Find a particular instance number of a given type of ELEM.

int	Length () const
	Return the number of ELEMs in this holder.

void	Append (ELEM *aElem)

ELEM *	Replace (int aIndex, ELEM *aElem)

ELEM *	Remove (int aIndex)

void	Insert (int aIndex, ELEM *aElem)

ELEM *	At (int aIndex) const

ELEM *	operator[] (int aIndex) const

void	Delete (int aIndex)

DSN_T	Type () const

const char *	Name () const

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

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 Types
typedef boost::ptr_vector< ELEM >	ELEM_ARRAY

Private Attributes
CLASSES *	classes

ELEM_ARRAY	kids
	ELEM pointers.

Friends
class	SPECCTRA_DB

Detailed Description

Definition at line 1130 of file specctra.h.

Member Typedef Documentation

◆ ELEM_ARRAY

typedef boost::ptr_vector<ELEM> DSN::ELEM_HOLDER::ELEM_ARRAY

privateinherited

Definition at line 363 of file specctra.h.

Constructor & Destructor Documentation

◆ CLASS_CLASS()

DSN::CLASS_CLASS::CLASS_CLASS	(	ELEM *	aParent,
		DSN_T	aType )

inline

Parameters

aParent	is the parent element of the object.
aType	May be either T_class_class or T_region_class_class

Definition at line 1138 of file specctra.h.

References classes, and DSN::ELEM_HOLDER::ELEM_HOLDER().

◆ ~CLASS_CLASS()

DSN::CLASS_CLASS::~CLASS_CLASS ( )

inline

Definition at line 1144 of file specctra.h.

References classes.

Member Function Documentation

◆ Append()

void DSN::ELEM_HOLDER::Append ( ELEM * aElem )

inlineinherited

Definition at line 327 of file specctra.h.

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

Referenced by DSN::SPECCTRA_DB::doCLASS_CLASS(), DSN::SPECCTRA_DB::doCONTROL(), DSN::SPECCTRA_DB::doIMAGE(), DSN::SPECCTRA_DB::doPADSTACK(), DSN::SPECCTRA_DB::doREGION(), DSN::SPECCTRA_DB::doSTRUCTURE(), DSN::SPECCTRA_DB::makePADSTACK(), and DSN::SPECCTRA_DB::makeVia().

◆ At()

ELEM * DSN::ELEM_HOLDER::At ( int aIndex ) const

inlineinherited

Definition at line 346 of file specctra.h.

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

Referenced by DSN::CONTROL::Format(), FormatContents(), DSN::STRUCTURE::FormatContents(), and operator[]().

◆ Delete()

void DSN::ELEM_HOLDER::Delete ( int aIndex )

inlineinherited

Definition at line 358 of file specctra.h.

References kids.

◆ FindElem()

int DSN::ELEM_HOLDER::FindElem	(	DSN_T	aType,
		int	instanceNum = 0 )

inherited

Find a particular instance number of a given type of ELEM.

Parameters

aType	The type of ELEM to find
instanceNum	The instance number of to find: 0 for first, 1 for second, etc.

Returns: int - The index into the kids array or -1 if not found.

Definition at line 3799 of file specctra.cpp.

References kids, T, and DSN::ELEM::Type().

◆ 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::CLASS_CLASS::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_HOLDER.

Definition at line 1149 of file specctra.h.

References classes, and DSN::ELEM_HOLDER::FormatContents().

◆ 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 3773 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().

◆ Insert()

void DSN::ELEM_HOLDER::Insert	(	int	aIndex,
		ELEM *	aElem )

inlineinherited

Definition at line 344 of file specctra.h.

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

◆ Length()

int DSN::ELEM_HOLDER::Length ( ) const

inlineinherited

Return the number of ELEMs in this holder.

Returns: the count of children elements.

Definition at line 322 of file specctra.h.

References kids.

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

◆ 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().

◆ operator[]()

ELEM * DSN::ELEM_HOLDER::operator[] ( int aIndex ) const

inlineinherited

Definition at line 353 of file specctra.h.

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

◆ Remove()

ELEM * DSN::ELEM_HOLDER::Remove ( int aIndex )

inlineinherited

Definition at line 338 of file specctra.h.

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

◆ Replace()

ELEM * DSN::ELEM_HOLDER::Replace	(	int	aIndex,
		ELEM *	aElem )

inlineinherited

Definition at line 332 of file specctra.h.

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

◆ 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 1159 of file specctra.h.

References SPECCTRA_DB.

Referenced by SPECCTRA_DB.

Member Data Documentation

◆ classes

CLASSES* DSN::CLASS_CLASS::classes

private

Definition at line 1161 of file specctra.h.

Referenced by CLASS_CLASS(), DSN::SPECCTRA_DB::doCLASS_CLASS(), FormatContents(), and ~CLASS_CLASS().

◆ kids

ELEM_ARRAY DSN::ELEM_HOLDER::kids

privateinherited

ELEM pointers.

Definition at line 365 of file specctra.h.

Referenced by Append(), At(), Delete(), FindElem(), Insert(), Length(), Remove(), and Replace().

◆ 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().

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 Types

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ELEM_ARRAY

Constructor & Destructor Documentation

◆ CLASS_CLASS()

◆ ~CLASS_CLASS()

Member Function Documentation

◆ Append()

◆ At()

◆ Delete()

◆ FindElem()

◆ Format()

◆ FormatContents()

◆ GetUnits()

◆ Insert()

◆ Length()

◆ makeHash()

◆ Name()

◆ operator[]()

◆ Remove()

◆ Replace()

◆ SetParent()

◆ Type()

Friends And Related Symbol Documentation

◆ SPECCTRA_DB

Member Data Documentation

◆ classes

◆ kids

◆ parent

◆ sf

◆ type