DSN::HISTORY Class Reference

#include <specctra.h>

Inheritance diagram for DSN::HISTORY:

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. More...
DSN_T	Type () const
const char *	Name () const
virtual UNIT_RES *	GetUnits () const
	Return the units for this section. More...
virtual void	Format (OUTPUTFORMATTER *out, int nestLevel)
	Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
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. More...

Protected Attributes
DSN_T	type
ELEM *	parent

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

Constructor & Destructor Documentation

HISTORY()

DSN::HISTORY::HISTORY ( ELEM *  aParent )

inline

Definition at line 3310 of file specctra.h.

 :
 ELEM( T_history, aParent )
 {
 time_stamp = time(nullptr);
 }

References time_stamp.

Member Function Documentation

Format()

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

virtualinherited

Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.

Parameters

out	The formatter to write to.
nestLevel	A multiple of the number of spaces to precede the output with.

Exceptions

IO_ERROR

if a system error writing the output, such as a full disk.

Reimplemented in DSN::UNIT_RES, DSN::RECTANGLE, DSN::RULE, DSN::LAYER_RULE, DSN::PATH, DSN::BOUNDARY, DSN::CIRCLE, DSN::QARC, DSN::WINDOW, DSN::KEEPOUT, DSN::VIA, DSN::CONTROL, DSN::LAYER, DSN::SPECCTRA_LAYER_PAIR, DSN::LAYER_NOISE_WEIGHT, DSN::TOKPROP, DSN::STRINGPROP, DSN::GRID, DSN::PLACE, DSN::COMPONENT, DSN::SHAPE, DSN::PIN, DSN::IMAGE, DSN::PADSTACK, DSN::FROMTO, DSN::COMP_ORDER, DSN::NET, DSN::CLASS, DSN::WIRE, DSN::WIRE_VIA, DSN::PCB, DSN::ANCESTOR, DSN::SUPPLY_PIN, DSN::NET_OUT, and DSN::SESSION.

Definition at line 3774 of file specctra.cpp.

{
 out->Print( nestLevel, "(%s\n", Name() );
 
 FormatContents( out, nestLevel+1 );
 
 out->Print( nestLevel, ")\n" );
}

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

Referenced by DSN::WINDOW::Format(), DSN::KEEPOUT::Format(), DSN::CONTROL::Format(), DSN::PLACE::Format(), DSN::SHAPE::Format(), DSN::CLASS::Format(), DSN::WIRE::Format(), DSN::PCB::Format(), DSN::SESSION::Format(), DSN::ELEM_HOLDER::FormatContents(), DSN::CLASS_CLASS::FormatContents(), DSN::STRUCTURE::FormatContents(), and DSN::ROUTE::FormatContents().

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

out	The formatter to write to.
nestLevel	A multiple of the number of spaces to precede the output with.

Exceptions

IO_ERROR

if a system error writing the output, such as a full disk.

Reimplemented from DSN::ELEM.

Definition at line 3316 of file specctra.h.

 {
 for( ANCESTORS::iterator i=ancestors.begin(); i!=ancestors.end(); ++i )
 i->Format( out, nestLevel );
 
 char temp[80];
 struct tm* tmp;
 
 tmp = localtime( &time_stamp );
 strftime( temp, sizeof( temp ), "%b %d %H : %M : %S %Y", tmp );
 
 // format the time first to temp
 out->Print( nestLevel, "(self (created_time %s)\n", temp );
 
 for( STRINGS::iterator i=comments.begin(); i!=comments.end(); ++i )
 {
 const char* quote = out->GetQuoteChar( i->c_str() );
 out->Print( nestLevel+1, "(comment %s%s%s)\n", quote, i->c_str(), quote );
 }
 
 out->Print( nestLevel, ")\n" );
 }

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 3765 of file specctra.cpp.

{
 if( parent )
 return parent->GetUnits();
 
 return &UNIT_RES::Default;
}

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

 {
 sf.Clear();
 FormatContents( &sf, 0 );
 sf.StripUseless();
 
 return sf.GetString();
 }

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

const char * DSN::ELEM::Name ( ) const

inherited

Definition at line 3760 of file specctra.cpp.

{
 return SPECCTRA_DB::TokenName( type );
}

References DSN::ELEM::type.

Referenced by DSN::ELEM::Format(), DSN::UNIT_RES::Format(), DSN::RECTANGLE::Format(), DSN::RULE::Format(), DSN::LAYER_RULE::Format(), DSN::PATH::Format(), DSN::BOUNDARY::Format(), DSN::CIRCLE::Format(), DSN::QARC::Format(), DSN::WINDOW::Format(), DSN::KEEPOUT::Format(), DSN::VIA::Format(), DSN::CONTROL::Format(), DSN::LAYER::Format(), DSN::SPECCTRA_LAYER_PAIR::Format(), DSN::LAYER_NOISE_WEIGHT::Format(), DSN::TOKPROP::Format(), DSN::STRINGPROP::Format(), DSN::GRID::Format(), DSN::PLACE::Format(), DSN::COMPONENT::Format(), DSN::SHAPE::Format(), DSN::IMAGE::Format(), DSN::PADSTACK::Format(), DSN::FROMTO::Format(), DSN::COMP_ORDER::Format(), DSN::NET::Format(), DSN::CLASS::Format(), DSN::WIRE::Format(), DSN::WIRE_VIA::Format(), DSN::PCB::Format(), DSN::ANCESTOR::Format(), DSN::SUPPLY_PIN::Format(), and DSN::SESSION::Format().

SetParent()

void DSN::ELEM::SetParent ( ELEM *  aParent )

inlineinherited

Definition at line 247 of file specctra.h.

 {
 parent = aParent;
 }

References DSN::ELEM::parent.

Referenced by DSN::LIBRARY::AddPadstack(), DSN::KEEPOUT::AddWindow(), DSN::LIBRARY::AppendIMAGE(), DSN::LIBRARY::AppendPADSTACK(), DSN::LIBRARY::AppendVia(), DSN::STRUCTURE::SetBOUNDARY(), DSN::STRUCTURE::SetPlaceBOUNDARY(), DSN::WINDOW::SetShape(), DSN::KEEPOUT::SetShape(), and DSN::WIRE::SetShape().

Type()

DSN_T DSN::ELEM::Type ( ) const

inlineinherited

Definition at line 210 of file specctra.h.

{ return type; }

References DSN::ELEM::type.

Referenced by DSN::SPECCTRA_DB::doCLASS_CLASS(), DSN::ELEM_HOLDER::FindElem(), DSN::SPECCTRA_DB::FromSESSION(), DSN::SPECCTRA_DB::makeVIA(), DSN::WINDOW::SetShape(), DSN::KEEPOUT::SetShape(), and DSN::WIRE::SetShape().

Friends And Related Function Documentation

SPECCTRA_DB

friend class SPECCTRA_DB

friend

Definition at line 3340 of file specctra.h.

Member Data Documentation

ancestors

ANCESTORS DSN::HISTORY::ancestors

private

Definition at line 3342 of file specctra.h.

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

comments

STRINGS DSN::HISTORY::comments

private

Definition at line 3344 of file specctra.h.

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

parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 276 of file specctra.h.

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

sf

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 273 of file specctra.h.

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

time_stamp

time_t DSN::HISTORY::time_stamp

private

Definition at line 3343 of file specctra.h.

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

type

DSN_T DSN::ELEM::type

protectedinherited

Definition at line 275 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:

• specctra.h