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

Constructor & Destructor Documentation

◆ PLACEMENT()

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

Definition at line 1813 of file specctra.h.

1813  :
1814  ELEM( T_placement, aParent )
1815  {
1816  unit = 0;
1817  flip_style = DSN_T( T_NONE );
1818  }
DSN::T DSN_T
Definition: specctra.h:46
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
DSN_T flip_style
Definition: specctra.h:1808
UNIT_RES * unit
Definition: specctra.h:1806

References flip_style, and unit.

◆ ~PLACEMENT()

DSN::PLACEMENT::~PLACEMENT ( )
inline

Definition at line 1820 of file specctra.h.

1821  {
1822  delete unit;
1823  }
UNIT_RES * unit
Definition: specctra.h:1806

References unit.

Member Function Documentation

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

◆ FormatContents()

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

1847  {
1848  if( unit )
1849  unit->Format( out, nestLevel );
1850 
1851  if( flip_style != DSN_T( T_NONE ) )
1852  {
1853  out->Print( nestLevel, "(place_control (flip_style %s))\n",
1854  GetTokenText( flip_style ) );
1855  }
1856 
1857  for( COMPONENTS::iterator i=components.begin(); i!=components.end(); ++i )
1858  i->Format( out, nestLevel );
1859  }
DSN::T DSN_T
Definition: specctra.h:46
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
DSN_T flip_style
Definition: specctra.h:1808
UNIT_RES * unit
Definition: specctra.h:1806
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,...)
Format and write text to the output stream.
Definition: richio.cpp:408
COMPONENTS components
Definition: specctra.h:1810

References components, flip_style, DSN::UNIT_RES::Format(), DSN::GetTokenText(), OUTPUTFORMATTER::Print(), and unit.

◆ GetUnits()

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

1862  {
1863  if( unit )
1864  return unit;
1865 
1866  return ELEM::GetUnits();
1867  }
UNIT_RES * unit
Definition: specctra.h:1806
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3510

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

◆ LookupCOMPONENT()

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

1833  {
1834  for( unsigned i=0; i<components.size(); ++i )
1835  {
1836  if( 0 == components[i].GetImageId().compare( imageName ) )
1837  return &components[i];
1838  }
1839 
1840  COMPONENT* added = new COMPONENT(this);
1841  components.push_back( added );
1842  added->SetImageId( imageName );
1843  return added;
1844  }
Store all of the related footprint information found in a netlist.
Definition: pcb_netlist.h:83
COMPONENTS components
Definition: specctra.h:1810

References COMPONENT, components, and DSN::COMPONENT::SetImageId().

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

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

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1804 of file specctra.h.

Member Data Documentation

◆ components

COMPONENTS DSN::PLACEMENT::components
private

◆ flip_style

DSN_T DSN::PLACEMENT::flip_style
private

Definition at line 1808 of file specctra.h.

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

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

◆ unit

UNIT_RES* DSN::PLACEMENT::unit
private

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