KiCad PCB EDA Suite
Loading...
Searching...
No Matches
DSN::CLASS Class Reference

The <class_descriptor> in the specctra spec. More...

#include <specctra.h>

Inheritance diagram for DSN::CLASS:
DSN::ELEM

Public Member Functions

 CLASS (ELEM *aParent)
 
 ~CLASS ()
 
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 m_class_id
 
STRINGS m_net_ids
 
STRINGS m_circuit
 circuit descriptor list More...
 
RULEm_rules
 
LAYER_RULES m_layer_rules
 
TOPOLOGYm_topology
 

Friends

class SPECCTRA_DB
 

Detailed Description

The <class_descriptor> in the specctra spec.

Definition at line 2746 of file specctra.h.

Constructor & Destructor Documentation

◆ CLASS()

DSN::CLASS::CLASS ( ELEM aParent)
inline

Definition at line 2749 of file specctra.h.

References m_rules, and m_topology.

◆ ~CLASS()

DSN::CLASS::~CLASS ( )
inline

Definition at line 2756 of file specctra.h.

References m_rules, and m_topology.

Member Function Documentation

◆ Format()

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

References DSN::ELEM::Format(), DSN::RULE::Format(), OUTPUTFORMATTER::GetQuoteChar(), m_circuit, m_class_id, m_layer_rules, m_net_ids, m_rules, m_topology, DSN::ELEM::Name(), and OUTPUTFORMATTER::Print().

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

Definition at line 241 of file specctra.h.

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

Definition at line 3764 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().

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

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 2816 of file specctra.h.

Member Data Documentation

◆ m_circuit

STRINGS DSN::CLASS::m_circuit
private

circuit descriptor list

Definition at line 2823 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doCLASS(), DSN::SPECCTRA_DB::exportNETCLASS(), and Format().

◆ m_class_id

std::string DSN::CLASS::m_class_id
private

◆ m_layer_rules

LAYER_RULES DSN::CLASS::m_layer_rules
private

Definition at line 2827 of file specctra.h.

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

◆ m_net_ids

STRINGS DSN::CLASS::m_net_ids
private

◆ m_rules

RULE* DSN::CLASS::m_rules
private

◆ m_topology

TOPOLOGY* DSN::CLASS::m_topology
private

Definition at line 2829 of file specctra.h.

Referenced by CLASS(), DSN::SPECCTRA_DB::doCLASS(), Format(), and ~CLASS().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 275 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 272 of file specctra.h.

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

◆ type

DSN_T DSN::ELEM::type
protectedinherited

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