KiCad PCB EDA Suite
DSN::IMAGE Class Reference

#include <specctra.h>

Inheritance diagram for DSN::IMAGE:
DSN::ELEM_HOLDER DSN::ELEM

Public Member Functions

 IMAGE (ELEM *aParent)
 
 ~IMAGE ()
 
std::string GetImageId ()
 
void Format (OUTPUTFORMATTER *out, int nestLevel) override
 Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. 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...
 
int FindElem (DSN_T aType, int instanceNum=0)
 Function FindElem finds a particular instance number of a given type of ELEM. More...
 
int Length () const
 Function Length returns the number of ELEMs in this ELEM. More...
 
void Append (ELEM *aElem)
 
ELEMReplace (int aIndex, ELEM *aElem)
 
ELEMRemove (int aIndex)
 
void Insert (int aIndex, ELEM *aElem)
 
ELEMAt (int aIndex) const
 
ELEMoperator[] (int aIndex) const
 
void Delete (int aIndex)
 
DSN_T Type () const
 
const char * Name () const
 
void SetParent (ELEM *aParent)
 

Static Public Member Functions

static int Compare (IMAGE *lhs, IMAGE *rhs)
 Function Compare compares two objects of this type and returns <0, 0, or >0. More...
 

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 hash
 a hash string used by Compare(), not Format()ed/exported. More...
 
std::string image_id
 
DSN_T side
 
UNIT_RESunit
 
PINS pins
 
RULErules
 
RULEplace_rules
 
KEEPOUTS keepouts
 
int duplicated
 no. times this image_id is duplicated More...
 

Friends

class SPECCTRA_DB
 
class LIBRARY
 

Detailed Description

Definition at line 1991 of file specctra.h.

Constructor & Destructor Documentation

◆ IMAGE()

DSN::IMAGE::IMAGE ( ELEM aParent)
inline

Definition at line 2018 of file specctra.h.

2018  :
2019  ELEM_HOLDER( T_image, aParent )
2020  {
2021  side = T_both;
2022  unit = 0;
2023  rules = 0;
2024  place_rules = 0;
2025  duplicated = 0;
2026  }
DSN_T side
Definition: specctra.h:1999
int duplicated
no. times this image_id is duplicated
Definition: specctra.h:2014
RULE * place_rules
Definition: specctra.h:2010
UNIT_RES * unit
Definition: specctra.h:2000
RULE * rules
Definition: specctra.h:2009
ELEM_HOLDER(DSN_T aType, ELEM *aParent=0)
Definition: specctra.h:290

References duplicated, place_rules, rules, side, and unit.

◆ ~IMAGE()

DSN::IMAGE::~IMAGE ( )
inline

Definition at line 2027 of file specctra.h.

2028  {
2029  delete unit;
2030  delete rules;
2031  delete place_rules;
2032  }
RULE * place_rules
Definition: specctra.h:2010
UNIT_RES * unit
Definition: specctra.h:2000
RULE * rules
Definition: specctra.h:2009

References place_rules, rules, and unit.

Member Function Documentation

◆ Append()

void DSN::ELEM_HOLDER::Append ( ELEM aElem)
inlineinherited

◆ At()

ELEM* DSN::ELEM_HOLDER::At ( int  aIndex) const
inlineinherited

Definition at line 342 of file specctra.h.

