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

#include <specctra.h>

Inheritance diagram for DSN::LAYER:
DSN::ELEM

Public Member Functions

 LAYER (ELEM *aParent)
 
 ~LAYER ()
 
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 name
 
DSN_T layer_type
 one of: T_signal, T_power, T_mixed, T_jumper
 
int direction
 [forbidden | high | medium | low | free | <positive_integer> | -1]
 
int cost
 
int cost_type
 T_length | T_way.
 
RULErules
 
STRINGS use_net
 
PROPERTIES properties
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 1200 of file specctra.h.

Constructor & Destructor Documentation

◆ LAYER()

DSN::LAYER::LAYER ( ELEM aParent)
inline

Definition at line 1203 of file specctra.h.

References cost, cost_type, direction, layer_type, and rules.

◆ ~LAYER()

DSN::LAYER::~LAYER ( )
inline

Definition at line 1214 of file specctra.h.

References rules.

Member Function Documentation

◆ Format()

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

References cost, cost_type, direction, DSN::RULE::Format(), OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), layer_type, DSN::ELEM::Name(), name, OUTPUTFORMATTER::Print(), properties, rules, and use_net.

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

Member Data Documentation

◆ cost

int DSN::LAYER::cost
private

Definition at line 1282 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLAYER(), Format(), and LAYER().

◆ cost_type

int DSN::LAYER::cost_type
private

T_length | T_way.

Definition at line 1283 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLAYER(), Format(), and LAYER().

◆ direction

int DSN::LAYER::direction
private

[forbidden | high | medium | low | free | <positive_integer> | -1]

Definition at line 1279 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLAYER(), Format(), and LAYER().

◆ layer_type

DSN_T DSN::LAYER::layer_type
private

one of: T_signal, T_power, T_mixed, T_jumper

Definition at line 1278 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLAYER(), Format(), DSN::SPECCTRA_DB::FromBOARD(), and LAYER().

◆ name

std::string DSN::LAYER::name
private

Definition at line 1277 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLAYER(), Format(), and DSN::SPECCTRA_DB::FromBOARD().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 275 of file specctra.h.

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

◆ properties

PROPERTIES DSN::LAYER::properties
private

Definition at line 1287 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLAYER(), Format(), and DSN::SPECCTRA_DB::FromBOARD().

◆ rules

RULE* DSN::LAYER::rules
private

Definition at line 1284 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLAYER(), Format(), LAYER(), and ~LAYER().

◆ 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

◆ use_net

STRINGS DSN::LAYER::use_net
private

Definition at line 1285 of file specctra.h.

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


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