Support both the <path_descriptor> and the <polygon_descriptor> per the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::PATH:

Public Member Functions
	PATH (ELEM *aParent, DSN_T aType=T_path)

void	AppendPoint (const POINT &aPoint)

std::vector< POINT > &	GetPoints ()

void	SetLayerId (const std::string &aLayerId)

void	SetAperture (double aWidth)

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
DSN_T	type

ELEM *	parent

Static Protected Attributes
static STRING_FORMATTER	sf

Private Attributes
std::string	layer_id

double	aperture_width

std::vector< POINT >	points

DSN_T	aperture_type

Friends
class	SPECCTRA_DB

Detailed Description

Support both the <path_descriptor> and the <polygon_descriptor> per the specctra dsn spec.

Definition at line 597 of file specctra.h.

Constructor & Destructor Documentation

◆ PATH()

DSN::PATH::PATH	(	ELEM *	aParent,
		DSN_T	aType = T_path )

inline

Definition at line 601 of file specctra.h.

References aperture_type, aperture_width, and DSN::ELEM::ELEM().

Member Function Documentation

◆ AppendPoint()

void DSN::PATH::AppendPoint ( const POINT & aPoint )

inline

Definition at line 608 of file specctra.h.

References points.

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

◆ Format()

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

References aperture_type, aperture_width, OUTPUTFORMATTER::GetQuoteChar(), layer_id, DSN::ELEM::Name(), points, 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::CLASS_CLASS, DSN::CLASSES, DSN::COMPONENT, DSN::ELEM_HOLDER, DSN::HISTORY, DSN::IMAGE, DSN::LIBRARY, DSN::NETWORK, DSN::PADSTACK, DSN::PARSER, DSN::PLACEMENT, DSN::REGION, DSN::ROUTE, DSN::STRUCTURE, DSN::STRUCTURE_OUT, DSN::TOPOLOGY, DSN::WAS_IS, and DSN::WIRING.

Definition at line 260 of file specctra.h.

Referenced by Format(), and makeHash().

◆ GetPoints()

std::vector< POINT > & DSN::PATH::GetPoints ( )

inline

Definition at line 613 of file specctra.h.

References points.

◆ 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::IMAGE, DSN::LIBRARY, DSN::PADSTACK, DSN::PCB, DSN::PLACEMENT, DSN::ROUTE, DSN::STRUCTURE, and DSN::WIRING.

Definition at line 3795 of file specctra.cpp.

References DSN::UNIT_RES::Default, and parent.

Referenced by DSN::SPECCTRA_DB::FromSESSION(), DSN::IMAGE::GetUnits(), DSN::LIBRARY::GetUnits(), DSN::PADSTACK::GetUnits(), DSN::PCB::GetUnits(), DSN::PLACEMENT::GetUnits(), DSN::ROUTE::GetUnits(), DSN::STRUCTURE::GetUnits(), and DSN::WIRING::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 281 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().

◆ SetAperture()

void DSN::PATH::SetAperture ( double aWidth )

inline

Definition at line 620 of file specctra.h.

References aperture_width.

◆ SetLayerId()

void DSN::PATH::SetLayerId ( const std::string & aLayerId )

inline

Definition at line 615 of file specctra.h.

References layer_id.

Referenced by DSN::appendPadstackShape(), and DSN::SPECCTRA_DB::fillBOUNDARY().

◆ SetParent()

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

inlineinherited

Definition at line 265 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 228 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 663 of file specctra.h.

References SPECCTRA_DB.

Referenced by SPECCTRA_DB.

Member Data Documentation

◆ aperture_type

DSN_T DSN::PATH::aperture_type

private

Definition at line 669 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPATH(), Format(), and PATH().

◆ aperture_width

double DSN::PATH::aperture_width

private

Definition at line 666 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPATH(), Format(), DSN::SPECCTRA_DB::makeTRACK(), PATH(), and SetAperture().

◆ layer_id

std::string DSN::PATH::layer_id

private

Definition at line 665 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPATH(), Format(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makeTRACK(), and SetLayerId().

◆ parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 294 of file specctra.h.

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

◆ points

std::vector<POINT> DSN::PATH::points

private

Definition at line 668 of file specctra.h.

Referenced by AppendPoint(), DSN::SPECCTRA_DB::doPATH(), Format(), GetPoints(), and DSN::SPECCTRA_DB::makeTRACK().

◆ sf

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 291 of file specctra.h.

Referenced by makeHash().

◆ type

DSN_T DSN::ELEM::type

protectedinherited

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

◆ PATH()

Member Function Documentation

◆ AppendPoint()

◆ Format()

◆ FormatContents()

◆ GetPoints()

◆ GetUnits()

◆ makeHash()

◆ Name()

◆ SetAperture()

◆ SetLayerId()

◆ SetParent()

◆ Type()

Friends And Related Symbol Documentation

◆ SPECCTRA_DB

Member Data Documentation

◆ aperture_type

◆ aperture_width

◆ layer_id

◆ parent

◆ points

◆ sf

◆ type