KiCad PCB EDA Suite
DSN::ANCESTOR Class Reference

#include <specctra.h>

Inheritance diagram for DSN::ANCESTOR:
DSN::ELEM

Public Member Functions

 ANCESTOR (ELEM *aParent)
 
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...
 
DSN_T Type () const
 
const char * Name () const
 
virtual UNIT_RESGetUnits () const
 Function GetUnits returns the units for this section. More...
 
virtual void FormatContents (OUTPUTFORMATTER *out, int nestLevel)
 Function FormatContents writes the contents 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

std::string filename
 
std::string comment
 
time_t time_stamp
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 3220 of file specctra.h.

Constructor & Destructor Documentation

DSN::ANCESTOR::ANCESTOR ( ELEM aParent)
inline

Definition at line 3230 of file specctra.h.

3230  :
3231  ELEM( T_ancestor, aParent )
3232  {
3233  time_stamp = time(NULL);
3234  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3486
time_t time_stamp
Definition: specctra.h:3226

Member Function Documentation

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

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

3237  {
3238  char temp[80];
3239  struct tm* tmp;
3240 
3241  tmp = localtime( &time_stamp );
3242  strftime( temp, sizeof(temp), "%b %d %H : %M : %S %Y", tmp );
3243 
3244  // format the time first to temp
3245  // filename may be empty, so quote it just in case.
3246  out->Print( nestLevel, "(%s \"%s\" (created_time %s)\n",
3247  Name(),
3248  filename.c_str(),
3249  temp );
3250 
3251  if( comment.size() )
3252  {
3253  const char* quote = out->GetQuoteChar( comment.c_str() );
3254  out->Print( nestLevel+1, "(comment %s%s%s)\n",
3255  quote, comment.c_str(), quote );
3256  }
3257 
3258  out->Print( nestLevel, ")\n" );
3259  }
const char * Name() const
Definition: specctra.cpp:3497
std::string comment
Definition: specctra.h:3225
std::string filename
Definition: specctra.h:3224
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:331
time_t time_stamp
Definition: specctra.h:3226
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
virtual void DSN::ELEM::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
inlinevirtualinherited

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 in DSN::WAS_IS, DSN::ROUTE, DSN::HISTORY, DSN::WIRING, DSN::NETWORK, DSN::TOPOLOGY, DSN::LIBRARY, DSN::PADSTACK, DSN::IMAGE, DSN::PLACEMENT, DSN::COMPONENT, DSN::STRUCTURE, DSN::STRUCTURE_OUT, DSN::REGION, DSN::CLASS_CLASS, DSN::CLASSES, DSN::PARSER, and DSN::ELEM_HOLDER.

Definition at line 264 of file specctra.h.

Referenced by DSN::ELEM::Format(), and DSN::ELEM::makeHash().

265  {
266  // overridden in ELEM_HOLDER
267  }
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 3502 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().

3503 {
3504  if( parent )
3505  return parent->GetUnits();
3506 
3507  return &UNIT_RES::Default;
3508 }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3502
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:504
static STRING_FORMATTER sf
Definition: specctra.h:222
void Clear()
Function Clear clears the buffer and empties the internal string.
Definition: richio.h:464

Friends And Related Function Documentation

friend class SPECCTRA_DB
friend

Definition at line 3222 of file specctra.h.

Member Data Documentation

std::string DSN::ANCESTOR::comment
private

Definition at line 3225 of file specctra.h.

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

std::string DSN::ANCESTOR::filename
private

Definition at line 3224 of file specctra.h.

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

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

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

time_t DSN::ANCESTOR::time_stamp
private

Definition at line 3226 of file specctra.h.

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

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: