KiCad PCB EDA Suite
DSN::COPPER_PLANE Class Reference

Class 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 throw ( IO_ERROR )
 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) throw ( IO_ERROR )
 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

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

Definition at line 1322 of file specctra.h.

Constructor & Destructor Documentation

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

Definition at line 1327 of file specctra.h.

1327  :
1328  KEEPOUT( aParent, T_plane )
1329  {}
KEEPOUT(ELEM *aParent, DSN_T aType)
Constructor KEEPOUT requires a DSN_T because this class is used for T_place_keepout, T_via_keepout, T_wire_keepout, T_bend_keepout, and T_elongate_keepout as well as T_keepout.
Definition: specctra.h:912

Member Function Documentation

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

Definition at line 944 of file specctra.h.

References DSN::ELEM::SetParent().

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

945  {
946  aWindow->SetParent( this );
947  windows.push_back( aWindow );
948  }
WINDOWS windows
Definition: specctra.h:894
void DSN::KEEPOUT::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
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 950 of file specctra.h.

References DSN::ELEM::Format(), DSN::RULE::Format(), and DSN::ELEM::Name().

951  {
952  const char* newline = "\n";
953 
954  out->Print( nestLevel, "(%s", Name() );
955 
956  if( name.size() )
957  {
958  const char* quote = out->GetQuoteChar( name.c_str() );
959  out->Print( 0, " %s%s%s", quote, name.c_str(), quote );
960  }
961  else
962  out->Print( 0, " \"\"" ); // the zone with no name or net_code == 0
963 
964  if( sequence_number != -1 )
965  out->Print( 0, " (sequence_number %d)", sequence_number );
966 
967  if( shape )
968  {
969  out->Print( 0, " " );
970  shape->Format( out, 0 );
971  }
972 
973  if( rules )
974  {
975  out->Print( 0, "%s", newline );
976  newline = "";
977  rules->Format( out, nestLevel+1 );
978  }
979 
980  if( place_rules )
981  {
982  out->Print( 0, "%s", newline );
983  newline = "";
984  place_rules->Format( out, nestLevel+1 );
985  }
986 
987  if( windows.size() )
988  {
989  out->Print( 0, "%s", newline );
990  newline = "";
991 
992  for( WINDOWS::iterator i=windows.begin(); i!=windows.end(); ++i )
993  i->Format( out, nestLevel+1 );
994 
995  out->Print( nestLevel, ")\n" );
996  }
997  else
998  out->Print( 0, ")\n" );
999  }
ELEM * shape
Definition: specctra.h:903
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:505
RULE * rules
Definition: specctra.h:891
const char * Name() const
Definition: specctra.cpp:3497
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:3511
static const char * GetQuoteChar(const char *wrapee, const char *quote_char)
Function GetQuoteChar performs quote character need determination according to the Specctra DSN speci...
Definition: richio.cpp:331
int sequence_number
Definition: specctra.h:890
WINDOWS windows
Definition: specctra.h:894
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
std::string name
Definition: specctra.h:889
RULE * place_rules
Definition: specctra.h:892
virtual void DSN::ELEM::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
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::makeHash().

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

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

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

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, '(', and ')' from the mystring.
Definition: richio.cpp:504
static STRING_FORMATTER sf
Definition: specctra.h:222
void Clear()
Function Clear clears the buffer and empties the internal string.
Definition: richio.h:464
void DSN::KEEPOUT::SetShape ( ELEM aShape)
inlineinherited

Definition at line 929 of file specctra.h.

References DSN::ELEM::SetParent(), DSN::KEEPOUT::shape, DSN::T_circle, DSN::T_path, DSN::T_polygon, DSN::T_qarc, DSN::T_rect, and DSN::ELEM::Type().

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

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

Friends And Related Function Documentation

friend class SPECCTRA_DB
friend

Definition at line 1324 of file specctra.h.

Member Data Documentation

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

Definition at line 889 of file specctra.h.

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

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

RULE* DSN::KEEPOUT::place_rules
protectedinherited

Definition at line 892 of file specctra.h.

Referenced by DSN::KEEPOUT::~KEEPOUT().

RULE* DSN::KEEPOUT::rules
protectedinherited

Definition at line 891 of file specctra.h.

Referenced by DSN::KEEPOUT::~KEEPOUT().

int DSN::KEEPOUT::sequence_number
protectedinherited

Definition at line 890 of file specctra.h.

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

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

ELEM* DSN::KEEPOUT::shape
protectedinherited

Definition at line 903 of file specctra.h.

Referenced by DSN::KEEPOUT::SetShape(), and DSN::KEEPOUT::~KEEPOUT().

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 199 of file specctra.h.

Referenced by DSN::ELEM::Name(), and DSN::ELEM::Type().

WINDOWS DSN::KEEPOUT::windows
protectedinherited

Definition at line 894 of file specctra.h.


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