KiCad PCB EDA Suite
DSN::STRUCTURE Class Reference

#include <specctra.h>

Inheritance diagram for DSN::STRUCTURE:
DSN::ELEM_HOLDER DSN::ELEM

Public Member Functions

 STRUCTURE (ELEM *aParent)
 
 ~STRUCTURE ()
 
void SetBOUNDARY (BOUNDARY *aBoundary)
 
void SetPlaceBOUNDARY (BOUNDARY *aBoundary)
 
void FormatContents (OUTPUTFORMATTER *out, int nestLevel) override
 Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
UNIT_RESGetUnits () const override
 Function GetUnits returns the units for this section. More...
 
int FindElem (DSN_T aType, int instanceNum=0)
 Function FindElem finds a particular instance number of a given type of ELEM. More...
 
int Length () const
 Function Length returns the number of ELEMs in this ELEM. More...
 
void Append (ELEM *aElem)
 
ELEMReplace (int aIndex, ELEM *aElem)
 
ELEMRemove (int aIndex)
 
void Insert (int aIndex, ELEM *aElem)
 
ELEMAt (int aIndex) const
 
ELEMoperator[] (int aIndex) const
 
void Delete (int aIndex)
 
DSN_T Type () const
 
const char * Name () const
 
virtual void Format (OUTPUTFORMATTER *out, int nestLevel)
 Function Format writes this object 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 Types

typedef boost::ptr_vector< REGIONREGIONS
 
typedef boost::ptr_vector< GRIDGRIDS
 

Private Attributes

UNIT_RESunit
 
LAYERS layers
 
LAYER_NOISE_WEIGHTlayer_noise_weight
 
BOUNDARYboundary
 
BOUNDARYplace_boundary
 
VIAvia
 
CONTROLcontrol
 
RULErules
 
KEEPOUTS keepouts
 
COPPER_PLANES planes
 
REGIONS regions
 
RULEplace_rules
 
GRIDS grids
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 1540 of file specctra.h.

Member Typedef Documentation

◆ GRIDS

typedef boost::ptr_vector<GRID> DSN::STRUCTURE::GRIDS
private

Definition at line 1565 of file specctra.h.

◆ REGIONS

typedef boost::ptr_vector<REGION> DSN::STRUCTURE::REGIONS
private

Definition at line 1560 of file specctra.h.

Constructor & Destructor Documentation

◆ STRUCTURE()

DSN::STRUCTURE::STRUCTURE ( ELEM aParent)
inline

Definition at line 1570 of file specctra.h.

1570  :
1571  ELEM_HOLDER( T_structure, aParent )
1572  {
1573  unit = 0;
1574  layer_noise_weight = 0;
1575  boundary = 0;
1576  place_boundary = 0;
1577  via = 0;
1578  control = 0;
1579  rules = 0;
1580  place_rules = 0;
1581  }
RULE * rules
Definition: specctra.h:1554
UNIT_RES * unit
Definition: specctra.h:1544
BOUNDARY * place_boundary
Definition: specctra.h:1551
CONTROL * control
Definition: specctra.h:1553
RULE * place_rules
Definition: specctra.h:1563
LAYER_NOISE_WEIGHT * layer_noise_weight
Definition: specctra.h:1548
BOUNDARY * boundary
Definition: specctra.h:1550
ELEM_HOLDER(DSN_T aType, ELEM *aParent=0)
Definition: specctra.h:290

References boundary, control, layer_noise_weight, place_boundary, place_rules, rules, unit, and via.

◆ ~STRUCTURE()

DSN::STRUCTURE::~STRUCTURE ( )
inline

Definition at line 1583 of file specctra.h.

1584  {
1585  delete unit;
1586  delete layer_noise_weight;
1587  delete boundary;
1588  delete place_boundary;
1589  delete via;
1590  delete control;
1591  delete rules;
1592  delete place_rules;
1593  }
RULE * rules
Definition: specctra.h:1554
UNIT_RES * unit
Definition: specctra.h:1544
BOUNDARY * place_boundary
Definition: specctra.h:1551
CONTROL * control
Definition: specctra.h:1553
RULE * place_rules
Definition: specctra.h:1563
LAYER_NOISE_WEIGHT * layer_noise_weight
Definition: specctra.h:1548
BOUNDARY * boundary
Definition: specctra.h:1550

