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)
 Look up a COMPONENT by name. More...
 
void FormatContents (OUTPUTFORMATTER *out, int nestLevel) override
 Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
UNIT_RESGetUnits () const override
 Return the units for this section. More...
 
DSN_T Type () const
 
const char * Name () const
 
virtual void Format (OUTPUTFORMATTER *out, int nestLevel)
 Write 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 ()
 Return a string which uniquely represents this ELEM among 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 1815 of file specctra.h.

Constructor & Destructor Documentation

◆ PLACEMENT()

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

Definition at line 1818 of file specctra.h.

1818  :
1819  ELEM( T_placement, aParent )
1820  {
1821  unit = 0;
1822  flip_style = DSN_T( T_NONE );
1823  }
DSN::T DSN_T
Definition: specctra.h:46
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749
DSN_T flip_style
Definition: specctra.h:1880
UNIT_RES * unit
Definition: specctra.h:1878

References flip_style, and unit.

◆ ~PLACEMENT()

DSN::PLACEMENT::~PLACEMENT ( )
inline

Definition at line 1825 of file specctra.h.

1826  {
1827  delete unit;
1828  }
UNIT_RES * unit
Definition: specctra.h:1878

References unit.

Member Function Documentation

◆ Format()

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

Write 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 precede 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 3774 of file specctra.cpp.

3775 {
3776  out->Print( nestLevel, "(%s\n", Name() );
3777 
3778  FormatContents( out, nestLevel+1 );
3779 
3780  out->Print( nestLevel, ")\n" );
3781 }
const char * Name() const
Definition: specctra.cpp:3760
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:242
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426

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

Write 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 precede the output with.
Exceptions
IO_ERRORif a system error writing the output, such as a full disk.

Reimplemented from DSN::ELEM.

Definition at line 1852 of file specctra.h.

1853  {
1854  if( unit )
1855  unit->Format( out, nestLevel );
1856 
1857  if( flip_style != DSN_T( T_NONE ) )
1858  {
1859  out->Print( nestLevel, "(place_control (flip_style %s))\n",
1860  GetTokenText( flip_style ) );
1861  }
1862 
1863  for( COMPONENTS::iterator i = components.begin(); i != components.end(); ++i )
1864  i->Format( out, nestLevel );
1865  }
DSN::T DSN_T
Definition: specctra.h:46
void Format(OUTPUTFORMATTER *out, int nestLevel) override
Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:422
DSN_T flip_style
Definition: specctra.h:1880
UNIT_RES * unit
Definition: specctra.h:1878
const char * GetTokenText(T aTok)
The DSN namespace and returns the C string representing a SPECCTRA_DB::keyword.
Definition: specctra.cpp:70
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426
COMPONENTS components
Definition: specctra.h:1882

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

◆ GetUnits()

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

Return the units for this section.

Derived classes may override this to check for section specific overrides.

Returns
an element from a local or parent scope.

Reimplemented from DSN::ELEM.

Definition at line 1867 of file specctra.h.

1868  {
1869  if( unit )
1870  return unit;
1871 
1872  return ELEM::GetUnits();
1873  }
UNIT_RES * unit
Definition: specctra.h:1878
virtual UNIT_RES * GetUnits() const
Return the units for this section.
Definition: specctra.cpp:3765

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

◆ LookupCOMPONENT()

COMPONENT* DSN::PLACEMENT::LookupCOMPONENT ( const std::string &  imageName)
inline

Look 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
existing or new COMPONENT.

Definition at line 1838 of file specctra.h.

1839  {
1840  for( unsigned i = 0; i < components.size(); ++i )
1841  {
1842  if( 0 == components[i].GetImageId().compare( imageName ) )
1843  return &components[i];
1844  }
1845 
1846  COMPONENT* added = new COMPONENT(this);
1847  components.push_back( added );
1848  added->SetImageId( imageName );
1849  return added;
1850  }
Store all of the related footprint information found in a netlist.
Definition: pcb_netlist.h:84
COMPONENTS components
Definition: specctra.h:1882

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

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

◆ makeHash()

std::string DSN::ELEM::makeHash ( )
inlineprotectedinherited

Return a string which uniquely represents this ELEM among other ELEMs of the same derived class as "this" one.

It is not usable 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 263 of file specctra.h.

264  {
265  sf.Clear();
266  FormatContents( &sf, 0 );
267  sf.StripUseless();
268 
269  return sf.GetString();
270  }
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:242
const std::string & GetString()
Definition: richio.h:438
void StripUseless()
Removes whitespace, '(', and ')' from the string.
Definition: richio.cpp:512
static STRING_FORMATTER sf
Definition: specctra.h:273
void Clear()
Clear the buffer and empties the internal string.
Definition: richio.h:428

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

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 276 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 273 of file specctra.h.

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

◆ type

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 275 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: