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 throw ( IO_ERROR )
 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) throw ( IO_ERROR )
 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 1173 of file specctra.h.

Constructor & Destructor Documentation

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

Definition at line 1189 of file specctra.h.

References DSN::T_signal.

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

Definition at line 1200 of file specctra.h.

References rules.

1201  {
1202  delete rules;
1203  }
RULE * rules
Definition: specctra.h:1182

Member Function Documentation

void DSN::LAYER::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
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 1205 of file specctra.h.

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

1206  {
1207  const char* quote = out->GetQuoteChar( name.c_str() );
1208 
1209  out->Print( nestLevel, "(%s %s%s%s\n", Name(),
1210  quote, name.c_str(), quote );
1211 
1212  out->Print( nestLevel+1, "(type %s)\n", GetTokenText( layer_type ) );
1213 
1214  if( properties.size() )
1215  {
1216  out->Print( nestLevel+1, "(property\n" );
1217 
1218  for( PROPERTIES::iterator i = properties.begin(); i != properties.end(); ++i )
1219  {
1220  i->Format( out, nestLevel+2 );
1221  }
1222  out->Print( nestLevel+1, ")\n" );
1223  }
1224 
1225  if( direction != -1 )
1226  out->Print( nestLevel+1, "(direction %s)\n",
1228 
1229  if( rules )
1230  rules->Format( out, nestLevel+1 );
1231 
1232  if( cost != -1 )
1233  {
1234  if( cost < 0 )
1235  out->Print( nestLevel+1, "(cost %d", -cost ); // positive integer, stored as negative
1236  else
1237  out->Print( nestLevel+1, "(cost %s", GetTokenText( (DSN_T)cost ) );
1238 
1239  if( cost_type != -1 )
1240  out->Print( 0, " (type %s)", GetTokenText( (DSN_T)cost_type ) );
1241 
1242  out->Print( 0, ")\n" );
1243  }
1244 
1245  if( use_net.size() )
1246  {
1247  out->Print( nestLevel+1, "(use_net" );
1248  for( STRINGS::const_iterator i = use_net.begin(); i!=use_net.end(); ++i )
1249  {
1250  quote = out->GetQuoteChar( i->c_str() );
1251  out->Print( 0, " %s%s%s", quote, i->c_str(), quote );
1252  }
1253  out->Print( 0, ")\n" );
1254  }
1255 
1256  out->Print( nestLevel, ")\n" );
1257  }
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:1179
int cost_type
T_length | T_way.
Definition: specctra.h:1181
const char * Name() const
Definition: specctra.cpp:3497
DSN_T layer_type
one of: T_signal, T_power, T_mixed, T_jumper
Definition: specctra.h:1178
std::string name
Definition: specctra.h:1177
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:331
RULE * rules
Definition: specctra.h:1182
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:1183
int cost
[forbidden | high | medium | low | free | | -1]
Definition: specctra.h:1180
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
PROPERTIES properties
Definition: specctra.h:1185
virtual void DSN::ELEM::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
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::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 3502 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().

3503 {
3504  if( parent )
3505  return parent->GetUnits();
3506 
3507  return &UNIT_RES::Default;
3508 }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3502
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:504
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 1175 of file specctra.h.

Member Data Documentation

int DSN::LAYER::cost
private

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

Definition at line 1180 of file specctra.h.

int DSN::LAYER::cost_type
private

T_length | T_way.

Definition at line 1181 of file specctra.h.

int DSN::LAYER::direction
private

Definition at line 1179 of file specctra.h.

DSN_T DSN::LAYER::layer_type
private

one of: T_signal, T_power, T_mixed, T_jumper

Definition at line 1178 of file specctra.h.

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

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

Definition at line 1177 of file specctra.h.

Referenced by 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 1185 of file specctra.h.

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

RULE* DSN::LAYER::rules
private

Definition at line 1182 of file specctra.h.

Referenced by ~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::ELEM::Name(), and DSN::ELEM::Type().

STRINGS DSN::LAYER::use_net
private

Definition at line 1183 of file specctra.h.


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