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

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
 
int cost
 [forbidden | high | medium | low | free | <positive_integer> | -1] More...
 
int cost_type
 T_length | T_way. More...
 
RULErules
 
STRINGS use_net
 
PROPERTIES properties
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 1186 of file specctra.h.

Constructor & Destructor Documentation

◆ LAYER()

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

Definition at line 1202 of file specctra.h.

1202  :
1203  ELEM( T_layer, aParent )
1204  {
1205  layer_type = T_signal;
1206  direction = -1;
1207  cost = -1;
1208  cost_type = -1;
1209 
1210  rules = 0;
1211  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
int direction
Definition: specctra.h:1192
int cost_type
T_length | T_way.
Definition: specctra.h:1194
DSN_T layer_type
one of: T_signal, T_power, T_mixed, T_jumper
Definition: specctra.h:1191
RULE * rules
Definition: specctra.h:1195
int cost
[forbidden | high | medium | low | free | <positive_integer> | -1]
Definition: specctra.h:1193

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

◆ ~LAYER()

DSN::LAYER::~LAYER ( )
inline

Definition at line 1213 of file specctra.h.

1214  {
1215  delete rules;
1216  }
RULE * rules
Definition: specctra.h:1195

References rules.

Member Function Documentation

◆ Format()

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

1219  {
1220  const char* quote = out->GetQuoteChar( name.c_str() );
1221 
1222  out->Print( nestLevel, "(%s %s%s%s\n",
1223  Name(),
1224  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  out->Print( nestLevel+1, "(cost %d", -cost ); // positive integer, stored as negative
1249  else
1250  out->Print( nestLevel+1, "(cost %s", GetTokenText( (DSN_T)cost ) );
1251 
1252  if( cost_type != -1 )
1253  out->Print( 0, " (type %s)", GetTokenText( (DSN_T)cost_type ) );
1254 
1255  out->Print( 0, ")\n" );
1256  }
1257 
1258  if( use_net.size() )
1259  {
1260  out->Print( nestLevel+1, "(use_net" );
1261 
1262  for( STRINGS::const_iterator i = use_net.begin(); i != use_net.end(); ++i )
1263  {
1264  quote = out->GetQuoteChar( i->c_str() );
1265  out->Print( 0, " %s%s%s", quote, i->c_str(), quote );
1266  }
1267 
1268  out->Print( 0, ")\n" );
1269  }
1270 
1271  out->Print( nestLevel, ")\n" );
1272  }
DSN::T DSN_T
Definition: specctra.h:46
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
int direction
Definition: specctra.h:1192
int cost_type
T_length | T_way.
Definition: specctra.h:1194
DSN_T layer_type
one of: T_signal, T_power, T_mixed, T_jumper
Definition: specctra.h:1191
std::string name
Definition: specctra.h:1190
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
RULE * rules
Definition: specctra.h:1195
const char * GetTokenText(T aTok)
Function GetTokenText is in the DSN namespace and returns the C string representing a SPECCTRA_DB::ke...
Definition: specctra.cpp:69
STRINGS use_net
Definition: specctra.h:1196
int cost
[forbidden | high | medium | low | free | <positive_integer> | -1]
Definition: specctra.h:1193
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408
PROPERTIES properties
Definition: specctra.h:1198

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

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

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1188 of file specctra.h.

Member Data Documentation

◆ cost

int DSN::LAYER::cost
private

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

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

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

◆ direction

int DSN::LAYER::direction
private

Definition at line 1192 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 1191 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 1190 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 199 of file specctra.h.

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

◆ properties

PROPERTIES DSN::LAYER::properties
private

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

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

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

◆ use_net

STRINGS DSN::LAYER::use_net
private

Definition at line 1196 of file specctra.h.

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


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