KiCad PCB EDA Suite
Loading...
Searching...
No Matches
DSN::PLACEMENT Class Reference

#include <specctra.h>

Inheritance diagram for DSN::PLACEMENT:
DSN::ELEM

Public Member Functions

 PLACEMENT (ELEM *aParent)
 
 ~PLACEMENT ()
 
COMPONENTLookupCOMPONENT (const std::string &imageName)
 Look up a COMPONENT by name.
 
void FormatContents (OUTPUTFORMATTER *out, int nestLevel) override
 Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
 
UNIT_RESGetUnits () const override
 Return the units for this section.
 
DSN_T Type () const
 
const char * Name () const
 
virtual void Format (OUTPUTFORMATTER *out, int nestLevel)
 Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
 
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.
 

Protected Attributes

DSN_T type
 
ELEMparent
 

Static Protected Attributes

static STRING_FORMATTER sf
 

Private Attributes

UNIT_RESm_unit
 
DSN_T m_flip_style
 
COMPONENTS m_components
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 1814 of file specctra.h.

Constructor & Destructor Documentation

◆ PLACEMENT()

DSN::PLACEMENT::PLACEMENT ( ELEM aParent)
inline

Definition at line 1817 of file specctra.h.

References m_flip_style, and m_unit.

◆ ~PLACEMENT()

DSN::PLACEMENT::~PLACEMENT ( )
inline

Definition at line 1824 of file specctra.h.

References m_unit.

Member Function Documentation

◆ Format()

◆ FormatContents()

void DSN::PLACEMENT::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
inlineoverridevirtual

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

Definition at line 1851 of file specctra.h.

References DSN::UNIT_RES::Format(), DSN::GetTokenText(), m_components, m_flip_style, m_unit, and OUTPUTFORMATTER::Print().

◆ GetUnits()

UNIT_RES * DSN::PLACEMENT::GetUnits ( ) const
inlineoverridevirtual

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

Definition at line 1866 of file specctra.h.

References DSN::ELEM::GetUnits(), and m_unit.

◆ LookupCOMPONENT()

COMPONENT * DSN::PLACEMENT::LookupCOMPONENT ( const std::string &  imageName)
inline

Look up a COMPONENT by name.

If the name is not found, a new COMPONENT is added to the components container. At any time the names in the component container should remain unique.

Returns
existing or new COMPONENT.

Definition at line 1837 of file specctra.h.

References m_components, and DSN::COMPONENT::SetImageId().

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

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

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1875 of file specctra.h.

Member Data Documentation

◆ m_components

COMPONENTS DSN::PLACEMENT::m_components
private

◆ m_flip_style

DSN_T DSN::PLACEMENT::m_flip_style
private

Definition at line 1879 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACEMENT(), FormatContents(), and PLACEMENT().

◆ m_unit

UNIT_RES* DSN::PLACEMENT::m_unit
private

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

◆ type

DSN_T DSN::ELEM::type
protectedinherited

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