KiCad PCB EDA Suite
DSN::WIRE Class Reference

Class 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

Class WIRE corresponds to <wire_shape_descriptor> in the specctra dsn spec.

Definition at line 2847 of file specctra.h.

Constructor & Destructor Documentation

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

Definition at line 2870 of file specctra.h.

References DSN::T_NONE.

2870  :
2871  ELEM( T_wire, aParent )
2872  {
2873  shape = 0;
2874  connect = 0;
2875 
2876  turret = -1;
2877  wire_type = T_NONE;
2878  attr = T_NONE;
2879  supply = false;
2880  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3490
DSN_T attr
Definition: specctra.h:2863
bool supply
Definition: specctra.h:2867
int turret
Definition: specctra.h:2861
ELEM * shape
Definition: specctra.h:2858
DSN_T wire_type
Definition: specctra.h:2862
CONNECT * connect
Definition: specctra.h:2866
DSN::WIRE::~WIRE ( )
inline

Definition at line 2882 of file specctra.h.

References connect, and shape.

2883  {
2884  delete shape;
2885  delete connect;
2886  }
ELEM * shape
Definition: specctra.h:2858
CONNECT * connect
Definition: specctra.h:2866

Member Function Documentation

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

References DSN::ELEM::Format(), OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), DSN::ELEM::Name(), OUTPUTFORMATTER::Print(), and DSN::T_NONE.

2904  {
2905  out->Print( nestLevel, "(%s ", Name() );
2906 
2907  if( shape )
2908  shape->Format( out, 0 );
2909 
2910  if( net_id.size() )
2911  {
2912  const char* quote = out->GetQuoteChar( net_id.c_str() );
2913  out->Print( 0, "(net %s%s%s)",
2914  quote, net_id.c_str(), quote );
2915  }
2916 
2917  if( turret >= 0 )
2918  out->Print( 0, "(turrent %d)", turret );
2919 
2920  if( wire_type != T_NONE )
2921  out->Print( 0, "(type %s)", GetTokenText( wire_type ) );
2922 
2923  if( attr != T_NONE )
2924  out->Print( 0, "(attr %s)", GetTokenText( attr ) );
2925 
2926  if( shield.size() )
2927  {
2928  const char* quote = out->GetQuoteChar( shield.c_str() );
2929  out->Print( 0, "(shield %s%s%s)",
2930  quote, shield.c_str(), quote );
2931  }
2932 
2933  if( windows.size() )
2934  {
2935  out->Print( 0, "\n" );
2936 
2937  for( WINDOWS::iterator i=windows.begin(); i!=windows.end(); ++i )
2938  i->Format( out, nestLevel+1 );
2939  }
2940 
2941  if( connect )
2942  connect->Format( out, 0 );
2943 
2944  if( supply )
2945  out->Print( 0, "(supply)" );
2946 
2947  out->Print( 0, ")\n" );
2948  }
std::string shield
Definition: specctra.h:2864
DSN_T attr
Definition: specctra.h:2863
bool supply
Definition: specctra.h:2867
int turret
Definition: specctra.h:2861
const char * Name() const
Definition: specctra.cpp:3501
ELEM * shape
Definition: specctra.h:2858
WINDOWS windows
Definition: specctra.h:2865
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:3515
static const char * GetQuoteChar(const char *wrapee, const char *quote_char)
Function GetQuoteChar performs quote character need determination according to the Specctra DSN speci...
Definition: richio.cpp:327
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:2862
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
CONNECT * connect
Definition: specctra.h:2866
std::string net_id
Definition: specctra.h:2860
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 264 of file specctra.h.

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

265  {
266  // overridden in ELEM_HOLDER
267  }
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 3506 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().

3507 {
3508  if( parent )
3509  return parent->GetUnits();
3510 
3511  return &UNIT_RES::Default;
3512 }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3506
ELEM * parent
Definition: specctra.h:200
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:414
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 212 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().

213  {
214  sf.Clear();
215  FormatContents( &sf, 0 );
216  sf.StripUseless();
217 
218  return sf.GetString();
219  }
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:264
const std::string & GetString()
Definition: richio.h:475
void StripUseless()
Function StripUseless removes whitespace, '(', and ')' from the mystring.
Definition: richio.cpp:500
static STRING_FORMATTER sf
Definition: specctra.h:222
void Clear()
Function Clear clears the buffer and empties the internal string.
Definition: richio.h:464
void DSN::WIRE::SetShape ( ELEM aShape)
inline

Definition at line 2888 of file specctra.h.

References DSN::ELEM::SetParent(), shape, DSN::T_circle, DSN::T_path, DSN::T_polygon, DSN::T_qarc, DSN::T_rect, and DSN::ELEM::Type().

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

2889  {
2890  delete shape;
2891  shape = aShape;
2892 
2893  if( aShape )
2894  {
2895  wxASSERT(aShape->Type()==T_rect || aShape->Type()==T_circle
2896  || aShape->Type()==T_qarc || aShape->Type()==T_path
2897  || aShape->Type()==T_polygon);
2898 
2899  aShape->SetParent( this );
2900  }
2901  }
ELEM * shape
Definition: specctra.h:2858
void SetParent(ELEM *aParent)
Definition: specctra.h:269

Friends And Related Function Documentation

friend class SPECCTRA_DB
friend

Definition at line 2849 of file specctra.h.

Member Data Documentation

DSN_T DSN::WIRE::attr
private

Definition at line 2863 of file specctra.h.

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

CONNECT* DSN::WIRE::connect
private

Definition at line 2866 of file specctra.h.

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

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

Definition at line 2860 of file specctra.h.

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

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

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

ELEM* DSN::WIRE::shape
private
std::string DSN::WIRE::shield
private

Definition at line 2864 of file specctra.h.

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

bool DSN::WIRE::supply
private

Definition at line 2867 of file specctra.h.

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

int DSN::WIRE::turret
private

Definition at line 2861 of file specctra.h.

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

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 199 of file specctra.h.

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

WINDOWS DSN::WIRE::windows
private

Definition at line 2865 of file specctra.h.

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

DSN_T DSN::WIRE::wire_type
private

Definition at line 2862 of file specctra.h.

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


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