Used for <keepout_descriptor> and <plane_descriptor>. More...

#include <specctra.h>

Inheritance diagram for DSN::KEEPOUT:

Public Member Functions
	KEEPOUT (ELEM *aParent, DSN_T aType)
	Require a DSN_T because this class is used for T_place_keepout, T_via_keepout, T_wire_keepout, T_bend_keepout, and T_elongate_keepout as well as T_keepout.

	~KEEPOUT ()

void	SetShape (ELEM *aShape)

void	AddWindow (WINDOW *aWindow)

void	Format (OUTPUTFORMATTER *out, int nestLevel) override
	Write this object 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.

virtual void	FormatContents (OUTPUTFORMATTER *out, int nestLevel)
	Write the contents 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
std::string	m_name

int	m_sequence_number

RULE *	m_rules

RULE *	m_place_rules

WINDOWS	m_windows

ELEM *	m_shape

DSN_T	type

ELEM *	parent

Static Protected Attributes
static STRING_FORMATTER	sf

Friends
class	SPECCTRA_DB

Detailed Description

Used for <keepout_descriptor> and <plane_descriptor>.

Definition at line 905 of file specctra.h.

Constructor & Destructor Documentation

◆ KEEPOUT()

DSN::KEEPOUT::KEEPOUT	(	ELEM *	aParent,
		DSN_T	aType
	)

inline

Require a DSN_T because this class is used for T_place_keepout, T_via_keepout, T_wire_keepout, T_bend_keepout, and T_elongate_keepout as well as T_keepout.

Definition at line 913 of file specctra.h.

References m_place_rules, m_rules, m_sequence_number, and m_shape.

◆ ~KEEPOUT()

DSN::KEEPOUT::~KEEPOUT ( )

inline

Definition at line 923 of file specctra.h.

References m_place_rules, m_rules, and m_shape.

Member Function Documentation

◆ AddWindow()

void DSN::KEEPOUT::AddWindow ( WINDOW * aWindow )

inline

Definition at line 947 of file specctra.h.

References m_windows, and DSN::ELEM::SetParent().

Referenced by DSN::SPECCTRA_DB::FromBOARD(), and DSN::SPECCTRA_DB::makeIMAGE().

◆ Format()

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

References DSN::ELEM::Format(), DSN::RULE::Format(), OUTPUTFORMATTER::GetQuoteChar(), m_name, m_place_rules, m_rules, m_sequence_number, m_shape, m_windows, DSN::ELEM::Name(), and OUTPUTFORMATTER::Print().

◆ FormatContents()

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

inlinevirtualinherited

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 in DSN::ELEM_HOLDER, DSN::PARSER, DSN::CLASSES, DSN::CLASS_CLASS, DSN::REGION, DSN::STRUCTURE_OUT, DSN::STRUCTURE, DSN::COMPONENT, DSN::PLACEMENT, DSN::IMAGE, DSN::PADSTACK, DSN::LIBRARY, DSN::TOPOLOGY, DSN::NETWORK, DSN::WIRING, DSN::HISTORY, DSN::ROUTE, and DSN::WAS_IS.

Definition at line 242 of file specctra.h.

Referenced by DSN::ELEM::Format(), and DSN::ELEM::makeHash().

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

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