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
 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
 
POINT point0
 one of two opposite corners More...
 
POINT point1
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 438 of file specctra.h.

Constructor & Destructor Documentation

◆ RECTANGLE()

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

Definition at line 442 of file specctra.h.

442  :
443  ELEM( T_rect, aParent )
444  {
445  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749

Member Function Documentation

◆ Format()

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

465  {
466  const char* newline = nestLevel ? "\n" : "";
467 
468  const char* quote = out->GetQuoteChar( layer_id.c_str() );
469 
470  out->Print( nestLevel, "(%s %s%s%s %.6g %.6g %.6g %.6g)%s",
471  Name(),
472  quote, layer_id.c_str(), quote,
473  point0.x, point0.y,
474  point1.x, point1.y,
475  newline );
476  }
std::string layer_id
Definition: specctra.h:481
double y
Definition: specctra.h:105
const char * Name() const
Definition: specctra.cpp:3760
double x
Definition: specctra.h:104
POINT point0
one of two opposite corners
Definition: specctra.h:483
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
POINT point1
Definition: specctra.h:484
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426

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

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

◆ GetEnd()

POINT DSN::RECTANGLE::GetEnd ( )
inline

Definition at line 462 of file specctra.h.

462 { return point1; }
POINT point1
Definition: specctra.h:484

References point1.

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

◆ GetOrigin()

POINT DSN::RECTANGLE::GetOrigin ( )
inline

Definition at line 461 of file specctra.h.

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

References point0.

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

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

◆ SetCorners()

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

Definition at line 452 of file specctra.h.

453  {
454  point0 = aPoint0;
456 
457  point1 = aPoint1;
459  }
void FixNegativeZero()
Change negative zero to positive zero in the IEEE floating point storage format.
Definition: specctra.h:144
POINT point0
one of two opposite corners
Definition: specctra.h:483
POINT point1
Definition: specctra.h:484

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

448  {
449  layer_id = aLayerId;
450  }
std::string layer_id
Definition: specctra.h:481

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

Member Data Documentation

◆ layer_id

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

Definition at line 481 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doRECTANGLE(), 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().

◆ point0

POINT DSN::RECTANGLE::point0
private

one of two opposite corners

Definition at line 483 of file specctra.h.

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

◆ point1

POINT DSN::RECTANGLE::point1
private

Definition at line 484 of file specctra.h.

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

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