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
 Function Format writes 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
 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

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

Constructor & Destructor Documentation

◆ PIN()

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

Definition at line 1951 of file specctra.h.

1951  :
1952  ELEM( T_pin, aParent )
1953  {
1954  rotation = 0.0;
1955  isRotated = false;
1956  kiNetCode = 0;
1957  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
int kiNetCode
KiCad netcode.
Definition: specctra.h:1947
bool isRotated
Definition: specctra.h:1943
double rotation
Definition: specctra.h:1942

References isRotated, kiNetCode, and rotation.

Member Function Documentation

◆ Format()

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

Definition at line 1971 of file specctra.h.

1972  {
1973  const char* quote = out->GetQuoteChar( padstack_id.c_str() );
1974  if( isRotated )
1975  out->Print( nestLevel, "(pin %s%s%s (rotate %.6g)",
1976  quote, padstack_id.c_str(), quote,
1977  rotation
1978  );
1979  else
1980  out->Print( nestLevel, "(pin %s%s%s", quote, padstack_id.c_str(), quote );
1981 
1982  quote = out->GetQuoteChar( pin_id.c_str() );
1983  out->Print( 0, " %s%s%s %.6g %.6g)\n", quote, pin_id.c_str(), quote,
1984  vertex.x, vertex.y );
1985  }
std::string pin_id
Definition: specctra.h:1944
double y
Definition: specctra.h:96
double x
Definition: specctra.h:95
bool isRotated
Definition: specctra.h:1943
std::string padstack_id
Definition: specctra.h:1941
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:331
double rotation
Definition: specctra.h:1942
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408
POINT vertex
Definition: specctra.h:1945

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

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

◆ SetParent()

◆ SetRotation()

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

Definition at line 1959 of file specctra.h.

1960  {
1961  rotation = aRotation;
1962  isRotated = (aRotation != 0.0);
1963  }
bool isRotated
Definition: specctra.h:1943
double rotation
Definition: specctra.h:1942

References isRotated, and rotation.

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

◆ SetVertex()

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

Definition at line 1965 of file specctra.h.

1966  {
1967  vertex = aPoint;
1969  }
void FixNegativeZero()
Function FixNegativeZero will change negative zero to positive zero in the IEEE floating point storag...
Definition: specctra.h:135
POINT vertex
Definition: specctra.h:1945

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

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1939 of file specctra.h.

Member Data Documentation

◆ isRotated

bool DSN::PIN::isRotated
private

Definition at line 1943 of file specctra.h.

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

◆ kiNetCode

int DSN::PIN::kiNetCode
private

KiCad netcode.

Definition at line 1947 of file specctra.h.

Referenced by PIN().

◆ padstack_id

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

Definition at line 1941 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

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

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

◆ rotation

double DSN::PIN::rotation
private

Definition at line 1942 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

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

◆ vertex

POINT DSN::PIN::vertex
private

Definition at line 1945 of file specctra.h.

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


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