KiCad PCB EDA Suite
DSN::LAYER Class Reference

#include <specctra.h>

Inheritance diagram for DSN::LAYER:
DSN::ELEM

Public Member Functions

 LAYER (ELEM *aParent)
 
 ~LAYER ()
 
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

std::string name
 
DSN_T layer_type
 one of: T_signal, T_power, T_mixed, T_jumper More...
 
int direction
 [forbidden | high | medium | low | free | <positive_integer> | -1] More...
 
int cost
 
int cost_type
 T_length | T_way. More...
 
RULErules
 
STRINGS use_net
 
PROPERTIES properties
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 1201 of file specctra.h.

Constructor & Destructor Documentation

◆ LAYER()

DSN::LAYER::LAYER ( ELEM aParent)
inline

Definition at line 1204 of file specctra.h.

1204 :
1205 ELEM( T_layer, aParent )
1206 {
1207 layer_type = T_signal;
1208 direction = -1;
1209 cost = -1;
1210 cost_type = -1;
1211
1212 rules = 0;
1213 }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749
DSN_T layer_type
one of: T_signal, T_power, T_mixed, T_jumper
Definition: specctra.h:1279
RULE * rules
Definition: specctra.h:1285
int cost_type
T_length | T_way.
Definition: specctra.h:1284
int direction
[forbidden | high | medium | low | free | <positive_integer> | -1]
Definition: specctra.h:1280

References cost, cost_type, direction, layer_type, and rules.

◆ ~LAYER()

DSN::LAYER::~LAYER ( )
inline

Definition at line 1215 of file specctra.h.

1216 {
1217 delete rules;
1218 }

References rules.

Member Function Documentation

◆ Format()

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

1221 {
1222 const char* quote = out->GetQuoteChar( name.c_str() );
1223
1224 out->Print( nestLevel, "(%s %s%s%s\n", Name(), quote, name.c_str(), quote );
1225
1226 out->Print( nestLevel+1, "(type %s)\n", GetTokenText( layer_type ) );
1227
1228 if( properties.size() )
1229 {
1230 out->Print( nestLevel+1, "(property\n" );
1231
1232 for( PROPERTIES::iterator i = properties.begin(); i != properties.end(); ++i )
1233 {
1234 i->Format( out, nestLevel+2 );
1235 }
1236 out->Print( nestLevel+1, ")\n" );
1237 }
1238
1239 if( direction != -1 )
1240 out->Print( nestLevel+1, "(direction %s)\n", GetTokenText( (DSN_T)direction ) );
1241
1242 if( rules )
1243 rules->Format( out, nestLevel+1 );
1244
1245 if( cost != -1 )
1246 {
1247 if( cost < 0 )
1248 // positive integer, stored as negative.
1249 out->Print( nestLevel+1, "(cost %d", -cost );
1250 else
1251 out->Print( nestLevel+1, "(cost %s", GetTokenText( (DSN_T)cost ) );
1252
1253 if( cost_type != -1 )
1254 out->Print( 0, " (type %s)", GetTokenText( (DSN_T)cost_type ) );
1255
1256 out->Print( 0, ")\n" );
1257 }
1258
1259 if( use_net.size() )
1260 {
1261 out->Print( nestLevel+1, "(use_net" );
1262
1263 for( STRINGS::const_iterator i = use_net.begin(); i != use_net.end(); ++i )
1264 {
1265 quote = out->GetQuoteChar( i->c_str() );
1266 out->Print( 0, " %s%s%s", quote, i->c_str(), quote );
1267 }
1268
1269 out->Print( 0, ")\n" );
1270 }
1271
1272 out->Print( nestLevel, ")\n" );
1273 }
const char * Name() const
Definition: specctra.cpp:3760
STRINGS use_net
Definition: specctra.h:1286
PROPERTIES properties
Definition: specctra.h:1288
std::string name
Definition: specctra.h:1278
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
const char * GetTokenText(T aTok)
The DSN namespace and returns the C string representing a SPECCTRA_DB::keyword.
Definition: specctra.cpp:70
DSN::T DSN_T
Definition: specctra.h:48

References cost, cost_type, direction, DSN::RULE::Format(), OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), layer_type, DSN::ELEM::Name(), name, OUTPUTFORMATTER::Print(), properties, rules, and use_net.

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

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1276 of file specctra.h.

Member Data Documentation

◆ cost

int DSN::LAYER::cost
private

Definition at line 1283 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLAYER(), Format(), and LAYER().

◆ cost_type

int DSN::LAYER::cost_type
private

T_length | T_way.

Definition at line 1284 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLAYER(), Format(), and LAYER().

◆ direction

int DSN::LAYER::direction
private

[forbidden | high | medium | low | free | <positive_integer> | -1]

Definition at line 1280 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLAYER(), Format(), and LAYER().

◆ layer_type

DSN_T DSN::LAYER::layer_type
private

one of: T_signal, T_power, T_mixed, T_jumper

Definition at line 1279 of file specctra.h.

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

◆ name

std::string DSN::LAYER::name
private

Definition at line 1278 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLAYER(), 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().

◆ properties

PROPERTIES DSN::LAYER::properties
private

Definition at line 1288 of file specctra.h.

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

◆ rules

RULE* DSN::LAYER::rules
private

Definition at line 1285 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLAYER(), Format(), LAYER(), and ~LAYER().

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

◆ use_net

STRINGS DSN::LAYER::use_net
private

Definition at line 1286 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLAYER(), and Format().


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