KiCad PCB EDA Suite
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 char *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. More...
 
DSN_T Type () const
 
const char * Name () const
 
virtual UNIT_RESGetUnits () const
 Return the units for this section. More...
 
virtual void FormatContents (OUTPUTFORMATTER *out, int nestLevel)
 Write 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 ()
 Return a string which uniquely represents this ELEM among 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

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

Definition at line 582 of file specctra.h.

Constructor & Destructor Documentation

◆ PATH()

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

Definition at line 586 of file specctra.h.

586  :
587  ELEM( aType, aParent )
588  {
589  aperture_width = 0.0;
590  aperture_type = T_round;
591  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749
DSN_T aperture_type
Definition: specctra.h:654
double aperture_width
Definition: specctra.h:651

References aperture_type, and aperture_width.

Member Function Documentation

◆ AppendPoint()

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

Definition at line 593 of file specctra.h.

594  {
595  points.push_back( aPoint );
596  }
POINTS points
Definition: specctra.h:653

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

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 610 of file specctra.h.

611  {
612  const char* newline = nestLevel ? "\n" : "";
613 
614  const char* quote = out->GetQuoteChar( layer_id.c_str() );
615 
616  const int RIGHTMARGIN = 70;
617  int perLine = out->Print( nestLevel, "(%s %s%s%s %.6g",
618  Name(),
619  quote, layer_id.c_str(), quote,
620  aperture_width );
621 
622  int wrapNest = std::max( nestLevel+1, 6 );
623 
624  for( unsigned i = 0; i < points.size(); ++i )
625  {
626  if( perLine > RIGHTMARGIN )
627  {
628  out->Print( 0, "\n" );
629  perLine = out->Print( wrapNest, "%s", "" );
630  }
631  else
632  {
633  perLine += out->Print( 0, " " );
634  }
635 
636  perLine += out->Print( 0, "%.6g %.6g", points[i].x, points[i].y );
637  }
638 
639  if( aperture_type == T_square )
640  {
641  out->Print( 0, "(aperture_type square)" );
642  }
643 
644  out->Print( 0, ")%s", newline );
645  }
const char * Name() const
Definition: specctra.cpp:3760
std::string layer_id
Definition: specctra.h:650
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:348
DSN_T aperture_type
Definition: specctra.h:654
POINTS points
Definition: specctra.h:653
double aperture_width
Definition: specctra.h:651
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426

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

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::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 242 of file specctra.h.

243  {
244  // overridden in ELEM_HOLDER
245  }

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

◆ GetPoints()

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

Definition at line 598 of file specctra.h.

598 {return points; }
POINTS points
Definition: specctra.h:653

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

Definition at line 3765 of file specctra.cpp.

3766 {
3767  if( parent )
3768  return parent->GetUnits();
3769 
3770  return &UNIT_RES::Default;
3771 }
ELEM * parent
Definition: specctra.h:276
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:410
virtual UNIT_RES * GetUnits() const
Return the units for this section.
Definition: specctra.cpp:3765

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.

264  {
265  sf.Clear();
266  FormatContents( &sf, 0 );
267  sf.StripUseless();
268 
269  return sf.GetString();
270  }
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:242
const std::string & GetString()
Definition: richio.h:438
void StripUseless()
Removes whitespace, '(', and ')' from the string.
Definition: richio.cpp:512
static STRING_FORMATTER sf
Definition: specctra.h:273
void Clear()
Clear the buffer and empties the internal string.
Definition: richio.h:428

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 605 of file specctra.h.

606  {
607  aperture_width = aWidth;
608  }
double aperture_width
Definition: specctra.h:651

References aperture_width.

◆ SetLayerId()

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

Definition at line 600 of file specctra.h.

601  {
602  layer_id = aLayerId;
603  }
std::string layer_id
Definition: specctra.h:650

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 648 of file specctra.h.

Member Data Documentation

◆ aperture_type

DSN_T DSN::PATH::aperture_type
private

Definition at line 654 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 276 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 273 of file specctra.h.

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

◆ type

DSN_T DSN::ELEM::type
protectedinherited

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