References boundary, control, layer_noise_weight, place_boundary, place_rules, rules, unit, and via.

Member Function Documentation

◆ Append()

void DSN::ELEM_HOLDER::Append ( ELEM aElem)
inlineinherited

◆ At()

ELEM* DSN::ELEM_HOLDER::At ( int  aIndex) const
inlineinherited

Definition at line 342 of file specctra.h.

343  {
344  // we have varying sized objects and are using polymorphism, so we
345  // must return a pointer not a reference.
346  return (ELEM*) &kids[aIndex];
347  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286

References DSN::ELEM_HOLDER::kids.

Referenced by DSN::CONTROL::Format(), DSN::ELEM_HOLDER::FormatContents(), FormatContents(), and DSN::ELEM_HOLDER::operator[]().

◆ Delete()

void DSN::ELEM_HOLDER::Delete ( int  aIndex)
inlineinherited

Definition at line 354 of file specctra.h.

355  {
356  kids.erase( kids.begin()+aIndex );
357  }
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286

References DSN::ELEM_HOLDER::kids.

◆ FindElem()

int DSN::ELEM_HOLDER::FindElem ( DSN_T  aType,
int  instanceNum = 0 
)
inherited

Function FindElem finds a particular instance number of a given type of ELEM.

Parameters
aTypeThe type of ELEM to find
instanceNumThe instance number of to find: 0 for first, 1 for second, etc.
Returns
int - The index into the kids array or -1 if not found.

Definition at line 3536 of file specctra.cpp.

3537 {
3538  int repeats=0;
3539 
3540  for( unsigned i = 0; i < kids.size(); ++i )
3541  {
3542  if( kids[i].Type() == aType )
3543  {
3544  if( repeats == instanceNum )
3545  return i;
3546 
3547  ++repeats;
3548  }
3549  }
3550 
3551  return -1;
3552 }
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286
DSN_T Type() const
Definition: specctra.h:230

References DSN::ELEM_HOLDER::kids, and DSN::ELEM::Type().

◆ Format()

void DSN::ELEM::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
virtualinherited

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 in DSN::SESSION, DSN::NET_OUT, DSN::SUPPLY_PIN, DSN::ANCESTOR, DSN::PCB, DSN::WIRE_VIA, DSN::WIRE, DSN::CLASS, DSN::NET, DSN::COMP_ORDER, DSN::FROMTO, DSN::PADSTACK, DSN::IMAGE, DSN::PIN, DSN::SHAPE, DSN::COMPONENT, DSN::PLACE, DSN::GRID, DSN::STRINGPROP, DSN::TOKPROP, DSN::LAYER_NOISE_WEIGHT, DSN::SPECCTRA_LAYER_PAIR, DSN::LAYER, DSN::CONTROL, DSN::VIA, DSN::KEEPOUT, DSN::WINDOW, DSN::QARC, DSN::CIRCLE, DSN::BOUNDARY, DSN::PATH, DSN::LAYER_RULE, DSN::RULE, DSN::RECTANGLE, and DSN::UNIT_RES.

Definition at line 3519 of file specctra.cpp.

3520 {
3521  out->Print( nestLevel, "(%s\n", Name() );
3522 
3523  FormatContents( out, nestLevel+1 );
3524 
3525  out->Print( nestLevel, ")\n" );
3526 }
const char * Name() const
Definition: specctra.cpp:3505
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
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408

References DSN::ELEM::FormatContents(), DSN::ELEM::Name(), and OUTPUTFORMATTER::Print().

Referenced by DSN::WINDOW::Format(), DSN::KEEPOUT::Format(), DSN::CONTROL::Format(), DSN::PLACE::Format(), DSN::SHAPE::Format(), DSN::CLASS::Format(), DSN::WIRE::Format(), DSN::PCB::Format(), DSN::SESSION::Format(), DSN::ELEM_HOLDER::FormatContents(), DSN::CLASS_CLASS::FormatContents(), FormatContents(), and DSN::ROUTE::FormatContents().

◆ FormatContents()

void DSN::STRUCTURE::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
inlineoverridevirtual

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 from DSN::ELEM_HOLDER.

Definition at line 1613 of file specctra.h.

1614  {
1615  if( unit )
1616  unit->Format( out, nestLevel );
1617 
1618  for( LAYERS::iterator i=layers.begin(); i!=layers.end(); ++i )
1619  i->Format( out, nestLevel );
1620 
1621  if( layer_noise_weight )
1622  layer_noise_weight->Format( out, nestLevel );
1623 
1624  if( boundary )
1625  boundary->Format( out, nestLevel );
1626 
1627  if( place_boundary )
1628  place_boundary->Format( out, nestLevel );
1629 
1630  for( COPPER_PLANES::iterator i=planes.begin(); i!=planes.end(); ++i )
1631  i->Format( out, nestLevel );
1632 
1633  for( REGIONS::iterator i=regions.begin(); i!=regions.end(); ++i )
1634  i->Format( out, nestLevel );
1635 
1636  for( KEEPOUTS::iterator i=keepouts.begin(); i!=keepouts.end(); ++i )
1637  i->Format( out, nestLevel );
1638 
1639  if( via )
1640  via->Format( out, nestLevel );
1641 
1642  if( control )
1643  control->Format( out, nestLevel );
1644 
1645  for( int i=0; i<Length(); ++i )
1646  {
1647  At(i)->Format( out, nestLevel );
1648  }
1649 
1650  if( rules )
1651  rules->Format( out, nestLevel );
1652 
1653  if( place_rules )
1654  place_rules->Format( out, nestLevel );
1655 
1656  for( GRIDS::iterator i=grids.begin(); i!=grids.end(); ++i )
1657  i->Format( out, nestLevel );
1658  }
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:711
COPPER_PLANES planes
Definition: specctra.h:1558
RULE * rules
Definition: specctra.h:1554
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
UNIT_RES * unit
Definition: specctra.h:1544
BOUNDARY * place_boundary
Definition: specctra.h:1551
CONTROL * control
Definition: specctra.h:1553
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:425
RULE * place_rules
Definition: specctra.h:1563
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:1322
LAYER_NOISE_WEIGHT * layer_noise_weight
Definition: specctra.h:1548
REGIONS regions
Definition: specctra.h:1561
virtual void Format(OUTPUTFORMATTER *out, int nestLevel)
Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN f...
Definition: specctra.cpp:3519
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:1043
BOUNDARY * boundary
Definition: specctra.h:1550
LAYERS layers
Definition: specctra.h:1546
ELEM * At(int aIndex) const
Definition: specctra.h:342
int Length() const
Function Length returns the number of ELEMs in this ELEM.
Definition: specctra.h:315
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:1167
KEEPOUTS keepouts
Definition: specctra.h:1556

References DSN::ELEM_HOLDER::At(), boundary, control, DSN::ELEM::Format(), DSN::UNIT_RES::Format(), DSN::RULE::Format(), DSN::BOUNDARY::Format(), DSN::VIA::Format(), DSN::CONTROL::Format(), DSN::LAYER_NOISE_WEIGHT::Format(), grids, keepouts, layer_noise_weight, layers, DSN::ELEM_HOLDER::Length(), place_boundary, place_rules, planes, regions, rules, unit, and via.

◆ GetUnits()

UNIT_RES* DSN::STRUCTURE::GetUnits ( ) const
inlineoverridevirtual

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 from DSN::ELEM.

Definition at line 1660 of file specctra.h.

1661  {
1662  if( unit )
1663  return unit;
1664 
1665  return ELEM::GetUnits();
1666  }
UNIT_RES * unit
Definition: specctra.h:1544
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3510

References DSN::ELEM::GetUnits(), and unit.

◆ Insert()

void DSN::ELEM_HOLDER::Insert ( int  aIndex,
ELEM aElem 
)
inlineinherited

Definition at line 337 of file specctra.h.

338  {
339  kids.insert( kids.begin()+aIndex, aElem );
340  }
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286

References DSN::ELEM_HOLDER::kids.

◆ Length()

int DSN::ELEM_HOLDER::Length ( ) const
inlineinherited

Function Length returns the number of ELEMs in this ELEM.

Returns
int - the count of children

Definition at line 315 of file specctra.h.

316  {
317  return kids.size();
318  }
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286

References DSN::ELEM_HOLDER::kids.

Referenced by DSN::CONTROL::Format(), DSN::ELEM_HOLDER::FormatContents(), FormatContents(), and DSN::SPECCTRA_DB::makeVIA().

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

◆ operator[]()

ELEM* DSN::ELEM_HOLDER::operator[] ( int  aIndex) const
inlineinherited

Definition at line 349 of file specctra.h.

350  {
351  return At( aIndex );
352  }
ELEM * At(int aIndex) const
Definition: specctra.h:342

References DSN::ELEM_HOLDER::At().

◆ Remove()

ELEM* DSN::ELEM_HOLDER::Remove ( int  aIndex)
inlineinherited

Definition at line 331 of file specctra.h.

332  {
333  ELEM_ARRAY::auto_type ret = kids.release( kids.begin()+aIndex );
334  return ret.release();
335  }
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286

References DSN::ELEM_HOLDER::kids.

◆ Replace()

ELEM* DSN::ELEM_HOLDER::Replace ( int  aIndex,
ELEM aElem 
)
inlineinherited

Definition at line 325 of file specctra.h.

326  {
327  ELEM_ARRAY::auto_type ret = kids.replace( aIndex, aElem );
328  return ret.release();
329  }
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286

References DSN::ELEM_HOLDER::kids.

◆ SetBOUNDARY()

void DSN::STRUCTURE::SetBOUNDARY ( BOUNDARY aBoundary)
inline

Definition at line 1595 of file specctra.h.

1596  {
1597  delete boundary;
1598  boundary = aBoundary;
1599  if( boundary )
1600  {
1601  boundary->SetParent( this );
1602  }
1603  }
BOUNDARY * boundary
Definition: specctra.h:1550
void SetParent(ELEM *aParent)
Definition: specctra.h:268

References boundary, and DSN::ELEM::SetParent().

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

◆ SetParent()

◆ SetPlaceBOUNDARY()

void DSN::STRUCTURE::SetPlaceBOUNDARY ( BOUNDARY aBoundary)
inline

Definition at line 1605 of file specctra.h.

1606  {
1607  delete place_boundary;
1608  place_boundary = aBoundary;
1609  if( place_boundary )
1610  place_boundary->SetParent( this );
1611  }
BOUNDARY * place_boundary
Definition: specctra.h:1551
void SetParent(ELEM *aParent)
Definition: specctra.h:268

References place_boundary, and DSN::ELEM::SetParent().

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1542 of file specctra.h.

Member Data Documentation

◆ boundary

BOUNDARY* DSN::STRUCTURE::boundary
private

◆ control

CONTROL* DSN::STRUCTURE::control
private

Definition at line 1553 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSTRUCTURE(), FormatContents(), STRUCTURE(), and ~STRUCTURE().

◆ grids

GRIDS DSN::STRUCTURE::grids
private

Definition at line 1566 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSTRUCTURE(), and FormatContents().

◆ keepouts

KEEPOUTS DSN::STRUCTURE::keepouts
private

◆ layer_noise_weight

LAYER_NOISE_WEIGHT* DSN::STRUCTURE::layer_noise_weight
private

Definition at line 1548 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSTRUCTURE(), FormatContents(), STRUCTURE(), and ~STRUCTURE().

◆ layers

LAYERS DSN::STRUCTURE::layers
private

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

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

◆ place_boundary

BOUNDARY* DSN::STRUCTURE::place_boundary
private

◆ place_rules

RULE* DSN::STRUCTURE::place_rules
private

Definition at line 1563 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSTRUCTURE(), FormatContents(), STRUCTURE(), and ~STRUCTURE().

◆ planes

COPPER_PLANES DSN::STRUCTURE::planes
private

◆ regions

REGIONS DSN::STRUCTURE::regions
private

Definition at line 1561 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSTRUCTURE(), and FormatContents().

◆ rules

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

◆ unit

UNIT_RES* DSN::STRUCTURE::unit
private

◆ via


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