KiCad PCB EDA Suite
DSN::SHAPE Class Reference

A "(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)
 Takes a DSN_T aType of T_outline. More...
 
void SetConnect (DSN_T aConnect)
 
void Format (OUTPUTFORMATTER *out, int nestLevel) override
 Write 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
 Return the units for this section. More...
 
virtual void FormatContents (OUTPUTFORMATTER *out, int nestLevel)
 Write 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 ()
 Return a string which uniquely represents this ELEM among 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

A "(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 1893 of file specctra.h.

Constructor & Destructor Documentation

◆ SHAPE()

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

Takes a DSN_T aType of T_outline.

Definition at line 1899 of file specctra.h.

1899  :
1900  WINDOW( aParent, aType )
1901  {
1902  connect = T_on;
1903  }
DSN_T connect
Definition: specctra.h:1938
WINDOW(ELEM *aParent, DSN_T aType=T_window)
Definition: specctra.h:847

References connect.

Member Function Documentation

◆ Format()

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

Definition at line 1910 of file specctra.h.

1911  {
1912  out->Print( nestLevel, "(%s ", Name() );
1913 
1914  if( shape )
1915  shape->Format( out, 0 );
1916 
1917  if( connect == T_off )
1918  out->Print( 0, "(connect %s)", GetTokenText( connect ) );
1919 
1920  if( windows.size() )
1921  {
1922  out->Print( 0, "\n" );
1923 
1924  for( WINDOWS::iterator i=windows.begin(); i!=windows.end(); ++i )
1925  i->Format( out, nestLevel+1 );
1926 
1927  out->Print( nestLevel, ")\n" );
1928  }
1929  else
1930  {
1931  out->Print( 0, ")\n" );
1932  }
1933  }
const char * Name() const
Definition: specctra.cpp:3760
DSN_T connect
Definition: specctra.h:1938
virtual void Format(OUTPUTFORMATTER *out, int nestLevel)
Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.cpp:3774
const char * GetTokenText(T aTok)
The DSN namespace and returns the C string representing a SPECCTRA_DB::keyword.
Definition: specctra.cpp:70
ELEM * shape
Definition: specctra.h:893
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426
WINDOWS windows
Definition: specctra.h:1949

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

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

243  {
244  // overridden in ELEM_HOLDER
245  }

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::ROUTE, DSN::PCB, DSN::WIRING, DSN::LIBRARY, DSN::PADSTACK, DSN::IMAGE, DSN::PLACEMENT, and DSN::STRUCTURE.

Definition at line 3765 of file specctra.cpp.

3766 {
3767  if( parent )
3768  return parent->GetUnits();
3769 
3770  return &UNIT_RES::Default;
3771 }
ELEM * parent
Definition: specctra.h:276
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:410
virtual UNIT_RES * GetUnits() const
Return the units for this section.
Definition: specctra.cpp:3765

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

264  {
265  sf.Clear();
266  FormatContents( &sf, 0 );
267  sf.StripUseless();
268 
269  return sf.GetString();
270  }
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:242
const std::string & GetString()
Definition: richio.h:438
void StripUseless()
Removes whitespace, '(', and ')' from the string.
Definition: richio.cpp:512
static STRING_FORMATTER sf
Definition: specctra.h:273
void Clear()
Clear the buffer and empties the internal string.
Definition: richio.h:428

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

1906  {
1907  connect = aConnect;
1908  }
DSN_T connect
Definition: specctra.h:1938

References connect.

◆ SetParent()

◆ SetShape()

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

Definition at line 858 of file specctra.h.

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

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

Member Data Documentation

◆ connect

DSN_T DSN::SHAPE::connect
private

Definition at line 1938 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 276 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 273 of file specctra.h.

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

◆ shape

◆ type

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 275 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 1949 of file specctra.h.

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


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