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

A <wire_shape_descriptor> in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::WIRE:
DSN::ELEM

Public Member Functions

 WIRE (ELEM *aParent)
 
 ~WIRE ()
 
void SetShape (ELEM *aShape)
 
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

ELEMm_shape
 
std::string m_net_id
 
int m_turret
 
DSN_T m_wire_type
 
DSN_T m_attr
 
std::string m_shield
 
WINDOWS m_windows
 
CONNECTm_connect
 
bool m_supply
 

Friends

class SPECCTRA_DB
 

Detailed Description

A <wire_shape_descriptor> in the specctra dsn spec.

Definition at line 2873 of file specctra.h.

Constructor & Destructor Documentation

◆ WIRE()

DSN::WIRE::WIRE ( ELEM aParent)
inline

Definition at line 2876 of file specctra.h.

References m_attr, m_connect, m_shape, m_supply, m_turret, and m_wire_type.

◆ ~WIRE()

DSN::WIRE::~WIRE ( )
inline

Definition at line 2888 of file specctra.h.

References m_connect, and m_shape.

Member Function Documentation

◆ Format()

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

References DSN::ELEM::Format(), OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), m_attr, m_connect, m_net_id, m_shape, m_shield, m_supply, m_turret, m_windows, m_wire_type, 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()

◆ SetShape()

void DSN::WIRE::SetShape ( ELEM aShape)
inline

Definition at line 2894 of file specctra.h.

References m_shape, DSN::ELEM::SetParent(), and DSN::ELEM::Type().

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

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 2955 of file specctra.h.

Member Data Documentation

◆ m_attr

DSN_T DSN::WIRE::m_attr
private

Definition at line 2969 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRE(), Format(), and WIRE().

◆ m_connect

CONNECT* DSN::WIRE::m_connect
private

Definition at line 2972 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRE(), Format(), WIRE(), and ~WIRE().

◆ m_net_id

std::string DSN::WIRE::m_net_id
private

Definition at line 2966 of file specctra.h.

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

◆ m_shape

ELEM* DSN::WIRE::m_shape
private

◆ m_shield

std::string DSN::WIRE::m_shield
private

Definition at line 2970 of file specctra.h.

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

◆ m_supply

bool DSN::WIRE::m_supply
private

Definition at line 2973 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRE(), Format(), and WIRE().

◆ m_turret

int DSN::WIRE::m_turret
private

Definition at line 2967 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRE(), Format(), and WIRE().

◆ m_windows

WINDOWS DSN::WIRE::m_windows
private

Definition at line 2971 of file specctra.h.

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

◆ m_wire_type

DSN_T DSN::WIRE::m_wire_type
private

◆ 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: