KiCad PCB EDA Suite
DSN::COMPONENT Class Reference

Class COMPONENT implements the <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
 Function Compare compares two objects of this type and returns <0, 0, or >0. 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...
 
DSN_T Type () const
 
const char * Name () const
 
virtual UNIT_RESGetUnits () const
 Function GetUnits returns the units for this section. 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

std::string image_id
 
PLACES places
 

Friends

class SPECCTRA_DB
 

Detailed Description

Class COMPONENT implements the <component_descriptor> in the specctra dsn spec.

Definition at line 1739 of file specctra.h.

Constructor & Destructor Documentation

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

Definition at line 1749 of file specctra.h.

1749  :
1750  ELEM( T_component, aParent )
1751  {
1752  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3490

Member Function Documentation

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

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

Reimplemented from DSN::ELEM.

Definition at line 1767 of file specctra.h.

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

1768  {
1769  const char* quote = out->GetQuoteChar( image_id.c_str() );
1770  out->Print( nestLevel, "(%s %s%s%s\n", Name(),
1771  quote, image_id.c_str(), quote );
1772 
1773  FormatContents( out, nestLevel+1 );
1774 
1775  out->Print( nestLevel, ")\n" );
1776  }
const char * Name() const
Definition: specctra.cpp:3501
std::string image_id
Definition: specctra.h:1745
static const char * GetQuoteChar(const char *wrapee, const char *quote_char)
Function GetQuoteChar performs quote character need determination according to the Specctra DSN speci...
Definition: richio.cpp:327
void FormatContents(OUTPUTFORMATTER *out, int nestLevel) override
Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECC...
Definition: specctra.h:1778
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
void DSN::COMPONENT::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 1778 of file specctra.h.

Referenced by Format().

1779  {
1780  for( PLACES::iterator i=places.begin(); i!=places.end(); ++i )
1781  i->Format( out, nestLevel );
1782  }
PLACES places
Definition: specctra.h:1746
const std::string& DSN::COMPONENT::GetImageId ( ) const
inline

Definition at line 1754 of file specctra.h.

References image_id.

1754 { return image_id; }
std::string image_id
Definition: specctra.h:1745
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 3506 of file specctra.cpp.

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

3507 {
3508  if( parent )
3509  return parent->GetUnits();
3510 
3511  return &UNIT_RES::Default;
3512 }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3506
ELEM * parent
Definition: specctra.h:200
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:414
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:500
static STRING_FORMATTER sf
Definition: specctra.h:222
void Clear()
Function Clear clears the buffer and empties the internal string.
Definition: richio.h:464
void DSN::COMPONENT::SetImageId ( const std::string &  aImageId)
inline

Definition at line 1755 of file specctra.h.

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

1756  {
1757  image_id = aImageId;
1758  }
std::string image_id
Definition: specctra.h:1745

Friends And Related Function Documentation

friend class SPECCTRA_DB
friend

Definition at line 1741 of file specctra.h.

Member Data Documentation

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

Definition at line 1745 of file specctra.h.

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

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

PLACES DSN::COMPONENT::places
private

Definition at line 1746 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doCOMPONENT(), and DSN::SPECCTRA_DB::FromBOARD().

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


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