KiCad PCB EDA Suite
DSN::WIRE Class Reference

WIRE corresponds to <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
 Function Format writes 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
 Function GetUnits returns the units for this section. More...
 
virtual void FormatContents (OUTPUTFORMATTER *out, int nestLevel)
 Function FormatContents writes 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 ()
 Function makeHash returns a string which uniquely represents this ELEM amoung 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

ELEMshape
 
std::string net_id
 
int turret
 
DSN_T wire_type
 
DSN_T attr
 
std::string shield
 
WINDOWS windows
 
CONNECTconnect
 
bool supply
 

Friends

class SPECCTRA_DB
 

Detailed Description

WIRE corresponds to <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 2896 of file specctra.h.

2896  :
2897  ELEM( T_wire, aParent )
2898  {
2899  shape = 0;
2900  connect = 0;
2901 
2902  turret = -1;
2903  wire_type = T_NONE;
2904  attr = T_NONE;
2905  supply = false;
2906  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
DSN_T attr
Definition: specctra.h:2889
bool supply
Definition: specctra.h:2893
int turret
Definition: specctra.h:2887
ELEM * shape
Definition: specctra.h:2884
DSN_T wire_type
Definition: specctra.h:2888
CONNECT * connect
Definition: specctra.h:2892

References attr, connect, shape, supply, turret, and wire_type.

◆ ~WIRE()

DSN::WIRE::~WIRE ( )
inline

Definition at line 2908 of file specctra.h.

2909  {
2910  delete shape;
2911  delete connect;
2912  }
ELEM * shape
Definition: specctra.h:2884
CONNECT * connect
Definition: specctra.h:2892

References connect, and shape.

Member Function Documentation

◆ Format()

void DSN::WIRE::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
inlineoverridevirtual

Function Format writes 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 preceed the output with.
Exceptions
IO_ERRORif a system error writing the output, such as a full disk.

Reimplemented from DSN::ELEM.

Definition at line 2929 of file specctra.h.

2930  {
2931  out->Print( nestLevel, "(%s ", Name() );
2932 
2933  if( shape )
2934  shape->Format( out, 0 );
2935 
2936  if( net_id.size() )
2937  {
2938  const char* quote = out->GetQuoteChar( net_id.c_str() );
2939  out->Print( 0, "(net %s%s%s)",
2940  quote, net_id.c_str(), quote );
2941  }
2942 
2943  if( turret >= 0 )
2944  out->Print( 0, "(turrent %d)", turret );
2945 
2946  if( wire_type != T_NONE )
2947  out->Print( 0, "(type %s)", GetTokenText( wire_type ) );
2948 
2949  if( attr != T_NONE )
2950  out->Print( 0, "(attr %s)", GetTokenText( attr ) );
2951 
2952  if( shield.size() )
2953  {
2954  const char* quote = out->GetQuoteChar( shield.c_str() );
2955  out->Print( 0, "(shield %s%s%s)",
2956  quote, shield.c_str(), quote );
2957  }
2958 
2959  if( windows.size() )
2960  {
2961  out->Print( 0, "\n" );
2962 
2963  for( WINDOWS::iterator i=windows.begin(); i!=windows.end(); ++i )
2964  i->Format( out, nestLevel+1 );
2965  }
2966 
2967  if( connect )
2968  connect->Format( out, 0 );
2969 
2970  if( supply )
2971  out->Print( 0, "(supply)" );
2972 
2973  out->Print( 0, ")\n" );
2974  }
std::string shield
Definition: specctra.h:2890
DSN_T attr
Definition: specctra.h:2889
const char * Name() const
Definition: specctra.cpp:3505
bool supply
Definition: specctra.h:2893
int turret
Definition: specctra.h:2887
ELEM * shape
Definition: specctra.h:2884
WINDOWS windows
Definition: specctra.h:2891
virtual void Format(OUTPUTFORMATTER *out, int nestLevel)
Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN f...
Definition: specctra.cpp:3519
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:331
const char * GetTokenText(T aTok)
Function GetTokenText is in the DSN namespace and returns the C string representing a SPECCTRA_DB::ke...
Definition: specctra.cpp:69
DSN_T wire_type
Definition: specctra.h:2888
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408
CONNECT * connect
Definition: specctra.h:2892
std::string net_id
Definition: specctra.h:2886

References attr, connect, DSN::ELEM::Format(), OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), DSN::ELEM::Name(), net_id, OUTPUTFORMATTER::Print(), shape, shield, supply, turret, windows, and wire_type.

◆ FormatContents()

virtual void DSN::ELEM::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
inlinevirtualinherited

Function FormatContents writes 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 preceed 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 263 of file specctra.h.

264  {
265  // overridden in ELEM_HOLDER
266  }

Referenced by DSN::ELEM::Format(), and DSN::ELEM::makeHash().

◆ GetUnits()

UNIT_RES * DSN::ELEM::GetUnits ( ) const
virtualinherited

Function GetUnits returns the units for this section.

Derived classes may override this to check for section specific overrides.

Returns
UNIT_RES* - 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 3510 of file specctra.cpp.

3511 {
3512  if( parent )
3513  return parent->GetUnits();
3514 
3515  return &UNIT_RES::Default;
3516 }
ELEM * parent
Definition: specctra.h:199
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:413
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3510

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

Function makeHash returns a string which uniquely represents this ELEM amoung other ELEMs of the same derived class as "this" one.

It is not useable 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 211 of file specctra.h.

212  {
213  sf.Clear();
214  FormatContents( &sf, 0 );
215  sf.StripUseless();
216 
217  return sf.GetString();
218  }
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECC...
Definition: specctra.h:263
const std::string & GetString()
Definition: richio.h:435
void StripUseless()
Removes whitespace, '(', and ')' from the string.
Definition: richio.cpp:494
static STRING_FORMATTER sf
Definition: specctra.h:221
void Clear()
Clear the buffer and empties the internal string.
Definition: richio.h:425

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

2915  {
2916  delete shape;
2917  shape = aShape;
2918 
2919  if( aShape )
2920  {
2921  wxASSERT(aShape->Type()==T_rect || aShape->Type()==T_circle
2922  || aShape->Type()==T_qarc || aShape->Type()==T_path
2923  || aShape->Type()==T_polygon);
2924 
2925  aShape->SetParent( this );
2926  }
2927  }
ELEM * shape
Definition: specctra.h:2884
void SetParent(ELEM *aParent)
Definition: specctra.h:268

References DSN::ELEM::SetParent(), shape, 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 2875 of file specctra.h.

Member Data Documentation

◆ attr

DSN_T DSN::WIRE::attr
private

Definition at line 2889 of file specctra.h.

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

◆ connect

CONNECT* DSN::WIRE::connect
private

Definition at line 2892 of file specctra.h.

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

◆ net_id

std::string DSN::WIRE::net_id
private

Definition at line 2886 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

◆ shape

ELEM* DSN::WIRE::shape
private

◆ shield

std::string DSN::WIRE::shield
private

Definition at line 2890 of file specctra.h.

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

◆ supply

bool DSN::WIRE::supply
private

Definition at line 2893 of file specctra.h.

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

◆ turret

int DSN::WIRE::turret
private

Definition at line 2887 of file specctra.h.

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

◆ type

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 198 of file specctra.h.

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

◆ windows

WINDOWS DSN::WIRE::windows
private

Definition at line 2891 of file specctra.h.

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

◆ wire_type

DSN_T DSN::WIRE::wire_type
private

Definition at line 2888 of file specctra.h.

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


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