#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

boost::ptr_vector< PIN >	m_pins

RULE *	m_rules

RULE *	m_place_rules

boost::ptr_vector< KEEPOUT >	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 1985 of file specctra.h.

Member Typedef Documentation

◆ ELEM_ARRAY

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

privateinherited

Definition at line 361 of file specctra.h.

Constructor & Destructor Documentation

◆ IMAGE()

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

inline

Definition at line 1988 of file specctra.h.

References DSN::ELEM_HOLDER::ELEM_HOLDER(), m_duplicated, m_place_rules, m_rules, m_side, and m_unit.

Referenced by Compare().

◆ ~IMAGE()

DSN::IMAGE::~IMAGE ( )

inline

Definition at line 1998 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 325 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 344 of file specctra.h.

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

Referenced by DSN::CONTROL::Format(), FormatContents(), DSN::STRUCTURE::FormatContents(), and 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 3846 of file specctra.cpp.

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

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

◆ Delete()

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

inlineinherited

Definition at line 356 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::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 2020 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 2034 of file specctra.h.

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

Referenced by Format().

◆ GetImageId()

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

inline

Definition at line 2010 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 2060 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 342 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 320 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 266 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 351 of file specctra.h.

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

◆ Remove()

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

inlineinherited

Definition at line 336 of file specctra.h.

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

◆ Replace()

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

inlineinherited

Definition at line 330 of file specctra.h.

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

◆ SetParent()

void DSN::ELEM::SetParent ( ELEM * aParent )

inlineinherited

Definition at line 250 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 213 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

◆ LIBRARY

friend class LIBRARY

friend

Definition at line 2070 of file specctra.h.

References LIBRARY.

Referenced by LIBRARY.

◆ SPECCTRA_DB

friend class SPECCTRA_DB

friend

Definition at line 2069 of file specctra.h.

References SPECCTRA_DB.

Referenced by SPECCTRA_DB.

Member Data Documentation

◆ kids

ELEM_ARRAY DSN::ELEM_HOLDER::kids

privateinherited

ELEM pointers.

Definition at line 363 of file specctra.h.

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

◆ m_duplicated

int DSN::IMAGE::m_duplicated

private

no. times this image_id is duplicated

Definition at line 2090 of file specctra.h.

Referenced by DSN::LIBRARY::FindIMAGE(), GetImageId(), and IMAGE().

◆ m_hash

std::string DSN::IMAGE::m_hash

private

a hash string used by Compare(), not Format()ed/exported.

Definition at line 2072 of file specctra.h.

Referenced by Compare().

◆ m_image_id

std::string DSN::IMAGE::m_image_id

private

Definition at line 2074 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), DSN::LIBRARY::FindIMAGE(), and GetImageId().

◆ m_keepouts

boost::ptr_vector<KEEPOUT> DSN::IMAGE::m_keepouts

private

Definition at line 2088 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), and FormatContents().

◆ m_pins

boost::ptr_vector<PIN> DSN::IMAGE::m_pins

private

Definition at line 2083 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), and FormatContents().

◆ m_place_rules

RULE* DSN::IMAGE::m_place_rules

private

Definition at line 2086 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), FormatContents(), IMAGE(), and ~IMAGE().

◆ m_rules

RULE* DSN::IMAGE::m_rules

private

Definition at line 2085 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), FormatContents(), IMAGE(), and ~IMAGE().

◆ m_side

DSN_T DSN::IMAGE::m_side

private

Definition at line 2075 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), FormatContents(), and IMAGE().

◆ m_unit

UNIT_RES* DSN::IMAGE::m_unit

private

Definition at line 2076 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), FormatContents(), GetUnits(), IMAGE(), and ~IMAGE().

◆ parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 279 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 276 of file specctra.h.

Referenced by makeHash().

◆ type

DSN_T DSN::ELEM::type

protectedinherited

Definition at line 278 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 files:

Public Member Functions

Static 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

◆ IMAGE()

◆ ~IMAGE()

Member Function Documentation

◆ Append()

◆ At()

◆ Compare()

◆ Delete()

◆ FindElem()

◆ Format()

◆ FormatContents()

◆ GetImageId()

◆ GetUnits()

◆ Insert()

◆ Length()

◆ makeHash()

◆ Name()

◆ operator[]()

◆ Remove()

◆ Replace()

◆ SetParent()

◆ Type()

Friends And Related Symbol Documentation

◆ LIBRARY

◆ SPECCTRA_DB

Member Data Documentation

◆ kids

◆ m_duplicated

◆ m_hash

◆ m_image_id

◆ m_keepouts

◆ m_pins

◆ m_place_rules

◆ m_rules

◆ m_side

◆ m_unit

◆ parent

◆ sf

◆ type