KiCad PCB EDA Suite
DSN::SHAPE Class Reference

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
 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)
 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

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

Constructor & Destructor Documentation

◆ SHAPE()

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

1901  :
1902  WINDOW( aParent, aType )
1903  {
1904  connect = T_on;
1905  }
DSN_T connect
Definition: specctra.h:1882
WINDOW(ELEM *aParent, DSN_T aType=T_window)
Definition: specctra.h:850

References connect.

Member Function Documentation

◆ Format()

void DSN::SHAPE::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::WINDOW.

Definition at line 1912 of file specctra.h.

1913  {
1914  out->Print( nestLevel, "(%s ", Name() );
1915 
1916  if( shape )
1917  shape->Format( out, 0 );
1918 
1919  if( connect == T_off )
1920  out->Print( 0, "(connect %s)", GetTokenText( connect ) );
1921 
1922  if( windows.size() )
1923  {
1924  out->Print( 0, "\n" );
1925 
1926  for( WINDOWS::iterator i=windows.begin(); i!=windows.end(); ++i )
1927  i->Format( out, nestLevel+1 );
1928 
1929  out->Print( nestLevel, ")\n" );
1930  }
1931  else
1932  out->Print( 0, ")\n" );
1933  }
const char * Name() const
Definition: specctra.cpp:3505
DSN_T connect
Definition: specctra.h:1882
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
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:846
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408
WINDOWS windows
Definition: specctra.h:1893

References connect, DSN::ELEM::Format(), DSN::GetTokenText(), DSN::ELEM::Name(), OUTPUTFORMATTER::Print(), DSN::WINDOW::shape, and windows.

◆ 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()

◆ SetConnect()

void DSN::SHAPE::SetConnect ( DSN_T  aConnect)
inline

Definition at line 1907 of file specctra.h.

1908  {
1909  connect = aConnect;
1910  }
DSN_T connect
Definition: specctra.h:1882

References connect.

◆ SetParent()

◆ SetShape()

void DSN::WINDOW::SetShape ( ELEM aShape)
inlineinherited

Definition at line 861 of file specctra.h.

862  {
863  delete shape;
864  shape = aShape;
865 
866  if( aShape )
867  {
868  wxASSERT( aShape->Type()==T_rect
869  || aShape->Type()==T_circle
870  || aShape->Type()==T_qarc
871  || aShape->Type()==T_path
872  || aShape->Type()==T_polygon);
873 
874  aShape->SetParent( this );
875  }
876  }
ELEM * shape
Definition: specctra.h:846
void SetParent(ELEM *aParent)
Definition: specctra.h:268

References DSN::ELEM::SetParent(), DSN::WINDOW::shape, and DSN::ELEM::Type().

Referenced by DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), and DSN::SPECCTRA_DB::makeVia().

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1880 of file specctra.h.

Member Data Documentation

◆ connect

DSN_T DSN::SHAPE::connect
private

Definition at line 1882 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSHAPE(), Format(), SetConnect(), and SHAPE().

◆ 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

◆ 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::SHAPE::windows
private

Definition at line 1893 of file specctra.h.

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


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