KiCad PCB EDA Suite
DSN::QARC Class Reference

#include <specctra.h>

Inheritance diagram for DSN::QARC:
DSN::ELEM

Public Member Functions

 QARC (ELEM *aParent)
 
void Format (OUTPUTFORMATTER *out, int nestLevel) override
 Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
void SetLayerId (const char *aLayerId)
 
void SetStart (const POINT &aStart)
 
void SetEnd (const POINT &aEnd)
 
void SetCenter (const POINT &aCenter)
 
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
 
POINT vertex [3]
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 782 of file specctra.h.

Constructor & Destructor Documentation

◆ QARC()

DSN::QARC::QARC ( ELEM aParent)
inline

Definition at line 785 of file specctra.h.

785  :
786  ELEM( T_qarc, aParent )
787  {
788  aperture_width = 0.0;
789  }
double aperture_width
Definition: specctra.h:838
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749

References aperture_width.

Member Function Documentation

◆ Format()

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

792  {
793  const char* newline = nestLevel ? "\n" : "";
794 
795  const char* quote = out->GetQuoteChar( layer_id.c_str() );
796  out->Print( nestLevel, "(%s %s%s%s %.6g", Name(), quote, layer_id.c_str(), quote,
797  aperture_width );
798 
799  for( int i=0; i<3; ++i )
800  out->Print( 0, " %.6g %.6g", vertex[i].x, vertex[i].y );
801 
802  out->Print( 0, ")%s", newline );
803  }
POINT vertex[3]
Definition: specctra.h:839
double aperture_width
Definition: specctra.h:838
double y
Definition: specctra.h:105
const char * Name() const
Definition: specctra.cpp:3760
double x
Definition: specctra.h:104
std::string layer_id
Definition: specctra.h:837
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
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426

References aperture_width, OUTPUTFORMATTER::GetQuoteChar(), layer_id, DSN::ELEM::Name(), OUTPUTFORMATTER::Print(), vertex, DSN::POINT::x, and DSN::POINT::y.

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

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

◆ SetCenter()

void DSN::QARC::SetCenter ( const POINT aCenter)
inline

Definition at line 826 of file specctra.h.

827  {
828  vertex[2] = aCenter;
829 
830  // no -0.0 on the printouts!
831  vertex[2].FixNegativeZero();
832  }
void FixNegativeZero()
Change negative zero to positive zero in the IEEE floating point storage format.
Definition: specctra.h:144
POINT vertex[3]
Definition: specctra.h:839

References DSN::POINT::FixNegativeZero(), and vertex.

◆ SetEnd()

void DSN::QARC::SetEnd ( const POINT aEnd)
inline

Definition at line 818 of file specctra.h.

819  {
820  vertex[1] = aEnd;
821 
822  // no -0.0 on the printouts!
823  vertex[1].FixNegativeZero();
824  }
void FixNegativeZero()
Change negative zero to positive zero in the IEEE floating point storage format.
Definition: specctra.h:144
POINT vertex[3]
Definition: specctra.h:839

References DSN::POINT::FixNegativeZero(), and vertex.

◆ SetLayerId()

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

Definition at line 805 of file specctra.h.

806  {
807  layer_id = aLayerId;
808  }
std::string layer_id
Definition: specctra.h:837

References layer_id.

◆ SetParent()

◆ SetStart()

void DSN::QARC::SetStart ( const POINT aStart)
inline

Definition at line 810 of file specctra.h.

811  {
812  vertex[0] = aStart;
813 
814  // no -0.0 on the printouts!
815  vertex[0].FixNegativeZero();
816  }
void FixNegativeZero()
Change negative zero to positive zero in the IEEE floating point storage format.
Definition: specctra.h:144
POINT vertex[3]
Definition: specctra.h:839

References DSN::POINT::FixNegativeZero(), and vertex.

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 835 of file specctra.h.

Member Data Documentation

◆ aperture_width

double DSN::QARC::aperture_width
private

Definition at line 838 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doQARC(), Format(), and QARC().

◆ layer_id

std::string DSN::QARC::layer_id
private

Definition at line 837 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doQARC(), Format(), and SetLayerId().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 276 of file specctra.h.

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

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

◆ vertex

POINT DSN::QARC::vertex[3]
private

Definition at line 839 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doQARC(), Format(), SetCenter(), SetEnd(), and SetStart().


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