Implement a <component_descriptor> in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::COMPONENT:

Public Member Functions
	COMPONENT (ELEM *aParent)

const std::string &	GetImageId () const

void	SetImageId (const std::string &aImageId)

void	Format (OUTPUTFORMATTER *out, int nestLevel) override
	Compare two objects of this type and returns <0, 0, or >0.

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

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 Attributes
std::string	m_image_id

PLACES	m_places

Friends
class	SPECCTRA_DB

Detailed Description

Implement a <component_descriptor> in the specctra dsn spec.

Definition at line 1766 of file specctra.h.

Constructor & Destructor Documentation

◆ COMPONENT()

DSN::COMPONENT::COMPONENT ( ELEM * aParent )

inline

Definition at line 1769 of file specctra.h.

Member Function Documentation

◆ Format()

void DSN::COMPONENT::Format	(	OUTPUTFORMATTER *	out,
		int	nestLevel
	)

inlineoverridevirtual

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

Reimplemented from DSN::ELEM.

Definition at line 1786 of file specctra.h.

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

◆ FormatContents()

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

References m_places.

Referenced by Format().

◆ GetImageId()

const std::string & DSN::COMPONENT::GetImageId ( ) const

inline

Definition at line 1774 of file specctra.h.

References m_image_id.

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

◆ 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 DSN::IMAGE::Compare(), and DSN::PADSTACK::Compare().