#include <specctra.h>

Inheritance diagram for DSN::IMAGE:

Public Member Functions
	IMAGE (ELEM *aParent)

	~IMAGE ()

std::string	GetImageId ()

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

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.

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

void	SetParent (ELEM *aParent)

Static Public Member Functions
static int	Compare (IMAGE lhs, IMAGE rhs)
	Compare two objects of this type and returns <0, 0, or >0.

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
std::string	m_hash
	a hash string used by Compare(), not Format()ed/exported.

std::string	m_image_id

DSN_T	m_side

UNIT_RES *	m_unit

PINS	m_pins

RULE *	m_rules

RULE *	m_place_rules

KEEPOUTS	m_keepouts

int	m_duplicated
	no. times this image_id is duplicated

ELEM_ARRAY	kids
	ELEM pointers.

Friends
class	SPECCTRA_DB

class	LIBRARY

Detailed Description

Definition at line 2005 of file specctra.h.

Member Typedef Documentation

◆ ELEM_ARRAY

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

privateinherited

Definition at line 357 of file specctra.h.

Constructor & Destructor Documentation

◆ IMAGE()

DSN::IMAGE::IMAGE ( ELEM * aParent )

inline

Definition at line 2008 of file specctra.h.

References m_duplicated, m_place_rules, m_rules, m_side, and m_unit.

◆ ~IMAGE()

DSN::IMAGE::~IMAGE ( )

inline

Definition at line 2018 of file specctra.h.

References m_place_rules, m_rules, and m_unit.

Member Function Documentation

◆ Append()

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

inlineinherited

Definition at line 321 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 340 of file specctra.h.

References DSN::ELEM_HOLDER::kids.

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

◆ Compare()

int IMAGE::Compare	(	IMAGE *	lhs,
		IMAGE *	rhs
	)

static

Compare two objects of this type and returns <0, 0, or >0.

Definition at line 3837 of file specctra.cpp.

References m_hash, and DSN::ELEM::makeHash().

Referenced by DSN::LIBRARY::FindIMAGE().

◆ Delete()

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

inlineinherited

Definition at line 352 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 3790 of file specctra.cpp.

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

◆ Format()

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

References FormatContents(), GetImageId(), OUTPUTFORMATTER::GetQuoteChar(), DSN::ELEM::Name(), and OUTPUTFORMATTER::Print().

◆ FormatContents()

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

References DSN::UNIT_RES::Format(), DSN::RULE::Format(), DSN::ELEM_HOLDER::FormatContents(), DSN::GetTokenText(), m_keepouts, m_pins, m_place_rules, m_rules, m_side, m_unit, and OUTPUTFORMATTER::Print().

Referenced by Format().

◆ GetImageId()

std::string DSN::IMAGE::GetImageId ( )

inline

Definition at line 2030 of file specctra.h.

References m_duplicated, and m_image_id.

Referenced by Format().

◆ GetUnits()

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

References DSN::ELEM::GetUnits(), and m_unit.

◆ Insert()

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

inlineinherited

Definition at line 338 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 316 of file specctra.h.

References DSN::ELEM_HOLDER::kids.

Referenced by DSN::CONTROL::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 262 of file specctra.h.

References STRING_FORMATTER::Clear(), DSN::ELEM::FormatContents(), STRING_FORMATTER::GetString(), DSN::ELEM::sf, and STRING_FORMATTER::StripUseless().

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