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

Constructor & Destructor Documentation

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

Definition at line 1192 of file specctra.h.

References DSN::T_signal.

1192  :
1193  ELEM( T_layer, aParent )
1194  {
1195  layer_type = T_signal;
1196  direction = -1;
1197  cost = -1;
1198  cost_type = -1;
1199 
1200  rules = 0;
1201  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3490
int direction
Definition: specctra.h:1182
int cost_type
T_length | T_way.
Definition: specctra.h:1184
DSN_T layer_type
one of: T_signal, T_power, T_mixed, T_jumper
Definition: specctra.h:1181
RULE * rules
Definition: specctra.h:1185
int cost
[forbidden | high | medium | low | free | | -1]
Definition: specctra.h:1183
DSN::LAYER::~LAYER ( )
inline

Definition at line 1203 of file specctra.h.

References rules.

1204  {
1205  delete rules;
1206  }
RULE * rules
Definition: specctra.h:1185

Member Function Documentation

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

References DSN::RULE::Format(), OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), DSN::ELEM::Name(), and OUTPUTFORMATTER::Print().

1209  {
1210  const char* quote = out->GetQuoteChar( name.c_str() );
1211 
1212  out->Print( nestLevel, "(%s %s%s%s\n", Name(),
1213  quote, name.c_str(), quote );
1214 
1215  out->Print( nestLevel+1, "(type %s)\n", GetTokenText( layer_type ) );
1216 
1217  if( properties.size() )
1218  {
1219  out->Print( nestLevel+1, "(property\n" );
1220 
1221  for( PROPERTIES::iterator i = properties.begin(); i != properties.end(); ++i )
1222  {
1223  i->Format( out, nestLevel+2 );
1224  }
1225  out->Print( nestLevel+1, ")\n" );
1226  }
1227 
1228  if( direction != -1 )
1229  out->Print( nestLevel+1, "(direction %s)\n",
1231 
1232  if( rules )
1233  rules->Format( out, nestLevel+1 );
1234 
1235  if( cost != -1 )
1236  {
1237  if( cost < 0 )
1238  out->Print( nestLevel+1, "(cost %d", -cost ); // positive integer, stored as negative
1239  else
1240  out->Print( nestLevel+1, "(cost %s", GetTokenText( (DSN_T)cost ) );
1241 
1242  if( cost_type != -1 )
1243  out->Print( 0, " (type %s)", GetTokenText( (DSN_T)cost_type ) );
1244 
1245  out->Print( 0, ")\n" );
1246  }
1247 
1248  if( use_net.size() )
1249  {
1250  out->Print( nestLevel+1, "(use_net" );
1251  for( STRINGS::const_iterator i = use_net.begin(); i!=use_net.end(); ++i )
1252  {
1253  quote = out->GetQuoteChar( i->c_str() );
1254  out->Print( 0, " %s%s%s", quote, i->c_str(), quote );
1255  }
1256  out->Print( 0, ")\n" );
1257  }
1258 
1259  out->Print( nestLevel, ")\n" );
1260  }
T
enum T contains all this lexer's tokens.
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
int direction
Definition: specctra.h:1182
int cost_type
T_length | T_way.
Definition: specctra.h:1184
const char * Name() const
Definition: specctra.cpp:3501
DSN_T layer_type
one of: T_signal, T_power, T_mixed, T_jumper
Definition: specctra.h:1181
std::string name
Definition: specctra.h:1180
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:327
RULE * rules
Definition: specctra.h:1185
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:1186
int cost
[forbidden | high | medium | low | free | | -1]
Definition: specctra.h:1183
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
PROPERTIES properties
Definition: specctra.h:1188
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 264 of file specctra.h.

Referenced by DSN::ELEM::Format(), and 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 3506 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().

3507 {
3508  if( parent )
3509  return parent->GetUnits();
3510 
3511  return &UNIT_RES::Default;
3512 }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3506
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:500
static STRING_FORMATTER sf
Definition: specctra.h:222
void Clear()
Function Clear clears the buffer and empties the internal string.
Definition: richio.h:464

Friends And Related Function Documentation

friend class SPECCTRA_DB
friend

Definition at line 1178 of file specctra.h.

Member Data Documentation

int DSN::LAYER::cost
private

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

Definition at line 1183 of file specctra.h.

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

int DSN::LAYER::cost_type
private

T_length | T_way.

Definition at line 1184 of file specctra.h.

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

int DSN::LAYER::direction
private

Definition at line 1182 of file specctra.h.

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

DSN_T DSN::LAYER::layer_type
private

one of: T_signal, T_power, T_mixed, T_jumper

Definition at line 1181 of file specctra.h.

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

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

Definition at line 1180 of file specctra.h.

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

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

PROPERTIES DSN::LAYER::properties
private

Definition at line 1188 of file specctra.h.

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

RULE* DSN::LAYER::rules
private

Definition at line 1185 of file specctra.h.

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

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

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

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 199 of file specctra.h.

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

STRINGS DSN::LAYER::use_net
private

Definition at line 1186 of file specctra.h.

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


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