KiCad PCB EDA Suite
Loading...
Searching...
No Matches
DSN::PATH Class Reference

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

#include <specctra.h>

Inheritance diagram for DSN::PATH:
DSN::ELEM

Public Member Functions

 PATH (ELEM *aParent, DSN_T aType=T_path)
 
void AppendPoint (const POINT &aPoint)
 
POINTSGetPoints ()
 
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_RESGetUnits () 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
 
ELEMparent
 

Static Protected Attributes

static STRING_FORMATTER sf
 

Private Attributes

std::string layer_id
 
double aperture_width
 
POINTS 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 587 of file specctra.h.

Constructor & Destructor Documentation

◆ PATH()

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

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

◆ 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
outThe formatter to write to.
nestLevelA multiple of the number of spaces to precede the output with.
Exceptions
IO_ERRORif a system error writing the output, such as a full disk.

Reimplemented from DSN::ELEM.

Definition at line 615 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
outThe formatter to write to.
nestLevelA multiple of the number of spaces to precede the output with.
Exceptions
IO_ERRORif 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 247 of file specctra.h.

Referenced by Format(), and makeHash().

◆ GetPoints()

POINTS & DSN::PATH::GetPoints ( )
inline

Definition at line 603 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 3773 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 268 of file specctra.h.

References FormatContents(), and sf.

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

◆ Name()

◆ SetAperture()

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

Definition at line 610 of file specctra.h.

References aperture_width.

◆ SetLayerId()

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

Definition at line 605 of file specctra.h.

References layer_id.

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

◆ SetParent()

◆ Type()

Friends And Related Symbol Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

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

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

◆ aperture_width

double DSN::PATH::aperture_width
private

◆ layer_id

std::string DSN::PATH::layer_id
private

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 281 of file specctra.h.

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

◆ points

POINTS DSN::PATH::points
private

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 278 of file specctra.h.

Referenced by makeHash().

◆ type

DSN_T DSN::ELEM::type
protectedinherited

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