KiCad PCB EDA Suite
DSN::GRID Class Reference

#include <specctra.h>

Inheritance diagram for DSN::GRID:
DSN::ELEM

Public Member Functions

 GRID (ELEM *aParent)
 
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

DSN_T grid_type
 T_via | T_wire | T_via_keepout | T_place | T_snap. More...
 
double dimension
 
DSN_T direction
 T_x | T_y | -1 for both. More...
 
double offset
 
DSN_T image_type
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 1463 of file specctra.h.

Constructor & Destructor Documentation

◆ GRID()

DSN::GRID::GRID ( ELEM aParent)
inline

Definition at line 1475 of file specctra.h.

1475  :
1476  ELEM( T_grid, aParent )
1477  {
1478  grid_type = T_via;
1479  direction = T_NONE;
1480  dimension = 0.0;
1481  offset = 0.0;
1482  image_type = T_NONE;
1483  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
DSN_T direction
T_x | T_y | -1 for both.
Definition: specctra.h:1469
double offset
Definition: specctra.h:1470
DSN_T grid_type
T_via | T_wire | T_via_keepout | T_place | T_snap.
Definition: specctra.h:1467
DSN_T image_type
Definition: specctra.h:1471
double dimension
Definition: specctra.h:1468

References dimension, direction, grid_type, image_type, and offset.

Member Function Documentation

◆ Format()

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

1486  {
1487  out->Print( nestLevel, "(%s %s %.6g",
1488  Name(),
1490 
1491  if( grid_type == T_place )
1492  {
1493  if( image_type==T_smd || image_type==T_pin )
1494  out->Print( 0, " (image_type %s)", GetTokenText( image_type ) );
1495  }
1496  else
1497  {
1498  if( direction==T_x || direction==T_y )
1499  out->Print( 0, " (direction %s)", GetTokenText( direction ) );
1500  }
1501 
1502  if( offset != 0.0 )
1503  out->Print( 0, " (offset %.6g)", offset );
1504 
1505  out->Print( 0, ")\n");
1506  }
DSN_T direction
T_x | T_y | -1 for both.
Definition: specctra.h:1469
double offset
Definition: specctra.h:1470
const char * Name() const
Definition: specctra.cpp:3505
DSN_T grid_type
T_via | T_wire | T_via_keepout | T_place | T_snap.
Definition: specctra.h:1467
DSN_T image_type
Definition: specctra.h:1471
double dimension
Definition: specctra.h:1468
const char * GetTokenText(T aTok)
Function GetTokenText is in the DSN namespace and returns the C string representing a SPECCTRA_DB::ke...
Definition: specctra.cpp:69
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408

References dimension, direction, DSN::GetTokenText(), grid_type, image_type, DSN::ELEM::Name(), offset, and OUTPUTFORMATTER::Print().

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

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

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1465 of file specctra.h.

Member Data Documentation

◆ dimension

double DSN::GRID::dimension
private

Definition at line 1468 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doGRID(), Format(), and GRID().

◆ direction

DSN_T DSN::GRID::direction
private

T_x | T_y | -1 for both.

Definition at line 1469 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doGRID(), Format(), and GRID().

◆ grid_type

DSN_T DSN::GRID::grid_type
private

T_via | T_wire | T_via_keepout | T_place | T_snap.

Definition at line 1467 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doGRID(), Format(), and GRID().

◆ image_type

DSN_T DSN::GRID::image_type
private

Definition at line 1471 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doGRID(), Format(), and GRID().

◆ offset

double DSN::GRID::offset
private

Definition at line 1470 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doGRID(), Format(), and GRID().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

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

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