KiCad PCB EDA Suite
DSN::SHAPE Class Reference

Class SHAPE corresponds to the "(shape ..)" element in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::SHAPE:
DSN::WINDOW DSN::ELEM

Public Member Functions

 SHAPE (ELEM *aParent, DSN_T aType=T_shape)
 Constructor SHAPE alternatively takes a DSN_T aType of T_outline. More...
 
void SetConnect (DSN_T aConnect)
 
void Format (OUTPUTFORMATTER *out, int nestLevel) override throw ( IO_ERROR )
 Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
void SetShape (ELEM *aShape)
 
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) throw ( IO_ERROR )
 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

ELEMshape
 
DSN_T type
 
ELEMparent
 

Static Protected Attributes

static STRING_FORMATTER sf
 

Private Attributes

DSN_T connect
 
WINDOWS windows
 

Friends

class SPECCTRA_DB
 

Detailed Description

Class SHAPE corresponds to the "(shape ..)" element in the specctra dsn spec.

It is not a <shape_descriptor>, which is one of things that this elements contains, i.e. in its "shape" field. This class also implements the "(outline ...)" element as a dual personality.

Definition at line 1860 of file specctra.h.

Constructor & Destructor Documentation

DSN::SHAPE::SHAPE ( ELEM aParent,
DSN_T  aType = T_shape 
)
inline

Constructor SHAPE alternatively takes a DSN_T aType of T_outline.

Definition at line 1883 of file specctra.h.

References DSN::T_on.

1883  :
1884  WINDOW( aParent, aType )
1885  {
1886  connect = T_on;
1887  }
DSN_T connect
Definition: specctra.h:1864
WINDOW(ELEM *aParent, DSN_T aType=T_window)
Definition: specctra.h:841

Member Function Documentation

void DSN::SHAPE::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
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::WINDOW.

Definition at line 1894 of file specctra.h.

References DSN::ELEM::Format(), DSN::GetTokenText(), DSN::ELEM::Name(), and DSN::T_off.

1895  {
1896  out->Print( nestLevel, "(%s ", Name() );
1897 
1898  if( shape )
1899  shape->Format( out, 0 );
1900 
1901  if( connect == T_off )
1902  out->Print( 0, "(connect %s)", GetTokenText( connect ) );
1903 
1904  if( windows.size() )
1905  {
1906  out->Print( 0, "\n" );
1907 
1908  for( WINDOWS::iterator i=windows.begin(); i!=windows.end(); ++i )
1909  i->Format( out, nestLevel+1 );
1910 
1911  out->Print( nestLevel, ")\n" );
1912  }
1913  else
1914  out->Print( 0, ")\n" );
1915  }
const char * Name() const
Definition: specctra.cpp:3497
DSN_T connect
Definition: specctra.h:1864
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:3511
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
ELEM * shape
Definition: specctra.h:837
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
WINDOWS windows
Definition: specctra.h:1875
virtual void DSN::ELEM::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
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::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 3502 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().

3503 {
3504  if( parent )
3505  return parent->GetUnits();
3506 
3507  return &UNIT_RES::Default;
3508 }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3502
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:504
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::SHAPE::SetConnect ( DSN_T  aConnect)
inline

Definition at line 1889 of file specctra.h.

1890  {
1891  connect = aConnect;
1892  }
DSN_T connect
Definition: specctra.h:1864
void DSN::WINDOW::SetShape ( ELEM aShape)
inlineinherited

Definition at line 852 of file specctra.h.

References DSN::ELEM::SetParent(), DSN::WINDOW::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(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), and DSN::SPECCTRA_DB::makeVia().

853  {
854  delete shape;
855  shape = aShape;
856 
857  if( aShape )
858  {
859  wxASSERT(aShape->Type()==T_rect || aShape->Type()==T_circle
860  || aShape->Type()==T_qarc || aShape->Type()==T_path
861  || aShape->Type()==T_polygon);
862 
863  aShape->SetParent( this );
864  }
865  }
ELEM * shape
Definition: specctra.h:837
void SetParent(ELEM *aParent)
Definition: specctra.h:269

Friends And Related Function Documentation

friend class SPECCTRA_DB
friend

Definition at line 1862 of file specctra.h.

Member Data Documentation

DSN_T DSN::SHAPE::connect
private

Definition at line 1864 of file specctra.h.

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::WINDOW::shape
protectedinherited
DSN_T DSN::ELEM::type
protectedinherited

Definition at line 199 of file specctra.h.

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

WINDOWS DSN::SHAPE::windows
private

Definition at line 1875 of file specctra.h.


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