KiCad PCB EDA Suite
DSN::COPPER_PLANE Class Reference

COPPER_PLANE corresponds to a <plane_descriptor> in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::COPPER_PLANE:
DSN::KEEPOUT DSN::ELEM

Public Member Functions

 COPPER_PLANE (ELEM *aParent)
 
void SetShape (ELEM *aShape)
 
void AddWindow (WINDOW *aWindow)
 
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

std::string name
 
int sequence_number
 
RULErules
 
RULEplace_rules
 
WINDOWS windows
 
ELEMshape
 
DSN_T type
 
ELEMparent
 

Static Protected Attributes

static STRING_FORMATTER sf
 

Friends

class SPECCTRA_DB
 

Detailed Description

COPPER_PLANE corresponds to a <plane_descriptor> in the specctra dsn spec.

Definition at line 1324 of file specctra.h.

Constructor & Destructor Documentation

◆ COPPER_PLANE()

DSN::COPPER_PLANE::COPPER_PLANE ( ELEM aParent)
inline

Definition at line 1329 of file specctra.h.

1329  :
1330  KEEPOUT( aParent, T_plane )
1331  {}
KEEPOUT(ELEM *aParent, DSN_T aType)
Constructor KEEPOUT requires a DSN_T because this class is used for T_place_keepout,...
Definition: specctra.h:911

Member Function Documentation

◆ AddWindow()

void DSN::KEEPOUT::AddWindow ( WINDOW aWindow)
inlineinherited

Definition at line 943 of file specctra.h.

944  {
945  aWindow->SetParent( this );
946  windows.push_back( aWindow );
947  }
WINDOWS windows
Definition: specctra.h:893

References DSN::ELEM::SetParent(), and DSN::KEEPOUT::windows.

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

◆ Format()

void DSN::KEEPOUT::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
inlineoverridevirtualinherited

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

950  {
951  const char* newline = "\n";
952 
953  out->Print( nestLevel, "(%s", Name() );
954 
955  if( name.size() )
956  {
957  const char* quote = out->GetQuoteChar( name.c_str() );
958  out->Print( 0, " %s%s%s", quote, name.c_str(), quote );
959  }
960  // Could be not needed:
961 #if 1
962  else
963  out->Print( 0, " \"\"" ); // the zone with no name or net_code == 0
964 #endif
965 
966  if( sequence_number != -1 )
967  out->Print( 0, " (sequence_number %d)", sequence_number );
968 
969  if( shape )
970  {
971  out->Print( 0, " " );
972  shape->Format( out, 0 );
973  }
974 
975  if( rules )
976  {
977  out->Print( 0, "%s", newline );
978  newline = "";
979  rules->Format( out, nestLevel+1 );
980  }
981 
982  if( place_rules )
983  {
984  out->Print( 0, "%s", newline );
985  newline = "";
986  place_rules->Format( out, nestLevel+1 );
987  }
988 
989  if( windows.size() )
990  {
991  out->Print( 0, "%s", newline );
992  newline = "";
993 
994  for( WINDOWS::iterator i=windows.begin(); i!=windows.end(); ++i )
995  i->Format( out, nestLevel+1 );
996 
997  out->Print( nestLevel, ")\n" );
998  }
999  else
1000  out->Print( 0, ")\n" );
1001  }
ELEM * shape
Definition: specctra.h:902
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:504
RULE * rules
Definition: specctra.h:890
virtual void Format(OUTPUTFORMATTER *out, int nestLevel)
Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN f...
Definition: specctra.cpp:3519
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:331
int sequence_number
Definition: specctra.h:889
WINDOWS windows
Definition: specctra.h:893
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408
std::string name
Definition: specctra.h:888
RULE * place_rules
Definition: specctra.h:891

References DSN::ELEM::Format(), DSN::RULE::Format(), OUTPUTFORMATTER::GetQuoteChar(), DSN::ELEM::Name(), DSN::KEEPOUT::name, DSN::KEEPOUT::place_rules, OUTPUTFORMATTER::Print(), DSN::KEEPOUT::rules, DSN::KEEPOUT::sequence_number, DSN::KEEPOUT::shape, and DSN::KEEPOUT::windows.

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

◆ SetShape()

void DSN::KEEPOUT::SetShape ( ELEM aShape)
inlineinherited

Definition at line 928 of file specctra.h.

929  {
930  delete shape;
931  shape = aShape;
932 
933  if( aShape )
934  {
935  wxASSERT(aShape->Type()==T_rect || aShape->Type()==T_circle
936  || aShape->Type()==T_qarc || aShape->Type()==T_path
937  || aShape->Type()==T_polygon);
938 
939  aShape->SetParent( this );
940  }
941  }
ELEM * shape
Definition: specctra.h:902
void SetParent(ELEM *aParent)
Definition: specctra.h:268

References DSN::ELEM::SetParent(), DSN::KEEPOUT::shape, and DSN::ELEM::Type().

Referenced by DSN::SPECCTRA_DB::fillBOUNDARY(), DSN::SPECCTRA_DB::FromBOARD(), and DSN::SPECCTRA_DB::makeIMAGE().

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1326 of file specctra.h.

Member Data Documentation

◆ name

std::string DSN::KEEPOUT::name
protectedinherited

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

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

◆ place_rules

RULE* DSN::KEEPOUT::place_rules
protectedinherited

◆ rules

RULE* DSN::KEEPOUT::rules
protectedinherited

◆ sequence_number

int DSN::KEEPOUT::sequence_number
protectedinherited

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

◆ shape

ELEM* DSN::KEEPOUT::shape
protectedinherited

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

◆ windows

WINDOWS DSN::KEEPOUT::windows
protectedinherited

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