KiCad PCB EDA Suite
Loading...
Searching...
No Matches
DSN::HISTORY Class Reference

#include <specctra.h>

Inheritance diagram for DSN::HISTORY:
DSN::ELEM

Public Member Functions

 HISTORY (ELEM *aParent)
 
void FormatContents (OUTPUTFORMATTER *out, int nestLevel) override
 Write the contents 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 Format (OUTPUTFORMATTER *out, int nestLevel)
 Write this object 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

ANCESTORS ancestors
 
time_t time_stamp
 
STRINGS comments
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 3300 of file specctra.h.

Constructor & Destructor Documentation

◆ HISTORY()

DSN::HISTORY::HISTORY ( ELEM aParent)
inline

Definition at line 3303 of file specctra.h.

References time_stamp.

Member Function Documentation

◆ Format()

◆ FormatContents()

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

References ancestors, comments, OUTPUTFORMATTER::GetQuoteChar(), OUTPUTFORMATTER::Print(), and time_stamp.

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

Definition at line 3764 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().

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

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 3333 of file specctra.h.

Member Data Documentation

◆ ancestors

ANCESTORS DSN::HISTORY::ancestors
private

Definition at line 3335 of file specctra.h.

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

◆ comments

STRINGS DSN::HISTORY::comments
private

Definition at line 3337 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 275 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 272 of file specctra.h.

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

◆ time_stamp

time_t DSN::HISTORY::time_stamp
private

Definition at line 3336 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doHISTORY(), FormatContents(), and HISTORY().

◆ type

DSN_T DSN::ELEM::type
protectedinherited

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