#include <specctra.h>

Inheritance diagram for DSN::CONTROL:

Public Member Functions
	CONTROL (ELEM *aParent)

	~CONTROL ()

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

virtual 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.

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
bool	via_at_smd

bool	via_at_smd_grid_on

ELEM_ARRAY	kids
	ELEM pointers.

Friends
class	SPECCTRA_DB

Detailed Description

Definition at line 1162 of file specctra.h.

Member Typedef Documentation

◆ ELEM_ARRAY

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

privateinherited

Definition at line 358 of file specctra.h.

Constructor & Destructor Documentation

◆ CONTROL()

DSN::CONTROL::CONTROL ( ELEM * aParent )

inline

Definition at line 1165 of file specctra.h.

References via_at_smd, and via_at_smd_grid_on.

◆ ~CONTROL()

DSN::CONTROL::~CONTROL ( )

inline

Definition at line 1172 of file specctra.h.

Member Function Documentation

◆ Append()

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

inlineinherited

Definition at line 322 of file specctra.h.

References DSN::ELEM_HOLDER::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 341 of file specctra.h.

References DSN::ELEM_HOLDER::kids.

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

◆ Delete()

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

inlineinherited

Definition at line 353 of file specctra.h.

References DSN::ELEM_HOLDER::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 DSN::ELEM_HOLDER::kids, and DSN::ELEM::Type().

◆ Format()

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

References DSN::ELEM_HOLDER::At(), DSN::ELEM::Format(), DSN::ELEM_HOLDER::Length(), DSN::ELEM::Name(), OUTPUTFORMATTER::Print(), via_at_smd, and via_at_smd_grid_on.

Referenced by DSN::STRUCTURE::FormatContents().

◆ FormatContents()

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

overridevirtualinherited

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.

Reimplemented in DSN::CLASS_CLASS, DSN::REGION, DSN::STRUCTURE, DSN::IMAGE, and DSN::PADSTACK.

Definition at line 3792 of file specctra.cpp.

References DSN::ELEM_HOLDER::At(), DSN::ELEM::Format(), and DSN::ELEM_HOLDER::Length().

Referenced by DSN::CLASS_CLASS::FormatContents(), DSN::REGION::FormatContents(), DSN::IMAGE::FormatContents(), and DSN::PADSTACK::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::STRUCTURE, DSN::PLACEMENT, DSN::IMAGE, DSN::PADSTACK, DSN::LIBRARY, DSN::WIRING, DSN::PCB, and DSN::ROUTE.

Definition at line 3773 of file specctra.cpp.

References DSN::UNIT_RES::Default, DSN::ELEM::GetUnits(), and DSN::ELEM::parent.

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

◆ Insert()

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

inlineinherited

Definition at line 339 of file specctra.h.

References DSN::ELEM_HOLDER::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 317 of file specctra.h.

References DSN::ELEM_HOLDER::kids.

Referenced by Format(), DSN::ELEM_HOLDER::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 263 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().