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

Constructor & Destructor Documentation

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

Definition at line 1933 of file specctra.h.

1933  :
1934  ELEM( T_pin, aParent )
1935  {
1936  rotation = 0.0;
1937  isRotated = false;
1938  kiNetCode = 0;
1939  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3486
int kiNetCode
KiCad netcode.
Definition: specctra.h:1929
bool isRotated
Definition: specctra.h:1925
double rotation
Definition: specctra.h:1924

Member Function Documentation

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

References OUTPUTFORMATTER::GetQuoteChar(), OUTPUTFORMATTER::Print(), rotation, DSN::POINT::x, and DSN::POINT::y.

1954  {
1955  const char* quote = out->GetQuoteChar( padstack_id.c_str() );
1956  if( isRotated )
1957  out->Print( nestLevel, "(pin %s%s%s (rotate %.6g)",
1958  quote, padstack_id.c_str(), quote,
1959  rotation
1960  );
1961  else
1962  out->Print( nestLevel, "(pin %s%s%s", quote, padstack_id.c_str(), quote );
1963 
1964  quote = out->GetQuoteChar( pin_id.c_str() );
1965  out->Print( 0, " %s%s%s %.6g %.6g)\n", quote, pin_id.c_str(), quote,
1966  vertex.x, vertex.y );
1967  }
std::string pin_id
Definition: specctra.h:1926
double y
Definition: specctra.h:97
double x
Definition: specctra.h:96
bool isRotated
Definition: specctra.h:1925
std::string padstack_id
Definition: specctra.h:1923
static const char * GetQuoteChar(const char *wrapee, const char *quote_char)
Function GetQuoteChar performs quote character need determination according to the Specctra DSN speci...
Definition: richio.cpp:331
double rotation
Definition: specctra.h:1924
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
POINT vertex
Definition: specctra.h:1927
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 264 of file specctra.h.

Referenced by DSN::ELEM::Format(), and DSN::ELEM::makeHash().

265  {
266  // overridden in ELEM_HOLDER
267  }
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 3502 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().

3503 {
3504  if( parent )
3505  return parent->GetUnits();
3506 
3507  return &UNIT_RES::Default;
3508 }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3502
ELEM * parent
Definition: specctra.h:200
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:414
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 212 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().

213  {
214  sf.Clear();
215  FormatContents( &sf, 0 );
216  sf.StripUseless();
217 
218  return sf.GetString();
219  }
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:264
const std::string & GetString()
Definition: richio.h:475
void StripUseless()
Function StripUseless removes whitespace, '(', and ')' from the mystring.
Definition: richio.cpp:504
static STRING_FORMATTER sf
Definition: specctra.h:222
void Clear()
Function Clear clears the buffer and empties the internal string.
Definition: richio.h:464
void DSN::PIN::SetRotation ( double  aRotation)
inline

Definition at line 1941 of file specctra.h.

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

1942  {
1943  rotation = aRotation;
1944  isRotated = (aRotation != 0.0);
1945  }
bool isRotated
Definition: specctra.h:1925
double rotation
Definition: specctra.h:1924
void DSN::PIN::SetVertex ( const POINT aPoint)
inline

Definition at line 1947 of file specctra.h.

References DSN::POINT::FixNegativeZero().

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

1948  {
1949  vertex = aPoint;
1951  }
void FixNegativeZero()
Function FixNegativeZero will change negative zero to positive zero in the IEEE floating point storag...
Definition: specctra.h:136
POINT vertex
Definition: specctra.h:1927

Friends And Related Function Documentation

friend class SPECCTRA_DB
friend

Definition at line 1921 of file specctra.h.

Member Data Documentation

bool DSN::PIN::isRotated
private

Definition at line 1925 of file specctra.h.

int DSN::PIN::kiNetCode
private

KiCad netcode.

Definition at line 1929 of file specctra.h.

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

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

Definition at line 1923 of file specctra.h.

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

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

std::string DSN::PIN::pin_id
private
double DSN::PIN::rotation
private

Definition at line 1924 of file specctra.h.

Referenced by Format().

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

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

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 199 of file specctra.h.

Referenced by DSN::UNIT_RES::Format(), DSN::ELEM::Name(), and DSN::ELEM::Type().

POINT DSN::PIN::vertex
private

Definition at line 1927 of file specctra.h.

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


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