KiCad PCB EDA Suite
DSN::PATH Class Reference

Class 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 throw ( IO_ERROR )
 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) throw ( IO_ERROR )
 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

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

Definition at line 576 of file specctra.h.

Constructor & Destructor Documentation

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

Definition at line 588 of file specctra.h.

References DSN::T_round.

588  :
589  ELEM( aType, aParent )
590  {
591  aperture_width = 0.0;
593  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3486
DSN_T aperture_type
Definition: specctra.h:584
double aperture_width
Definition: specctra.h:581

Member Function Documentation

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

Definition at line 595 of file specctra.h.

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

596  {
597  points.push_back( aPoint );
598  }
POINTS points
Definition: specctra.h:583
void DSN::PATH::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
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 612 of file specctra.h.

References aperture_width, max, DSN::ELEM::Name(), and DSN::T_square.

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

613  {
614  const char* newline = nestLevel ? "\n" : "";
615 
616  const char* quote = out->GetQuoteChar( layer_id.c_str() );
617 
618  const int RIGHTMARGIN = 70;
619  int perLine = out->Print( nestLevel, "(%s %s%s%s %.6g",
620  Name(),
621  quote, layer_id.c_str(), quote,
622  aperture_width );
623 
624  int wrapNest = std::max( nestLevel+1, 6 );
625  for( unsigned i=0; i<points.size(); ++i )
626  {
627  if( perLine > RIGHTMARGIN )
628  {
629  out->Print( 0, "\n" );
630  perLine = out->Print( wrapNest, "%s", "" );
631  }
632  else
633  perLine += out->Print( 0, " " );
634 
635  perLine += out->Print( 0, "%.6g %.6g", points[i].x, points[i].y );
636  }
637 
638  if( aperture_type == T_square )
639  {
640  out->Print( 0, "(aperture_type square)" );
641  }
642 
643  out->Print( 0, ")%s", newline );
644  }
std::string layer_id
Definition: specctra.h:580
const char * Name() const
Definition: specctra.cpp:3497
static const char * GetQuoteChar(const char *wrapee, const char *quote_char)
Function GetQuoteChar performs quote character need determination according to the Specctra DSN speci...
Definition: richio.cpp:331
DSN_T aperture_type
Definition: specctra.h:584
#define max(a, b)
Definition: auxiliary.h:86
POINTS points
Definition: specctra.h:583
double aperture_width
Definition: specctra.h:581
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
virtual void DSN::ELEM::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
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 264 of file specctra.h.

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

265  {
266  // overridden in ELEM_HOLDER
267  }
POINTS& DSN::PATH::GetPoints ( )
inline

Definition at line 600 of file specctra.h.

References points.

600 {return points; }
POINTS points
Definition: specctra.h:583
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 3502 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().

3503 {
3504  if( parent )
3505  return parent->GetUnits();
3506 
3507  return &UNIT_RES::Default;
3508 }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3502
ELEM * parent
Definition: specctra.h:200
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:414
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 212 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().

213  {
214  sf.Clear();
215  FormatContents( &sf, 0 );
216  sf.StripUseless();
217 
218  return sf.GetString();
219  }
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:264
const std::string & GetString()
Definition: richio.h:475
void StripUseless()
Function StripUseless removes whitespace, '(', and ')' from the mystring.
Definition: richio.cpp:504
static STRING_FORMATTER sf
Definition: specctra.h:222
void Clear()
Function Clear clears the buffer and empties the internal string.
Definition: richio.h:464
void DSN::PATH::SetAperture ( double  aWidth)
inline

Definition at line 607 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::makeIMAGE().

608  {
609  aperture_width = aWidth;
610  }
double aperture_width
Definition: specctra.h:581
void DSN::PATH::SetLayerId ( const char *  aLayerId)
inline

Definition at line 602 of file specctra.h.

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

603  {
604  layer_id = aLayerId;
605  }
std::string layer_id
Definition: specctra.h:580

Friends And Related Function Documentation

friend class SPECCTRA_DB
friend

Definition at line 578 of file specctra.h.

Member Data Documentation

DSN_T DSN::PATH::aperture_type
private

Definition at line 584 of file specctra.h.

double DSN::PATH::aperture_width
private

Definition at line 581 of file specctra.h.

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

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

Definition at line 580 of file specctra.h.

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

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

POINTS DSN::PATH::points
private

Definition at line 583 of file specctra.h.

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

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

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

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 199 of file specctra.h.

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


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