KiCad PCB EDA Suite
DSN::SESSION Class Reference

SESSION corresponds to the <session_file_descriptor> in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::SESSION:
DSN::ELEM

Public Member Functions

 SESSION (ELEM *aParent=0)
 
 ~SESSION ()
 
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 session_id
 
std::string base_design
 
HISTORYhistory
 
STRUCTUREstructure
 
PLACEMENTplacement
 
WAS_ISwas_is
 
ROUTEroute
 

Friends

class SPECCTRA_DB
 

Detailed Description

SESSION corresponds to the <session_file_descriptor> in the specctra dsn spec.

Definition at line 3559 of file specctra.h.

Constructor & Destructor Documentation

◆ SESSION()

DSN::SESSION::SESSION ( ELEM aParent = 0)
inline

Definition at line 3580 of file specctra.h.

3580  :
3581  ELEM( T_session, aParent )
3582  {
3583  history = 0;
3584  structure = 0;
3585  placement = 0;
3586  was_is = 0;
3587  route = 0;
3588  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
STRUCTURE * structure
Definition: specctra.h:3567
PLACEMENT * placement
Definition: specctra.h:3568
ROUTE * route
Definition: specctra.h:3570
HISTORY * history
Definition: specctra.h:3566
WAS_IS * was_is
Definition: specctra.h:3569

References history, placement, route, structure, and was_is.

◆ ~SESSION()

DSN::SESSION::~SESSION ( )
inline

Definition at line 3589 of file specctra.h.

3590  {
3591  delete history;
3592  delete structure;
3593  delete placement;
3594  delete was_is;
3595  delete route;
3596  }
STRUCTURE * structure
Definition: specctra.h:3567
PLACEMENT * placement
Definition: specctra.h:3568
ROUTE * route
Definition: specctra.h:3570
HISTORY * history
Definition: specctra.h:3566
WAS_IS * was_is
Definition: specctra.h:3569

References history, placement, route, structure, and was_is.

Member Function Documentation

◆ Format()

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

3599  {
3600  const char* quote = out->GetQuoteChar( session_id.c_str() );
3601  out->Print( nestLevel, "(%s %s%s%s\n", Name(),
3602  quote, session_id.c_str(), quote );
3603 
3604  out->Print( nestLevel+1, "(base_design \"%s\")\n", base_design.c_str() );
3605 
3606  if( history )
3607  history->Format( out, nestLevel+1 );
3608 
3609  if( structure )
3610  structure->Format( out, nestLevel+1 );
3611 
3612  if( placement )
3613  placement->Format( out, nestLevel+1 );
3614 
3615  if( was_is )
3616  was_is->Format( out, nestLevel+1 );
3617 
3618  if( route )
3619  route->Format( out, nestLevel+1 );
3620 
3621  out->Print( nestLevel, ")\n" );
3622  }
std::string base_design
Definition: specctra.h:3564
const char * Name() const
Definition: specctra.cpp:3505
STRUCTURE * structure
Definition: specctra.h:3567
std::string session_id
Definition: specctra.h:3563
virtual void Format(OUTPUTFORMATTER *out, int nestLevel)
Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN f...
Definition: specctra.cpp:3519
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
PLACEMENT * placement
Definition: specctra.h:3568
ROUTE * route
Definition: specctra.h:3570
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408
HISTORY * history
Definition: specctra.h:3566
WAS_IS * was_is
Definition: specctra.h:3569

References base_design, DSN::ELEM::Format(), OUTPUTFORMATTER::GetQuoteChar(), history, DSN::ELEM::Name(), placement, OUTPUTFORMATTER::Print(), route, session_id, structure, and was_is.

Referenced by DSN::SPECCTRA_DB::ExportSESSION(), and main().

◆ FormatContents()

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

264  {
265  // overridden in ELEM_HOLDER
266  }

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

◆ GetUnits()

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

3511 {
3512  if( parent )
3513  return parent->GetUnits();
3514 
3515  return &UNIT_RES::Default;
3516 }
ELEM * parent
Definition: specctra.h:199
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:413
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3510

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

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

Member Data Documentation

◆ base_design

std::string DSN::SESSION::base_design
private

Definition at line 3564 of file specctra.h.

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

◆ history

HISTORY* DSN::SESSION::history
private

Definition at line 3566 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSESSION(), Format(), SESSION(), and ~SESSION().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

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

◆ placement

PLACEMENT* DSN::SESSION::placement
private

◆ route

ROUTE* DSN::SESSION::route
private

◆ session_id

std::string DSN::SESSION::session_id
private

Definition at line 3563 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

◆ structure

STRUCTURE* DSN::SESSION::structure
private

Definition at line 3567 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSESSION(), Format(), SESSION(), and ~SESSION().

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

◆ was_is

WAS_IS* DSN::SESSION::was_is
private

Definition at line 3569 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSESSION(), Format(), SESSION(), and ~SESSION().


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