KiCad PCB EDA Suite
DSN::PIN Class Reference

#include <specctra.h>

Inheritance diagram for DSN::PIN:
DSN::ELEM

Public Member Functions

 PIN (ELEM *aParent)
 
void SetRotation (double aRotation)
 
void SetVertex (const POINT &aPoint)
 
void Format (OUTPUTFORMATTER *out, int nestLevel) override
 Write 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
 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

DSN_T type
 
ELEMparent
 

Static Protected Attributes

static STRING_FORMATTER sf
 

Private Attributes

std::string padstack_id
 
double rotation
 
bool isRotated
 
std::string pin_id
 
POINT vertex
 
int kiNetCode
 KiCad netcode. More...
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 1953 of file specctra.h.

Constructor & Destructor Documentation

◆ PIN()

DSN::PIN::PIN ( ELEM aParent)
inline

Definition at line 1956 of file specctra.h.

1956  :
1957  ELEM( T_pin, aParent )
1958  {
1959  rotation = 0.0;
1960  isRotated = false;
1961  kiNetCode = 0;
1962  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749
int kiNetCode
KiCad netcode.
Definition: specctra.h:1998
bool isRotated
Definition: specctra.h:1994
double rotation
Definition: specctra.h:1993

References isRotated, kiNetCode, and rotation.

Member Function Documentation

◆ Format()

void DSN::PIN::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::ELEM.

Definition at line 1976 of file specctra.h.

1977  {
1978  const char* quote = out->GetQuoteChar( padstack_id.c_str() );
1979  if( isRotated )
1980  out->Print( nestLevel, "(pin %s%s%s (rotate %.6g)", quote, padstack_id.c_str(), quote,
1981  rotation );
1982  else
1983  out->Print( nestLevel, "(pin %s%s%s", quote, padstack_id.c_str(), quote );
1984 
1985  quote = out->GetQuoteChar( pin_id.c_str() );
1986  out->Print( 0, " %s%s%s %.6g %.6g)\n", quote, pin_id.c_str(), quote, vertex.x, vertex.y );
1987  }
std::string pin_id
Definition: specctra.h:1995
double y
Definition: specctra.h:105
double x
Definition: specctra.h:104
bool isRotated
Definition: specctra.h:1994
std::string padstack_id
Definition: specctra.h:1992
static const char * GetQuoteChar(const char *wrapee, const char *quote_char)
Perform quote character need determination according to the Specctra DSN specification.
Definition: richio.cpp:348
double rotation
Definition: specctra.h:1993
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426
POINT vertex
Definition: specctra.h:1996

References OUTPUTFORMATTER::GetQuoteChar(), isRotated, padstack_id, pin_id, OUTPUTFORMATTER::Print(), rotation, vertex, DSN::POINT::x, and DSN::POINT::y.

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

◆ SetParent()

◆ SetRotation()

void DSN::PIN::SetRotation ( double  aRotation)
inline

Definition at line 1964 of file specctra.h.

1965  {
1966  rotation = aRotation;
1967  isRotated = (aRotation != 0.0);
1968  }
bool isRotated
Definition: specctra.h:1994
double rotation
Definition: specctra.h:1993

References isRotated, and rotation.

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

◆ SetVertex()

void DSN::PIN::SetVertex ( const POINT aPoint)
inline

Definition at line 1970 of file specctra.h.

1971  {
1972  vertex = aPoint;
1974  }
void FixNegativeZero()
Change negative zero to positive zero in the IEEE floating point storage format.
Definition: specctra.h:144
POINT vertex
Definition: specctra.h:1996

References DSN::POINT::FixNegativeZero(), and vertex.

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1990 of file specctra.h.

Member Data Documentation

◆ isRotated

bool DSN::PIN::isRotated
private

Definition at line 1994 of file specctra.h.

Referenced by Format(), PIN(), and SetRotation().

◆ kiNetCode

int DSN::PIN::kiNetCode
private

KiCad netcode.

Definition at line 1998 of file specctra.h.

Referenced by PIN().

◆ padstack_id

std::string DSN::PIN::padstack_id
private

Definition at line 1992 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 276 of file specctra.h.

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

◆ pin_id

std::string DSN::PIN::pin_id
private

Definition at line 1995 of file specctra.h.

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

◆ rotation

double DSN::PIN::rotation
private

Definition at line 1993 of file specctra.h.

Referenced by Format(), PIN(), and SetRotation().

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 273 of file specctra.h.

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

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

◆ vertex

POINT DSN::PIN::vertex
private

Definition at line 1996 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPIN(), Format(), and SetVertex().


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