KiCad PCB EDA Suite
DSN::SESSION Class Reference

Class 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

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

Definition at line 3530 of file specctra.h.

Constructor & Destructor Documentation

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

Definition at line 3551 of file specctra.h.

3551  :
3552  ELEM( T_session, aParent )
3553  {
3554  history = 0;
3555  structure = 0;
3556  placement = 0;
3557  was_is = 0;
3558  route = 0;
3559  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3486
STRUCTURE * structure
Definition: specctra.h:3538
PLACEMENT * placement
Definition: specctra.h:3539
ROUTE * route
Definition: specctra.h:3541
HISTORY * history
Definition: specctra.h:3537
WAS_IS * was_is
Definition: specctra.h:3540
DSN::SESSION::~SESSION ( )
inline

Definition at line 3560 of file specctra.h.

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

3561  {
3562  delete history;
3563  delete structure;
3564  delete placement;
3565  delete was_is;
3566  delete route;
3567  }
STRUCTURE * structure
Definition: specctra.h:3538
PLACEMENT * placement
Definition: specctra.h:3539
ROUTE * route
Definition: specctra.h:3541
HISTORY * history
Definition: specctra.h:3537
WAS_IS * was_is
Definition: specctra.h:3540

Member Function Documentation

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

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

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

3570  {
3571  const char* quote = out->GetQuoteChar( session_id.c_str() );
3572  out->Print( nestLevel, "(%s %s%s%s\n", Name(),
3573  quote, session_id.c_str(), quote );
3574 
3575  out->Print( nestLevel+1, "(base_design \"%s\")\n", base_design.c_str() );
3576 
3577  if( history )
3578  history->Format( out, nestLevel+1 );
3579 
3580  if( structure )
3581  structure->Format( out, nestLevel+1 );
3582 
3583  if( placement )
3584  placement->Format( out, nestLevel+1 );
3585 
3586  if( was_is )
3587  was_is->Format( out, nestLevel+1 );
3588 
3589  if( route )
3590  route->Format( out, nestLevel+1 );
3591 
3592  out->Print( nestLevel, ")\n" );
3593  }
std::string base_design
Definition: specctra.h:3535
STRUCTURE * structure
Definition: specctra.h:3538
const char * Name() const
Definition: specctra.cpp:3497
std::string session_id
Definition: specctra.h:3534
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:3511
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
PLACEMENT * placement
Definition: specctra.h:3539
ROUTE * route
Definition: specctra.h:3541
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
HISTORY * history
Definition: specctra.h:3537
WAS_IS * was_is
Definition: specctra.h:3540
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 3532 of file specctra.h.

Member Data Documentation

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

Definition at line 3535 of file specctra.h.

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

HISTORY* DSN::SESSION::history
private

Definition at line 3537 of file specctra.h.

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

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

PLACEMENT* DSN::SESSION::placement
private
ROUTE* DSN::SESSION::route
private
std::string DSN::SESSION::session_id
private

Definition at line 3534 of file specctra.h.

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

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

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

STRUCTURE* DSN::SESSION::structure
private

Definition at line 3538 of file specctra.h.

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

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

WAS_IS* DSN::SESSION::was_is
private

Definition at line 3540 of file specctra.h.

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


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