KiCad PCB EDA Suite
DSN::ELEM_HOLDER Class Reference

ELEM_HOLDER is a holder for any DSN class. More...

#include <specctra.h>

Inheritance diagram for DSN::ELEM_HOLDER:
DSN::ELEM DSN::CLASS_CLASS DSN::CONTROL DSN::IMAGE DSN::PADSTACK DSN::REGION DSN::STRUCTURE

Public Member Functions

 ELEM_HOLDER (DSN_T aType, ELEM *aParent=0)
 
virtual 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...
 
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 UNIT_RESGetUnits () const
 Function GetUnits returns the units for this section. More...
 
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< ELEMELEM_ARRAY
 

Private Attributes

ELEM_ARRAY kids
 ELEM pointers. More...
 

Friends

class SPECCTRA_DB
 

Detailed Description

ELEM_HOLDER is a holder for any DSN class.

It can contain other class instances, including classes derived from this class.

Definition at line 280 of file specctra.h.

Member Typedef Documentation

◆ ELEM_ARRAY

typedef boost::ptr_vector<ELEM> DSN::ELEM_HOLDER::ELEM_ARRAY
private

Definition at line 284 of file specctra.h.

Constructor & Destructor Documentation

◆ ELEM_HOLDER()

DSN::ELEM_HOLDER::ELEM_HOLDER ( DSN_T  aType,
ELEM aParent = 0 
)
inline

Definition at line 290 of file specctra.h.

290  :
291  ELEM( aType, aParent )
292  {
293  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494

Member Function Documentation

◆ Append()

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

◆ At()

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

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

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

◆ Delete()

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

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

◆ FindElem()

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

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 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(), FormatContents(), DSN::CLASS_CLASS::FormatContents(), DSN::STRUCTURE::FormatContents(), and DSN::ROUTE::FormatContents().

◆ FormatContents()

void DSN::ELEM_HOLDER::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
overridevirtual

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.

Reimplemented in DSN::PADSTACK, DSN::IMAGE, DSN::STRUCTURE, DSN::REGION, and DSN::CLASS_CLASS.

Definition at line 3529 of file specctra.cpp.

3530 {
3531  for( int i = 0; i < Length(); ++i )
3532  At(i)->Format( out, nestLevel );
3533 }
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
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

References At(), DSN::ELEM::Format(), and Length().

Referenced by DSN::CLASS_CLASS::FormatContents(), DSN::REGION::FormatContents(), DSN::IMAGE::FormatContents(), and DSN::PADSTACK::FormatContents().

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

◆ Insert()

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

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

◆ Length()

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

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

Referenced by DSN::CONTROL::Format(), FormatContents(), DSN::STRUCTURE::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
inline

Definition at line 349 of file specctra.h.

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

References At().

◆ Remove()

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

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

◆ Replace()

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

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

◆ SetParent()

◆ Type()

DSN_T DSN::ELEM::Type ( ) const
inlineinherited

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 282 of file specctra.h.

Member Data Documentation

◆ kids

ELEM_ARRAY DSN::ELEM_HOLDER::kids
private

ELEM pointers.

Definition at line 286 of file specctra.h.

Referenced by Append(), At(), Delete(), FindElem(), Insert(), Length(), Remove(), and Replace().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

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

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


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