KiCad PCB EDA Suite
DSN::KEEPOUT Class Reference

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

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

Used for <keepout_descriptor> and <plane_descriptor>.

Definition at line 905 of file specctra.h.

Constructor & Destructor Documentation

◆ KEEPOUT()

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

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

913 :
914 ELEM( aType, aParent )
915 {
916 rules = 0;
917 place_rules = 0;
918 shape = 0;
919
920 sequence_number = -1;
921 }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749
RULE * rules
Definition: specctra.h:1014
int sequence_number
Definition: specctra.h:1013
ELEM * shape
Definition: specctra.h:1026
RULE * place_rules
Definition: specctra.h:1015

References place_rules, rules, sequence_number, and shape.

◆ ~KEEPOUT()

DSN::KEEPOUT::~KEEPOUT ( )
inline

Definition at line 923 of file specctra.h.

924 {
925 delete rules;
926 delete place_rules;
927 delete shape;
928 }

References place_rules, rules, and shape.

Member Function Documentation

◆ AddWindow()

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

Definition at line 947 of file specctra.h.

948 {
949 aWindow->SetParent( this );
950 windows.push_back( aWindow );
951 }
WINDOWS windows
Definition: specctra.h:1017

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

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

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

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

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

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

◆ SetShape()

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

Definition at line 930 of file specctra.h.

931 {
932 delete shape;
933 shape = aShape;
934
935 if( aShape )
936 {
937 wxASSERT( aShape->Type()==T_rect
938 || aShape->Type()==T_circle
939 || aShape->Type()==T_qarc
940 || aShape->Type()==T_path
941 || aShape->Type()==T_polygon);
942
943 aShape->SetParent( this );
944 }
945 }

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

Member Data Documentation

◆ name

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

Definition at line 1012 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 276 of file specctra.h.

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

◆ place_rules

RULE* DSN::KEEPOUT::place_rules
protected

Definition at line 1015 of file specctra.h.

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

◆ rules

RULE* DSN::KEEPOUT::rules
protected

Definition at line 1014 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 1013 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 273 of file specctra.h.

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

◆ shape

ELEM* DSN::KEEPOUT::shape
protected

Definition at line 1026 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 275 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 1017 of file specctra.h.

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


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