KiCad PCB EDA Suite
DSN::COMPONENT Class Reference

Implement a <component_descriptor> in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::COMPONENT:
DSN::ELEM

Public Member Functions

 COMPONENT (ELEM *aParent)
 
const std::string & GetImageId () const
 
void SetImageId (const std::string &aImageId)
 
void Format (OUTPUTFORMATTER *out, int nestLevel) override
 Compare two objects of this type and returns <0, 0, or >0. More...
 
void FormatContents (OUTPUTFORMATTER *out, int nestLevel) override
 Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
DSN_T Type () const
 
const char * Name () const
 
virtual UNIT_RESGetUnits () const
 Return the units for this section. 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

std::string image_id
 
PLACES places
 

Friends

class SPECCTRA_DB
 

Detailed Description

Implement a <component_descriptor> in the specctra dsn spec.

Definition at line 1767 of file specctra.h.

Constructor & Destructor Documentation

◆ COMPONENT()

DSN::COMPONENT::COMPONENT ( ELEM aParent)
inline

Definition at line 1770 of file specctra.h.

1770  :
1771  ELEM( T_component, aParent )
1772  {
1773  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749

Member Function Documentation

◆ Format()

void DSN::COMPONENT::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
inlineoverridevirtual

Compare two objects of this type and returns <0, 0, or >0.

Reimplemented from DSN::ELEM.

Definition at line 1787 of file specctra.h.

1788  {
1789  const char* quote = out->GetQuoteChar( image_id.c_str() );
1790  out->Print( nestLevel, "(%s %s%s%s\n", Name(), quote, image_id.c_str(), quote );
1791 
1792  FormatContents( out, nestLevel+1 );
1793 
1794  out->Print( nestLevel, ")\n" );
1795  }
const char * Name() const
Definition: specctra.cpp:3760
std::string image_id
Definition: specctra.h:1808
static const char * GetQuoteChar(const char *wrapee, const char *quote_char)
Perform quote character need determination according to the Specctra DSN specification.
Definition: richio.cpp:348
void FormatContents(OUTPUTFORMATTER *out, int nestLevel) override
Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:1797
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426

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

◆ FormatContents()

void DSN::COMPONENT::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 1797 of file specctra.h.

1798  {
1799  for( PLACES::iterator i=places.begin(); i!=places.end(); ++i )
1800  i->Format( out, nestLevel );
1801  }
PLACES places
Definition: specctra.h:1809

References places.

Referenced by Format().

◆ GetImageId()

const std::string& DSN::COMPONENT::GetImageId ( ) const
inline

Definition at line 1775 of file specctra.h.

1775 { return image_id; }
std::string image_id
Definition: specctra.h:1808

References image_id.

◆ GetUnits()

UNIT_RES * DSN::ELEM::GetUnits ( ) const
virtualinherited

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 in DSN::ROUTE, DSN::PCB, DSN::WIRING, DSN::LIBRARY, DSN::PADSTACK, DSN::IMAGE, DSN::PLACEMENT, and DSN::STRUCTURE.

Definition at line 3765 of file specctra.cpp.

3766 {
3767  if( parent )
3768  return parent->GetUnits();
3769 
3770  return &UNIT_RES::Default;
3771 }
ELEM * parent
Definition: specctra.h:276
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:410
virtual UNIT_RES * GetUnits() const
Return the units for this section.
Definition: specctra.cpp:3765

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

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

◆ SetImageId()

void DSN::COMPONENT::SetImageId ( const std::string &  aImageId)
inline

Definition at line 1776 of file specctra.h.

1777  {
1778  image_id = aImageId;
1779  }
std::string image_id
Definition: specctra.h:1808

References image_id.

Referenced by DSN::PLACEMENT::LookupCOMPONENT().

◆ 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

◆ image_id

std::string DSN::COMPONENT::image_id
private

Definition at line 1808 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doCOMPONENT(), Format(), GetImageId(), and SetImageId().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 276 of file specctra.h.

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

◆ places

PLACES DSN::COMPONENT::places
private

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


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