KiCad PCB EDA Suite
DSN::SESSION Class Reference

A <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
 Write 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
 Return the units for this section. More...
 
virtual void FormatContents (OUTPUTFORMATTER *out, int nestLevel)
 Write 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 ()
 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
 
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

A <session_file_descriptor> in the specctra dsn spec.

Definition at line 3575 of file specctra.h.

Constructor & Destructor Documentation

◆ SESSION()

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

Definition at line 3578 of file specctra.h.

3578  :
3579  ELEM( T_session, aParent )
3580  {
3581  history = 0;
3582  structure = 0;
3583  placement = 0;
3584  was_is = 0;
3585  route = 0;
3586  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749
STRUCTURE * structure
Definition: specctra.h:3629
PLACEMENT * placement
Definition: specctra.h:3630
ROUTE * route
Definition: specctra.h:3632
HISTORY * history
Definition: specctra.h:3628
WAS_IS * was_is
Definition: specctra.h:3631

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

◆ ~SESSION()

DSN::SESSION::~SESSION ( )
inline

Definition at line 3588 of file specctra.h.

3589  {
3590  delete history;
3591  delete structure;
3592  delete placement;
3593  delete was_is;
3594  delete route;
3595  }
STRUCTURE * structure
Definition: specctra.h:3629
PLACEMENT * placement
Definition: specctra.h:3630
ROUTE * route
Definition: specctra.h:3632
HISTORY * history
Definition: specctra.h:3628
WAS_IS * was_is
Definition: specctra.h:3631

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

Member Function Documentation

◆ Format()

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

3598  {
3599  const char* quote = out->GetQuoteChar( session_id.c_str() );
3600  out->Print( nestLevel, "(%s %s%s%s\n", Name(), quote, session_id.c_str(), quote );
3601 
3602  out->Print( nestLevel+1, "(base_design \"%s\")\n", base_design.c_str() );
3603 
3604  if( history )
3605  history->Format( out, nestLevel+1 );
3606 
3607  if( structure )
3608  structure->Format( out, nestLevel+1 );
3609 
3610  if( placement )
3611  placement->Format( out, nestLevel+1 );
3612 
3613  if( was_is )
3614  was_is->Format( out, nestLevel+1 );
3615 
3616  if( route )
3617  route->Format( out, nestLevel+1 );
3618 
3619  out->Print( nestLevel, ")\n" );
3620  }
std::string base_design
Definition: specctra.h:3626
const char * Name() const
Definition: specctra.cpp:3760
STRUCTURE * structure
Definition: specctra.h:3629
std::string session_id
Definition: specctra.h:3625
virtual void Format(OUTPUTFORMATTER *out, int nestLevel)
Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.cpp:3774
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:348
PLACEMENT * placement
Definition: specctra.h:3630
ROUTE * route
Definition: specctra.h:3632
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426
HISTORY * history
Definition: specctra.h:3628
WAS_IS * was_is
Definition: specctra.h:3631

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

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

243  {
244  // overridden in ELEM_HOLDER
245  }

Referenced by DSN::ELEM::Format(), and DSN::ELEM::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::ROUTE, DSN::PCB, DSN::WIRING, DSN::LIBRARY, DSN::PADSTACK, DSN::IMAGE, DSN::PLACEMENT, and DSN::STRUCTURE.

Definition at line 3765 of file specctra.cpp.

3766 {
3767  if( parent )
3768  return parent->GetUnits();
3769 
3770  return &UNIT_RES::Default;
3771 }
ELEM * parent
Definition: specctra.h:276
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:410
virtual UNIT_RES * GetUnits() const
Return the units for this section.
Definition: specctra.cpp:3765

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.

264  {
265  sf.Clear();
266  FormatContents( &sf, 0 );
267  sf.StripUseless();
268 
269  return sf.GetString();
270  }
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:242
const std::string & GetString()
Definition: richio.h:438
void StripUseless()
Removes whitespace, '(', and ')' from the string.
Definition: richio.cpp:512
static STRING_FORMATTER sf
Definition: specctra.h:273
void Clear()
Clear the buffer and empties the internal string.
Definition: richio.h:428

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

Member Data Documentation

◆ base_design

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

Definition at line 3626 of file specctra.h.

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

◆ history

HISTORY* DSN::SESSION::history
private

Definition at line 3628 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 276 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 3625 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 273 of file specctra.h.

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

◆ structure

STRUCTURE* DSN::SESSION::structure
private

Definition at line 3629 of file specctra.h.

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

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

◆ was_is

WAS_IS* DSN::SESSION::was_is
private

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