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

PATHS paths
 
RECTANGLErectangle
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 660 of file specctra.h.

Constructor & Destructor Documentation

◆ BOUNDARY()

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

Definition at line 664 of file specctra.h.

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

References rectangle.

◆ ~BOUNDARY()

DSN::BOUNDARY::~BOUNDARY ( )
inline

Definition at line 670 of file specctra.h.

671 {
672 delete rectangle;
673 }

References rectangle.

Member Function Documentation

◆ Format()

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

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

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

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::ELEM_HOLDER, DSN::PARSER, DSN::CLASSES, DSN::CLASS_CLASS, DSN::REGION, DSN::STRUCTURE_OUT, DSN::STRUCTURE, DSN::COMPONENT, DSN::PLACEMENT, DSN::IMAGE, DSN::PADSTACK, DSN::LIBRARY, DSN::TOPOLOGY, DSN::NETWORK, DSN::WIRING, DSN::HISTORY, DSN::ROUTE, and DSN::WAS_IS.

Definition at line 242 of file specctra.h.

243 {
244 // overridden in ELEM_HOLDER
245 }

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

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

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

◆ 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::STRUCTURE, DSN::PLACEMENT, DSN::IMAGE, DSN::PADSTACK, DSN::LIBRARY, DSN::WIRING, DSN::PCB, and DSN::ROUTE.

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
virtual UNIT_RES * GetUnits() const
Return the units for this section.
Definition: specctra.cpp:3765
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:410

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 );
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
static STRING_FORMATTER sf
Definition: specctra.h:273
void StripUseless()
Removes whitespace, '(', and ')' from the string.
Definition: richio.cpp:519
const std::string & GetString()
Definition: richio.h:438
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()

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 726 of file specctra.h.

Member Data Documentation

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 276 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 730 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 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: