KiCad PCB EDA Suite
DSN::PATH Class Reference

PATH supports 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 char *aLayerId)
 
void SetAperture (double aWidth)
 
void Format (OUTPUTFORMATTER *out, int nestLevel) override
 Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
DSN_T Type () const
 
const char * Name () const
 
virtual UNIT_RESGetUnits () const
 Function GetUnits returns the units for this section. More...
 
virtual void FormatContents (OUTPUTFORMATTER *out, int nestLevel)
 Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
void SetParent (ELEM *aParent)
 

Protected Member Functions

std::string makeHash ()
 Function makeHash returns a string which uniquely represents this ELEM amoung other ELEMs of the same derived class as "this" one. More...
 

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

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

Definition at line 578 of file specctra.h.

Constructor & Destructor Documentation

◆ PATH()

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

Definition at line 590 of file specctra.h.

590  :
591  ELEM( aType, aParent )
592  {
593  aperture_width = 0.0;
594  aperture_type = T_round;
595  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
DSN_T aperture_type
Definition: specctra.h:586
double aperture_width
Definition: specctra.h:583

References aperture_type, and aperture_width.

Member Function Documentation

◆ AppendPoint()

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

Definition at line 597 of file specctra.h.

598  {
599  points.push_back( aPoint );
600  }
POINTS points
Definition: specctra.h:585

References points.

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

◆ Format()

void DSN::PATH::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
inlineoverridevirtual

Function Format writes 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 preceed the output with.
Exceptions
IO_ERRORif a system error writing the output, such as a full disk.

Reimplemented from DSN::ELEM.

Definition at line 614 of file specctra.h.

615  {
616  const char* newline = nestLevel ? "\n" : "";
617 
618  const char* quote = out->GetQuoteChar( layer_id.c_str() );
619 
620  const int RIGHTMARGIN = 70;
621  int perLine = out->Print( nestLevel, "(%s %s%s%s %.6g",
622  Name(),
623  quote, layer_id.c_str(), quote,
624  aperture_width );
625 
626  int wrapNest = std::max( nestLevel+1, 6 );
627 
628  for( unsigned i = 0; i < points.size(); ++i )
629  {
630  if( perLine > RIGHTMARGIN )
631  {
632  out->Print( 0, "\n" );
633  perLine = out->Print( wrapNest, "%s", "" );
634  }
635  else
636  {
637  perLine += out->Print( 0, " " );
638  }
639 
640  perLine += out->Print( 0, "%.6g %.6g", points[i].x, points[i].y );
641  }
642 
643  if( aperture_type == T_square )
644  {
645  out->Print( 0, "(aperture_type square)" );
646  }
647 
648  out->Print( 0, ")%s", newline );
649  }
const char * Name() const
Definition: specctra.cpp:3505
std::string layer_id
Definition: specctra.h:582
static const char * GetQuoteChar(const char *wrapee, const char *quote_char)
Perform quote character need determination according to the Specctra DSN specification.
Definition: richio.cpp:331
DSN_T aperture_type
Definition: specctra.h:586
POINTS points
Definition: specctra.h:585
double aperture_width
Definition: specctra.h:583
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408

References aperture_type, aperture_width, OUTPUTFORMATTER::GetQuoteChar(), layer_id, DSN::ELEM::Name(), points, and OUTPUTFORMATTER::Print().

Referenced by DSN::REGION::FormatContents().

◆ FormatContents()

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

Function FormatContents writes 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 preceed the output with.
Exceptions
IO_ERRORif a system error writing the output, such as a full disk.

Reimplemented in DSN::WAS_IS, DSN::ROUTE, DSN::HISTORY, DSN::WIRING, DSN::NETWORK, DSN::TOPOLOGY, DSN::LIBRARY, DSN::PADSTACK, DSN::IMAGE, DSN::PLACEMENT, DSN::COMPONENT, DSN::STRUCTURE, DSN::STRUCTURE_OUT, DSN::REGION, DSN::CLASS_CLASS, DSN::CLASSES, DSN::PARSER, and DSN::ELEM_HOLDER.

Definition at line 263 of file specctra.h.

264  {
265  // overridden in ELEM_HOLDER
266  }

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

◆ GetPoints()

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

Definition at line 602 of file specctra.h.

602 {return points; }
POINTS points
Definition: specctra.h:585

References points.

◆ GetUnits()

UNIT_RES * DSN::ELEM::GetUnits ( ) const
virtualinherited

Function GetUnits returns the units for this section.

Derived classes may override this to check for section specific overrides.

Returns
UNIT_RES* - from a local or parent scope

Reimplemented in DSN::ROUTE, DSN::PCB, DSN::WIRING, DSN::LIBRARY, DSN::PADSTACK, DSN::IMAGE, DSN::PLACEMENT, and DSN::STRUCTURE.

Definition at line 3510 of file specctra.cpp.

3511 {
3512  if( parent )
3513  return parent->GetUnits();
3514 
3515  return &UNIT_RES::Default;
3516 }
ELEM * parent
Definition: specctra.h:199
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:413
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3510

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

Function makeHash returns a string which uniquely represents this ELEM amoung other ELEMs of the same derived class as "this" one.

It is not useable 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 211 of file specctra.h.

212  {
213  sf.Clear();
214  FormatContents( &sf, 0 );
215  sf.StripUseless();
216 
217  return sf.GetString();
218  }
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECC...
Definition: specctra.h:263
const std::string & GetString()
Definition: richio.h:435
void StripUseless()
Removes whitespace, '(', and ')' from the string.
Definition: richio.cpp:494
static STRING_FORMATTER sf
Definition: specctra.h:221
void Clear()
Clear the buffer and empties the internal string.
Definition: richio.h:425

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

◆ Name()

◆ SetAperture()

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

Definition at line 609 of file specctra.h.

610  {
611  aperture_width = aWidth;
612  }
double aperture_width
Definition: specctra.h:583

References aperture_width.

◆ SetLayerId()

void DSN::PATH::SetLayerId ( const char *  aLayerId)
inline

Definition at line 604 of file specctra.h.

605  {
606  layer_id = aLayerId;
607  }
std::string layer_id
Definition: specctra.h:582

References layer_id.

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

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 580 of file specctra.h.

Member Data Documentation

◆ aperture_type

DSN_T DSN::PATH::aperture_type
private

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

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

◆ points

POINTS DSN::PATH::points
private

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

Referenced by DSN::ELEM::makeHash().

◆ type

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 198 of file specctra.h.

Referenced by DSN::UNIT_RES::Format(), DSN::ELEM::Name(), and DSN::ELEM::Type().


The documentation for this class was generated from the following file: