#include <specctra.h>

Inheritance diagram for DSN::PLACEMENT:

Public Member Functions
	PLACEMENT (ELEM *aParent)

	~PLACEMENT ()

COMPONENT *	LookupCOMPONENT (const std::string &imageName)
	Look up a COMPONENT by name.

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.

DSN_T	Type () const

const char *	Name () const

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 Attributes
UNIT_RES *	m_unit

DSN_T	m_flip_style

boost::ptr_vector< COMPONENT >	m_components

Friends
class	SPECCTRA_DB

Detailed Description

Definition at line 1797 of file specctra.h.

Constructor & Destructor Documentation

◆ PLACEMENT()

DSN::PLACEMENT::PLACEMENT ( ELEM * aParent )

inline

Definition at line 1800 of file specctra.h.

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

◆ ~PLACEMENT()

DSN::PLACEMENT::~PLACEMENT ( )

inline

Definition at line 1807 of file specctra.h.

References m_unit.

Member Function Documentation

◆ 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 3804 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::PLACEMENT::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.

Definition at line 1834 of file specctra.h.

References DSN::GetTokenText(), m_components, m_flip_style, m_unit, and OUTPUTFORMATTER::Print().

◆ GetUnits()

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

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

◆ LookupCOMPONENT()

COMPONENT * DSN::PLACEMENT::LookupCOMPONENT ( const std::string & imageName )

inline

Look up a COMPONENT by name.

If the name is not found, a new COMPONENT is added to the components container. At any time the names in the component container should remain unique.

Returns: existing or new COMPONENT.

Definition at line 1820 of file specctra.h.

References COMPONENT, m_components, and DSN::COMPONENT::SetImageId().

◆ 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 FormatContents(), and sf.

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

◆ Name()

const char * DSN::ELEM::Name ( ) const

inherited

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

References ELEM(), and parent.

Referenced by DSN::LIBRARY::AddPadstack(), DSN::KEEPOUT::AddWindow(), DSN::WIRE::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 210 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 1857 of file specctra.h.

References SPECCTRA_DB.

Referenced by SPECCTRA_DB.

Member Data Documentation

◆ m_components

boost::ptr_vector<COMPONENT> DSN::PLACEMENT::m_components

private

Definition at line 1861 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACEMENT(), FormatContents(), and LookupCOMPONENT().

◆ m_flip_style

DSN_T DSN::PLACEMENT::m_flip_style

private

Definition at line 1860 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACEMENT(), FormatContents(), and PLACEMENT().

◆ m_unit

UNIT_RES* DSN::PLACEMENT::m_unit

private

Definition at line 1859 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACEMENT(), FormatContents(), GetUnits(), PLACEMENT(), and ~PLACEMENT().

◆ parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 276 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 273 of file specctra.h.

Referenced by makeHash().

◆ type

DSN_T DSN::ELEM::type

protectedinherited

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

◆ PLACEMENT()

◆ ~PLACEMENT()

Member Function Documentation

◆ Format()

◆ FormatContents()

◆ GetUnits()

◆ LookupCOMPONENT()

◆ makeHash()

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Symbol Documentation

◆ SPECCTRA_DB

Member Data Documentation

◆ m_components

◆ m_flip_style

◆ m_unit

◆ parent

◆ sf

◆ type