KiCad PCB EDA Suite
DSN::PLACEMENT Class Reference

#include <specctra.h>

Inheritance diagram for DSN::PLACEMENT:
DSN::ELEM

Public Member Functions

 PLACEMENT (ELEM *aParent)
 
 ~PLACEMENT ()
 
COMPONENTLookupCOMPONENT (const std::string &imageName)
 Function LookupCOMPONENT looks up a COMPONENT by name. More...
 
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...
 
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 Attributes

UNIT_RESunit
 
DSN_T flip_style
 
COMPONENTS components
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 1784 of file specctra.h.

Constructor & Destructor Documentation

DSN::PLACEMENT::PLACEMENT ( ELEM aParent)
inline

Definition at line 1795 of file specctra.h.

References DSN::T_NONE.

1795  :
1796  ELEM( T_placement, aParent )
1797  {
1798  unit = 0;
1799  flip_style = DSN_T( T_NONE );
1800  }
DSN::T DSN_T
Definition: specctra.h:47
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3486
DSN_T flip_style
Definition: specctra.h:1790
UNIT_RES * unit
Definition: specctra.h:1788
DSN::PLACEMENT::~PLACEMENT ( )
inline

Definition at line 1802 of file specctra.h.

References unit.

1803  {
1804  delete unit;
1805  }
UNIT_RES * unit
Definition: specctra.h:1788

Member Function Documentation

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 3511 of file specctra.cpp.

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

3512 {
3513  out->Print( nestLevel, "(%s\n", Name() );
3514 
3515  FormatContents( out, nestLevel+1 );
3516 
3517  out->Print( nestLevel, ")\n" );
3518 }
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 char * Name() const
Definition: specctra.cpp:3497
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
void DSN::PLACEMENT::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.

Definition at line 1828 of file specctra.h.

References DSN::UNIT_RES::Format(), DSN::GetTokenText(), OUTPUTFORMATTER::Print(), and DSN::T_NONE.

1829  {
1830  if( unit )
1831  unit->Format( out, nestLevel );
1832 
1833  if( flip_style != DSN_T( T_NONE ) )
1834  {
1835  out->Print( nestLevel, "(place_control (flip_style %s))\n",
1836  GetTokenText( flip_style ) );
1837  }
1838 
1839  for( COMPONENTS::iterator i=components.begin(); i!=components.end(); ++i )
1840  i->Format( out, nestLevel );
1841  }
DSN::T DSN_T
Definition: specctra.h:47
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:426
DSN_T flip_style
Definition: specctra.h:1790
UNIT_RES * unit
Definition: specctra.h:1788
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
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
COMPONENTS components
Definition: specctra.h:1792
UNIT_RES* DSN::PLACEMENT::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 1843 of file specctra.h.

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

1844  {
1845  if( unit )
1846  return unit;
1847 
1848  return ELEM::GetUnits();
1849  }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3502
UNIT_RES * unit
Definition: specctra.h:1788
COMPONENT* DSN::PLACEMENT::LookupCOMPONENT ( const std::string &  imageName)
inline

Function LookupCOMPONENT looks up a COMPONENT by name.

If the name is not found, a new COMPONENT is added to the components container. At any time the names in the component container should remain unique.

Returns
COMPONENT* - an existing or new

Definition at line 1814 of file specctra.h.

References DSN::COMPONENT::SetImageId().

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

1815  {
1816  for( unsigned i=0; i<components.size(); ++i )
1817  {
1818  if( 0 == components[i].GetImageId().compare( imageName ) )
1819  return &components[i];
1820  }
1821 
1822  COMPONENT* added = new COMPONENT(this);
1823  components.push_back( added );
1824  added->SetImageId( imageName );
1825  return added;
1826  }
Class COMPONENT is used to store components and all of their related information found in a netlist...
Definition: pcb_netlist.h:83
COMPONENTS components
Definition: specctra.h:1792
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 1786 of file specctra.h.

Member Data Documentation

COMPONENTS DSN::PLACEMENT::components
private

Definition at line 1792 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACEMENT(), and DSN::SPECCTRA_DB::FromSESSION().

DSN_T DSN::PLACEMENT::flip_style
private

Definition at line 1790 of file specctra.h.

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

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

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

UNIT_RES* DSN::PLACEMENT::unit
private

Definition at line 1788 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACEMENT(), GetUnits(), and ~PLACEMENT().


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