KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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
 Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
 
DSN_T Type () const
 
const char * Name () const
 
virtual UNIT_RESGetUnits () const
 Return the units for this section.
 
virtual void FormatContents (OUTPUTFORMATTER *out, int nestLevel)
 Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
 
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.
 

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

Constructor & Destructor Documentation

◆ ANCESTOR()

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

Definition at line 3272 of file specctra.h.

References DSN::ELEM::ELEM(), and time_stamp.

Member Function Documentation

◆ Format()

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

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

Definition at line 3278 of file specctra.h.

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

◆ FormatContents()

virtual void DSN::ELEM::FormatContents ( OUTPUTFORMATTER * out,
int nestLevel )
inlinevirtualinherited

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

Definition at line 247 of file specctra.h.

Referenced by Format(), and makeHash().

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

Definition at line 3773 of file specctra.cpp.

References DSN::UNIT_RES::Default, and parent.

Referenced by DSN::SPECCTRA_DB::FromSESSION(), DSN::IMAGE::GetUnits(), DSN::LIBRARY::GetUnits(), DSN::PADSTACK::GetUnits(), DSN::PCB::GetUnits(), DSN::PLACEMENT::GetUnits(), DSN::ROUTE::GetUnits(), DSN::STRUCTURE::GetUnits(), and DSN::WIRING::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 268 of file specctra.h.

References FormatContents(), and sf.

Referenced by DSN::IMAGE::Compare(), and DSN::PADSTACK::Compare().

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Symbol Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 3300 of file specctra.h.

References SPECCTRA_DB.

Referenced by SPECCTRA_DB.

Member Data Documentation

◆ comment

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

Definition at line 3303 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doANCESTOR(), and Format().

◆ filename

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

Definition at line 3302 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doANCESTOR(), and Format().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 281 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 278 of file specctra.h.

Referenced by makeHash().

◆ time_stamp

time_t DSN::ANCESTOR::time_stamp
private

Definition at line 3304 of file specctra.h.

Referenced by ANCESTOR(), DSN::SPECCTRA_DB::doANCESTOR(), and Format().

◆ type

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 280 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), ELEM(), DSN::UNIT_RES::Format(), Name(), and Type().


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