343  {
344  // we have varying sized objects and are using polymorphism, so we
345  // must return a pointer not a reference.
346  return (ELEM*) &kids[aIndex];
347  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286

References DSN::ELEM_HOLDER::kids.

Referenced by DSN::CONTROL::Format(), DSN::ELEM_HOLDER::FormatContents(), DSN::STRUCTURE::FormatContents(), and DSN::ELEM_HOLDER::operator[]().

◆ Compare()

int IMAGE::Compare ( IMAGE lhs,
IMAGE rhs 
)
static

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

Definition at line 3588 of file specctra.cpp.

3589 {
3590  if( !lhs->hash.size() )
3591  lhs->hash = lhs->makeHash();
3592 
3593  if( !rhs->hash.size() )
3594  rhs->hash = rhs->makeHash();
3595 
3596  int result = lhs->hash.compare( rhs->hash );
3597 
3598  return result;
3599 }

References hash, and DSN::ELEM::makeHash().

Referenced by DSN::LIBRARY::FindIMAGE().

◆ Delete()

void DSN::ELEM_HOLDER::Delete ( int  aIndex)
inlineinherited

Definition at line 354 of file specctra.h.

355  {
356  kids.erase( kids.begin()+aIndex );
357  }
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286

References DSN::ELEM_HOLDER::kids.

◆ FindElem()

int DSN::ELEM_HOLDER::FindElem ( DSN_T  aType,
int  instanceNum = 0 
)
inherited

Function FindElem finds a particular instance number of a given type of ELEM.

Parameters
aTypeThe type of ELEM to find
instanceNumThe instance number of to find: 0 for first, 1 for second, etc.
Returns
int - The index into the kids array or -1 if not found.

Definition at line 3536 of file specctra.cpp.

3537 {
3538  int repeats=0;
3539 
3540  for( unsigned i = 0; i < kids.size(); ++i )
3541  {
3542  if( kids[i].Type() == aType )
3543  {
3544  if( repeats == instanceNum )
3545  return i;
3546 
3547  ++repeats;
3548  }
3549  }
3550 
3551  return -1;
3552 }
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286
DSN_T Type() const
Definition: specctra.h:230

References DSN::ELEM_HOLDER::kids, and DSN::ELEM::Type().

◆ Format()

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

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 from DSN::ELEM.

Definition at line 2056 of file specctra.h.

2057  {
2058  std::string imageId = GetImageId();
2059 
2060  const char* quote = out->GetQuoteChar( imageId.c_str() );
2061 
2062  out->Print( nestLevel, "(%s %s%s%s",
2063  Name(),
2064  quote, imageId.c_str(), quote );
2065 
2066  FormatContents( out, nestLevel+1 );
2067 
2068  out->Print( nestLevel, ")\n" );
2069  }
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:2072
const char * Name() const
Definition: specctra.cpp:3505
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:331
std::string GetImageId()
Definition: specctra.h:2040
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408

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

◆ FormatContents()

void DSN::IMAGE::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_HOLDER.

Definition at line 2072 of file specctra.h.

2073  {
2074  if( side != T_both )
2075  out->Print( 0, " (side %s)", GetTokenText( side ) );
2076 
2077  out->Print( 0, "\n");
2078 
2079  if( unit )
2080  unit->Format( out, nestLevel );
2081 
2082  // format the kids, which in this class are the shapes
2083  ELEM_HOLDER::FormatContents( out, nestLevel );
2084 
2085  for( PINS::iterator i=pins.begin(); i!=pins.end(); ++i )
2086  i->Format( out, nestLevel );
2087 
2088  if( rules )
2089  rules->Format( out, nestLevel );
2090 
2091  if( place_rules )
2092  place_rules->Format( out, nestLevel );
2093 
2094  for( KEEPOUTS::iterator i=keepouts.begin(); i!=keepouts.end(); ++i )
2095  i->Format( out, nestLevel );
2096  }
DSN_T side
Definition: specctra.h:1999
KEEPOUTS keepouts
Definition: specctra.h:2012
PINS pins
Definition: specctra.h:2007
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:501
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
RULE * place_rules
Definition: specctra.h:2010
UNIT_RES * unit
Definition: specctra.h:2000
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel) override
Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECC...
Definition: specctra.cpp:3529
RULE * rules
Definition: specctra.h:2009
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

References DSN::UNIT_RES::Format(), DSN::RULE::Format(), DSN::ELEM_HOLDER::FormatContents(), DSN::GetTokenText(), keepouts, pins, place_rules, OUTPUTFORMATTER::Print(), rules, side, and unit.

Referenced by Format().

◆ GetImageId()

std::string DSN::IMAGE::GetImageId ( )
inline

Definition at line 2040 of file specctra.h.

2041  {
2042  if( duplicated )
2043  {
2044  char buf[32];
2045 
2046  std::string ret = image_id;
2047  ret += "::";
2048  sprintf( buf, "%d", duplicated );
2049  ret += buf;
2050  return ret;
2051  }
2052 
2053  return image_id;
2054  }
int duplicated
no. times this image_id is duplicated
Definition: specctra.h:2014
std::string image_id
Definition: specctra.h:1998

