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

Constructor & Destructor Documentation

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

Definition at line 1460 of file specctra.h.

1460  :
1461  ELEM( T_grid, aParent )
1462  {
1463  grid_type = T_via;
1464  direction = T_NONE;
1465  dimension = 0.0;
1466  offset = 0.0;
1467  image_type= T_NONE;
1468  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3490
DSN_T direction
T_x | T_y | -1 for both.
Definition: specctra.h:1454
double offset
Definition: specctra.h:1455
DSN_T grid_type
T_via | T_wire | T_via_keepout | T_place | T_snap.
Definition: specctra.h:1452
DSN_T image_type
Definition: specctra.h:1456
double dimension
Definition: specctra.h:1453

Member Function Documentation

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

References DSN::GetTokenText(), and OUTPUTFORMATTER::Print().

1471  {
1472  out->Print( nestLevel, "(%s %s %.6g",
1473  Name(),
1475 
1476  if( grid_type == T_place )
1477  {
1478  if( image_type==T_smd || image_type==T_pin )
1479  out->Print( 0, " (image_type %s)", GetTokenText( image_type ) );
1480  }
1481  else
1482  {
1483  if( direction==T_x || direction==T_y )
1484  out->Print( 0, " (direction %s)", GetTokenText( direction ) );
1485  }
1486 
1487  if( offset != 0.0 )
1488  out->Print( 0, " (offset %.6g)", offset );
1489 
1490  out->Print( 0, ")\n");
1491  }
DSN_T direction
T_x | T_y | -1 for both.
Definition: specctra.h:1454
double offset
Definition: specctra.h:1455
DSN_T grid_type
T_via | T_wire | T_via_keepout | T_place | T_snap.
Definition: specctra.h:1452
DSN_T image_type
Definition: specctra.h:1456
const char * Name() const
Definition: specctra.cpp:3501
double dimension
Definition: specctra.h:1453
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,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
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 264 of file specctra.h.

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

265  {
266  // overridden in ELEM_HOLDER
267  }
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 3506 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().

3507 {
3508  if( parent )
3509  return parent->GetUnits();
3510 
3511  return &UNIT_RES::Default;
3512 }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3506
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.

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, &#39;(&#39;, and &#39;)&#39; from the mystring.
Definition: richio.cpp:500
static STRING_FORMATTER sf
Definition: specctra.h:222
void Clear()
Function Clear clears the buffer and empties the internal string.
Definition: richio.h:464
const char * DSN::ELEM::Name ( ) const
inherited

Definition at line 3501 of file specctra.cpp.

References DSN::ELEM::type.

Referenced by DSN::ELEM::Format(), and DSN::PLACE::Format().

3502 {
3503  return SPECCTRA_DB::TokenName( type );
3504 }
DSN_T type
Definition: specctra.h:199

Friends And Related Function Documentation

friend class SPECCTRA_DB
friend

Definition at line 1450 of file specctra.h.

Member Data Documentation

double DSN::GRID::dimension
private

Definition at line 1453 of file specctra.h.

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

DSN_T DSN::GRID::direction
private

T_x | T_y | -1 for both.

Definition at line 1454 of file specctra.h.

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

DSN_T DSN::GRID::grid_type
private

T_via | T_wire | T_via_keepout | T_place | T_snap.

Definition at line 1452 of file specctra.h.

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

DSN_T DSN::GRID::image_type
private

Definition at line 1456 of file specctra.h.

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

double DSN::GRID::offset
private

Definition at line 1455 of file specctra.h.

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

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

Referenced by DSN::ELEM_HOLDER::FindElem().

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 199 of file specctra.h.

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


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