KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 m_connect
 
WINDOWS m_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 1892 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 1898 of file specctra.h.

References m_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 1909 of file specctra.h.

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

◆ 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::ELEM_HOLDER, DSN::PARSER, DSN::CLASSES, DSN::CLASS_CLASS, DSN::REGION, DSN::STRUCTURE_OUT, DSN::STRUCTURE, DSN::COMPONENT, DSN::PLACEMENT, DSN::IMAGE, DSN::PADSTACK, DSN::LIBRARY, DSN::TOPOLOGY, DSN::NETWORK, DSN::WIRING, DSN::HISTORY, DSN::ROUTE, and DSN::WAS_IS.

Definition at line 241 of file specctra.h.

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

Definition at line 3764 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().

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

◆ Name()

◆ SetConnect()

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

Definition at line 1904 of file specctra.h.

References m_connect.

◆ SetParent()

◆ SetShape()

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

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1935 of file specctra.h.

Member Data Documentation

◆ m_connect

DSN_T DSN::SHAPE::m_connect
private

Definition at line 1937 of file specctra.h.

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

◆ m_windows

WINDOWS DSN::SHAPE::m_windows
private

Definition at line 1948 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 275 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 272 of file specctra.h.

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

◆ shape

◆ type

DSN_T DSN::ELEM::type
protectedinherited

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