KiCad PCB EDA Suite
DSN::RECTANGLE Class Reference

#include <specctra.h>

Inheritance diagram for DSN::RECTANGLE:
DSN::ELEM

Public Member Functions

 RECTANGLE (ELEM *aParent)
 
void SetLayerId (const char *aLayerId)
 
void SetCorners (const POINT &aPoint0, const POINT &aPoint1)
 
POINT GetOrigin ()
 
POINT GetEnd ()
 
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
 
POINT point0
 one of two opposite corners More...
 
POINT point1
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 435 of file specctra.h.

Constructor & Destructor Documentation

◆ RECTANGLE()

DSN::RECTANGLE::RECTANGLE ( ELEM aParent)
inline

Definition at line 446 of file specctra.h.

446  :
447  ELEM( T_rect, aParent )
448  {
449  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494

Member Function Documentation

◆ Format()

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

469  {
470  const char* newline = nestLevel ? "\n" : "";
471 
472  const char* quote = out->GetQuoteChar( layer_id.c_str() );
473 
474  out->Print( nestLevel, "(%s %s%s%s %.6g %.6g %.6g %.6g)%s",
475  Name(),
476  quote, layer_id.c_str(), quote,
477  point0.x, point0.y,
478  point1.x, point1.y,
479  newline );
480  }
std::string layer_id
Definition: specctra.h:439
double y
Definition: specctra.h:96
const char * Name() const
Definition: specctra.cpp:3505
double x
Definition: specctra.h:95
POINT point0
one of two opposite corners
Definition: specctra.h:441
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
POINT point1
Definition: specctra.h:442
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408

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

Referenced by DSN::BOUNDARY::Format(), and 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().

◆ GetEnd()

POINT DSN::RECTANGLE::GetEnd ( )
inline

Definition at line 466 of file specctra.h.

466 { return point1; }
POINT point1
Definition: specctra.h:442

References point1.

Referenced by DSN::BOUNDARY::GetCorners().

◆ GetOrigin()

POINT DSN::RECTANGLE::GetOrigin ( )
inline

Definition at line 465 of file specctra.h.

465 { return point0; }
POINT point0
one of two opposite corners
Definition: specctra.h:441

References point0.

Referenced by DSN::BOUNDARY::GetCorners().

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

◆ SetCorners()

void DSN::RECTANGLE::SetCorners ( const POINT aPoint0,
const POINT aPoint1 
)
inline

Definition at line 456 of file specctra.h.

457  {
458  point0 = aPoint0;
460 
461  point1 = aPoint1;
463  }
void FixNegativeZero()
Function FixNegativeZero will change negative zero to positive zero in the IEEE floating point storag...
Definition: specctra.h:135
POINT point0
one of two opposite corners
Definition: specctra.h:441
POINT point1
Definition: specctra.h:442

References DSN::POINT::FixNegativeZero(), point0, and point1.

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

◆ SetLayerId()

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

Definition at line 451 of file specctra.h.

452  {
453  layer_id = aLayerId;
454  }
std::string layer_id
Definition: specctra.h:439

References layer_id.

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

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 437 of file specctra.h.

Member Data Documentation

◆ layer_id

std::string DSN::RECTANGLE::layer_id
private

Definition at line 439 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

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

◆ point0

POINT DSN::RECTANGLE::point0
private

one of two opposite corners

Definition at line 441 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doRECTANGLE(), Format(), GetOrigin(), and SetCorners().

◆ point1

POINT DSN::RECTANGLE::point1
private

Definition at line 442 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doRECTANGLE(), Format(), GetEnd(), and SetCorners().

◆ 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: