KiCad PCB EDA Suite
DSN::BOUNDARY Class Reference

#include <specctra.h>

Inheritance diagram for DSN::BOUNDARY:
DSN::ELEM

Public Member Functions

 BOUNDARY (ELEM *aParent, DSN_T aType=T_boundary)
 
 ~BOUNDARY ()
 
void GetCorners (std::vector< double > &aBuffer)
 GetCorners fills aBuffer with a list of coordinates (x,y) of corners. More...
 
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

PATHS paths
 
RECTANGLErectangle
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 654 of file specctra.h.

Constructor & Destructor Documentation

◆ BOUNDARY()

DSN::BOUNDARY::BOUNDARY ( ELEM aParent,
DSN_T  aType = T_boundary 
)
inline

Definition at line 665 of file specctra.h.

665  :
666  ELEM( aType, aParent )
667  {
668  rectangle = 0;
669  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
RECTANGLE * rectangle
Definition: specctra.h:660

References rectangle.

◆ ~BOUNDARY()

DSN::BOUNDARY::~BOUNDARY ( )
inline

Definition at line 671 of file specctra.h.

672  {
673  delete rectangle;
674  }
RECTANGLE * rectangle
Definition: specctra.h:660

References rectangle.

Member Function Documentation

◆ Format()

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

712  {
713  out->Print( nestLevel, "(%s\n", Name() );
714 
715  if( rectangle )
716  rectangle->Format( out, nestLevel+1 );
717  else
718  {
719  for( PATHS::iterator i = paths.begin(); i != paths.end(); ++i )
720  i->Format( out, nestLevel+1 );
721  }
722 
723  out->Print( nestLevel, ")\n" );
724  }
const char * Name() const
Definition: specctra.cpp:3505
void Format(OUTPUTFORMATTER *out, int nestLevel) override
Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN f...
Definition: specctra.h:468
RECTANGLE * rectangle
Definition: specctra.h:660
PATHS paths
Definition: specctra.h:659
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408

References DSN::RECTANGLE::Format(), DSN::ELEM::Name(), paths, OUTPUTFORMATTER::Print(), and rectangle.

Referenced by DSN::STRUCTURE::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().

◆ GetCorners()

void DSN::BOUNDARY::GetCorners ( std::vector< double > &  aBuffer)
inline

GetCorners fills aBuffer with a list of coordinates (x,y) of corners.

Definition at line 679 of file specctra.h.

680  {
681  if( rectangle )
682  {
683  aBuffer.push_back( rectangle->GetOrigin().x );
684  aBuffer.push_back( rectangle->GetOrigin().y );
685 
686  aBuffer.push_back( rectangle->GetOrigin().x );
687  aBuffer.push_back( rectangle->GetEnd().y );
688 
689  aBuffer.push_back( rectangle->GetEnd().x );
690  aBuffer.push_back( rectangle->GetEnd().y );
691 
692  aBuffer.push_back( rectangle->GetEnd().x );
693  aBuffer.push_back( rectangle->GetOrigin().y );
694  }
695  else
696  {
697  for( PATHS::iterator i=paths.begin(); i!=paths.end(); ++i )
698  {
699  POINTS& plist = i->GetPoints();
700 
701  for( unsigned jj = 0; jj < plist.size(); jj++ )
702  {
703  aBuffer.push_back( plist[jj].x );
704  aBuffer.push_back( plist[jj].y );
705  }
706  }
707  }
708  }
double y
Definition: specctra.h:96
double x
Definition: specctra.h:95
RECTANGLE * rectangle
Definition: specctra.h:660
POINT GetEnd()
Definition: specctra.h:466
std::vector< POINT > POINTS
Definition: specctra.h:158
PATHS paths
Definition: specctra.h:659
POINT GetOrigin()
Definition: specctra.h:465

References DSN::RECTANGLE::GetEnd(), DSN::RECTANGLE::GetOrigin(), paths, rectangle, DSN::POINT::x, and DSN::POINT::y.

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

Member Data Documentation

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

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

◆ paths

PATHS DSN::BOUNDARY::paths
private

◆ rectangle

RECTANGLE* DSN::BOUNDARY::rectangle
private

Definition at line 660 of file specctra.h.

Referenced by BOUNDARY(), DSN::SPECCTRA_DB::doBOUNDARY(), Format(), GetCorners(), and ~BOUNDARY().

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