KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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=nullptr)
 
 ~SESSION ()
 
void Format (OUTPUTFORMATTER *out, int nestLevel) override
 Write this object 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 FormatContents (OUTPUTFORMATTER *out, int nestLevel)
 Write the contents 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

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

Constructor & Destructor Documentation

◆ SESSION()

DSN::SESSION::SESSION ( ELEM * aParent = nullptr)
inline

Definition at line 3581 of file specctra.h.

References DSN::ELEM::ELEM(), history, placement, route, structure, and was_is.

◆ ~SESSION()

DSN::SESSION::~SESSION ( )
inline

Definition at line 3591 of file specctra.h.

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

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

Referenced by 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::CLASS_CLASS, DSN::CLASSES, DSN::COMPONENT, DSN::ELEM_HOLDER, DSN::HISTORY, DSN::IMAGE, DSN::LIBRARY, DSN::NETWORK, DSN::PADSTACK, DSN::PARSER, DSN::PLACEMENT, DSN::REGION, DSN::ROUTE, DSN::STRUCTURE, DSN::STRUCTURE_OUT, DSN::TOPOLOGY, DSN::WAS_IS, and DSN::WIRING.

Definition at line 247 of file specctra.h.

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

Definition at line 3773 of file specctra.cpp.

References DSN::UNIT_RES::Default, and parent.

Referenced by DSN::SPECCTRA_DB::FromSESSION(), DSN::IMAGE::GetUnits(), DSN::LIBRARY::GetUnits(), DSN::PADSTACK::GetUnits(), DSN::PCB::GetUnits(), DSN::PLACEMENT::GetUnits(), DSN::ROUTE::GetUnits(), DSN::STRUCTURE::GetUnits(), and DSN::WIRING::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 268 of file specctra.h.

References FormatContents(), and sf.

Referenced by DSN::IMAGE::Compare(), and DSN::PADSTACK::Compare().

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Symbol Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 3626 of file specctra.h.

References SPECCTRA_DB.

Referenced by SPECCTRA_DB.

Member Data Documentation

◆ base_design

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

Definition at line 3629 of file specctra.h.

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

◆ history

HISTORY* DSN::SESSION::history
private

Definition at line 3631 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 281 of file specctra.h.

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

◆ placement

PLACEMENT* DSN::SESSION::placement
private

Definition at line 3633 of file specctra.h.

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

◆ route

ROUTE* DSN::SESSION::route
private

Definition at line 3635 of file specctra.h.

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

◆ session_id

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

Definition at line 3628 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 278 of file specctra.h.

Referenced by makeHash().

◆ structure

STRUCTURE* DSN::SESSION::structure
private

Definition at line 3632 of file specctra.h.

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

◆ type

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 280 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), ELEM(), DSN::UNIT_RES::Format(), Name(), and Type().

◆ was_is

WAS_IS* DSN::SESSION::was_is
private

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