References duplicated, and image_id.

Referenced by Format().

◆ GetUnits()

UNIT_RES* DSN::IMAGE::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 2099 of file specctra.h.

2100  {
2101  if( unit )
2102  return unit;
2103 
2104  return ELEM::GetUnits();
2105  }
UNIT_RES * unit
Definition: specctra.h:2000
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3510

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

◆ Insert()

void DSN::ELEM_HOLDER::Insert ( int  aIndex,
ELEM aElem 
)
inlineinherited

Definition at line 337 of file specctra.h.

338  {
339  kids.insert( kids.begin()+aIndex, aElem );
340  }
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286

References DSN::ELEM_HOLDER::kids.

◆ Length()

int DSN::ELEM_HOLDER::Length ( ) const
inlineinherited

Function Length returns the number of ELEMs in this ELEM.

Returns
int - the count of children

Definition at line 315 of file specctra.h.

316  {
317  return kids.size();
318  }
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286

References DSN::ELEM_HOLDER::kids.

Referenced by DSN::CONTROL::Format(), DSN::ELEM_HOLDER::FormatContents(), DSN::STRUCTURE::FormatContents(), and DSN::SPECCTRA_DB::makeVIA().

◆ 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 Compare(), and DSN::PADSTACK::Compare().

◆ Name()

◆ operator[]()

ELEM* DSN::ELEM_HOLDER::operator[] ( int  aIndex) const
inlineinherited

Definition at line 349 of file specctra.h.

350  {
351  return At( aIndex );
352  }
ELEM * At(int aIndex) const
Definition: specctra.h:342

References DSN::ELEM_HOLDER::At().

◆ Remove()

ELEM* DSN::ELEM_HOLDER::Remove ( int  aIndex)
inlineinherited

Definition at line 331 of file specctra.h.

332  {
333  ELEM_ARRAY::auto_type ret = kids.release( kids.begin()+aIndex );
334  return ret.release();
335  }
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286

References DSN::ELEM_HOLDER::kids.

◆ Replace()

ELEM* DSN::ELEM_HOLDER::Replace ( int  aIndex,
ELEM aElem 
)
inlineinherited

Definition at line 325 of file specctra.h.

326  {
327  ELEM_ARRAY::auto_type ret = kids.replace( aIndex, aElem );
328  return ret.release();
329  }
ELEM_ARRAY kids
ELEM pointers.
Definition: specctra.h:286

References DSN::ELEM_HOLDER::kids.

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ LIBRARY

friend class LIBRARY
friend

Definition at line 1994 of file specctra.h.

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1993 of file specctra.h.

Member Data Documentation

◆ duplicated

int DSN::IMAGE::duplicated
private

no. times this image_id is duplicated

Definition at line 2014 of file specctra.h.

Referenced by DSN::LIBRARY::FindIMAGE(), GetImageId(), and IMAGE().

◆ hash

std::string DSN::IMAGE::hash
private

a hash string used by Compare(), not Format()ed/exported.

Definition at line 1996 of file specctra.h.

Referenced by Compare().

◆ image_id

std::string DSN::IMAGE::image_id
private

Definition at line 1998 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), DSN::LIBRARY::FindIMAGE(), and GetImageId().

◆ keepouts

KEEPOUTS DSN::IMAGE::keepouts
private

Definition at line 2012 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), and FormatContents().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

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

◆ pins

PINS DSN::IMAGE::pins
private

Definition at line 2007 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), and FormatContents().

◆ place_rules

RULE* DSN::IMAGE::place_rules
private

Definition at line 2010 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), FormatContents(), IMAGE(), and ~IMAGE().

◆ rules

RULE* DSN::IMAGE::rules
private

Definition at line 2009 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), FormatContents(), IMAGE(), and ~IMAGE().

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

◆ side

DSN_T DSN::IMAGE::side
private

Definition at line 1999 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), FormatContents(), and IMAGE().

◆ 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::IMAGE::unit
private

Definition at line 2000 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doIMAGE(), FormatContents(), GetUnits(), IMAGE(), and ~IMAGE().


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