KiCad PCB EDA Suite
DSN::KEEPOUT Class Reference

KEEPOUT is used for <keepout_descriptor> and <plane_descriptor>. More...

#include <specctra.h>

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

Public Member Functions

 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. More...
 
 ~KEEPOUT ()
 
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

KEEPOUT is used for <keepout_descriptor> and <plane_descriptor>.

Definition at line 895 of file specctra.h.

Constructor & Destructor Documentation

◆ KEEPOUT()

DSN::KEEPOUT::KEEPOUT ( ELEM aParent,
DSN_T  aType 
)
inline

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 at line 923 of file specctra.h.

923  :
924  ELEM( aType, aParent )
925  {
926  rules = 0;
927  place_rules = 0;
928  shape = 0;
929 
930  sequence_number = -1;
931  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
ELEM * shape
Definition: specctra.h:914
RULE * rules
Definition: specctra.h:902
int sequence_number
Definition: specctra.h:901
RULE * place_rules
Definition: specctra.h:903

References place_rules, rules, sequence_number, and shape.

◆ ~KEEPOUT()

DSN::KEEPOUT::~KEEPOUT ( )
inline

Definition at line 933 of file specctra.h.

934  {
935  delete rules;
936  delete place_rules;
937  delete shape;
938  }
ELEM * shape
Definition: specctra.h:914
RULE * rules
Definition: specctra.h:902
RULE * place_rules
Definition: specctra.h:903

References place_rules, rules, and shape.

Member Function Documentation

◆ AddWindow()

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

Definition at line 957 of file specctra.h.

958  {
959  aWindow->SetParent( this );
960  windows.push_back( aWindow );
961  }
WINDOWS windows
Definition: specctra.h:905

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

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

◆ Format()

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

964  {
965  const char* newline = "\n";
966 
967  out->Print( nestLevel, "(%s", Name() );
968 
969  if( name.size() )
970  {
971  const char* quote = out->GetQuoteChar( name.c_str() );
972  out->Print( 0, " %s%s%s", quote, name.c_str(), quote );
973  }
974  // Could be not needed:
975 #if 1
976  else
977  out->Print( 0, " \"\"" ); // the zone with no name or net_code == 0
978 #endif
979 
980  if( sequence_number != -1 )
981  out->Print( 0, " (sequence_number %d)", sequence_number );
982 
983  if( shape )
984  {
985  out->Print( 0, " " );
986  shape->Format( out, 0 );
987  }
988 
989  if( rules )
990  {
991  out->Print( 0, "%s", newline );
992  newline = "";
993  rules->Format( out, nestLevel+1 );
994  }
995 
996  if( place_rules )
997  {
998  out->Print( 0, "%s", newline );
999  newline = "";
1000  place_rules->Format( out, nestLevel+1 );
1001  }
1002 
1003  if( windows.size() )
1004  {
1005  out->Print( 0, "%s", newline );
1006  newline = "";
1007 
1008  for( WINDOWS::iterator i = windows.begin(); i != windows.end(); ++i )
1009  i->Format( out, nestLevel+1 );
1010 
1011  out->Print( nestLevel, ")\n" );
1012  }
1013  else
1014  out->Print( 0, ")\n" );
1015  }
ELEM * shape
Definition: specctra.h:914
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:501
RULE * rules
Definition: specctra.h:902
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:901
WINDOWS windows
Definition: specctra.h:905
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:900
RULE * place_rules
Definition: specctra.h:903

References DSN::ELEM::Format(), DSN::RULE::Format(), OUTPUTFORMATTER::GetQuoteChar(), DSN::ELEM::Name(), name, place_rules, OUTPUTFORMATTER::Print(), rules, sequence_number, shape, and 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)
inline

Definition at line 940 of file specctra.h.

941  {
942  delete shape;
943  shape = aShape;
944 
945  if( aShape )
946  {
947  wxASSERT( aShape->Type()==T_rect
948  || aShape->Type()==T_circle
949  || aShape->Type()==T_qarc
950  || aShape->Type()==T_path
951  || aShape->Type()==T_polygon);
952 
953  aShape->SetParent( this );
954  }
955  }
ELEM * shape
Definition: specctra.h:914
void SetParent(ELEM *aParent)
Definition: specctra.h:268

References DSN::ELEM::SetParent(), 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 897 of file specctra.h.

Member Data Documentation

◆ name

std::string DSN::KEEPOUT::name
protected

Definition at line 900 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doKEEPOUT(), Format(), and DSN::SPECCTRA_DB::FromBOARD().

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

Definition at line 903 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doKEEPOUT(), Format(), KEEPOUT(), and ~KEEPOUT().

◆ rules

RULE* DSN::KEEPOUT::rules
protected

Definition at line 902 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doKEEPOUT(), Format(), KEEPOUT(), and ~KEEPOUT().

◆ sequence_number

int DSN::KEEPOUT::sequence_number
protected

Definition at line 901 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doKEEPOUT(), Format(), and KEEPOUT().

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

Definition at line 914 of file specctra.h.

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

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

Definition at line 905 of file specctra.h.

Referenced by AddWindow(), DSN::SPECCTRA_DB::doKEEPOUT(), and Format().


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