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

#include <specctra.h>

Inheritance diagram for DSN::STRUCTURE:
DSN::ELEM_HOLDER DSN::ELEM

Public Member Functions

 STRUCTURE (ELEM *aParent)
 
 ~STRUCTURE ()
 
void SetBOUNDARY (BOUNDARY *aBoundary)
 
void SetPlaceBOUNDARY (BOUNDARY *aBoundary)
 
void FormatContents (OUTPUTFORMATTER *out, int nestLevel) override
 Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
UNIT_RESGetUnits () const override
 Return the units for this section. More...
 
int FindElem (DSN_T aType, int instanceNum=0)
 Find a particular instance number of a given type of ELEM. More...
 
int Length () const
 Return the number of ELEMs in this holder. More...
 
void Append (ELEM *aElem)
 
ELEMReplace (int aIndex, ELEM *aElem)
 
ELEMRemove (int aIndex)
 
void Insert (int aIndex, ELEM *aElem)
 
ELEMAt (int aIndex) const
 
ELEMoperator[] (int aIndex) const
 
void Delete (int aIndex)
 
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. 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 Types

typedef boost::ptr_vector< REGIONREGIONS
 
typedef boost::ptr_vector< GRIDGRIDS
 
typedef boost::ptr_vector< ELEMELEM_ARRAY
 

Private Attributes

UNIT_RESm_unit
 
LAYERS m_layers
 
LAYER_NOISE_WEIGHTm_layer_noise_weight
 
BOUNDARYm_boundary
 
BOUNDARYm_place_boundary
 
VIAm_via
 
CONTROLm_control
 
RULEm_rules
 
KEEPOUTS m_keepouts
 
COPPER_PLANES m_planes
 
REGIONS m_regions
 
RULEm_place_rules
 
GRIDS m_grids
 
ELEM_ARRAY kids
 ELEM pointers. More...
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 1553 of file specctra.h.

Member Typedef Documentation

◆ ELEM_ARRAY

typedef boost::ptr_vector<ELEM> DSN::ELEM_HOLDER::ELEM_ARRAY
privateinherited

Definition at line 357 of file specctra.h.

◆ GRIDS

typedef boost::ptr_vector<GRID> DSN::STRUCTURE::GRIDS
private

Definition at line 1678 of file specctra.h.

◆ REGIONS

typedef boost::ptr_vector<REGION> DSN::STRUCTURE::REGIONS
private

Definition at line 1673 of file specctra.h.

Constructor & Destructor Documentation

◆ STRUCTURE()

DSN::STRUCTURE::STRUCTURE ( ELEM aParent)
inline

◆ ~STRUCTURE()

DSN::STRUCTURE::~STRUCTURE ( )
inline

Member Function Documentation

◆ Append()

◆ At()

ELEM * DSN::ELEM_HOLDER::At ( int  aIndex) const
inlineinherited

◆ Delete()

void DSN::ELEM_HOLDER::Delete ( int  aIndex)
inlineinherited

Definition at line 352 of file specctra.h.

References DSN::ELEM_HOLDER::kids.

◆ FindElem()

int DSN::ELEM_HOLDER::FindElem ( DSN_T  aType,
int  instanceNum = 0 
)
inherited

Find a particular instance number of a given type of ELEM.

Parameters
aTypeThe type of ELEM to find
instanceNumThe instance number of to find: 0 for first, 1 for second, etc.
Returns
int - The index into the kids array or -1 if not found.

Definition at line 3790 of file specctra.cpp.

References DSN::ELEM_HOLDER::kids, and DSN::ELEM::Type().

◆ Format()

◆ FormatContents()

void DSN::STRUCTURE::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_HOLDER.

Definition at line 1599 of file specctra.h.

References DSN::ELEM_HOLDER::At(), DSN::ELEM::Format(), DSN::UNIT_RES::Format(), DSN::RULE::Format(), DSN::BOUNDARY::Format(), DSN::VIA::Format(), DSN::CONTROL::Format(), DSN::LAYER_NOISE_WEIGHT::Format(), DSN::ELEM_HOLDER::Length(), m_boundary, m_control, m_grids, m_keepouts, m_layer_noise_weight, m_layers, m_place_boundary, m_place_rules, m_planes, m_regions, m_rules, m_unit, and m_via.

◆ GetUnits()

UNIT_RES * DSN::STRUCTURE::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 1646 of file specctra.h.

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

◆ Insert()

void DSN::ELEM_HOLDER::Insert ( int  aIndex,
ELEM aElem 
)
inlineinherited

Definition at line 338 of file specctra.h.

References DSN::ELEM_HOLDER::kids.

◆ Length()

int DSN::ELEM_HOLDER::Length ( ) const
inlineinherited

Return the number of ELEMs in this holder.

Returns
the count of children elements.

Definition at line 316 of file specctra.h.

References DSN::ELEM_HOLDER::kids.

Referenced by DSN::CONTROL::Format(), DSN::ELEM_HOLDER::FormatContents(), FormatContents(), and DSN::SPECCTRA_DB::makeVIA().

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

◆ operator[]()

ELEM * DSN::ELEM_HOLDER::operator[] ( int  aIndex) const
inlineinherited

Definition at line 347 of file specctra.h.

References DSN::ELEM_HOLDER::At().

◆ Remove()

ELEM * DSN::ELEM_HOLDER::Remove ( int  aIndex)
inlineinherited

Definition at line 332 of file specctra.h.

References DSN::ELEM_HOLDER::kids.

◆ Replace()

ELEM * DSN::ELEM_HOLDER::Replace ( int  aIndex,
ELEM aElem 
)
inlineinherited

Definition at line 326 of file specctra.h.

References DSN::ELEM_HOLDER::kids.

◆ SetBOUNDARY()

void DSN::STRUCTURE::SetBOUNDARY ( BOUNDARY aBoundary)
inline

Definition at line 1581 of file specctra.h.

References m_boundary, and DSN::ELEM::SetParent().

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

◆ SetParent()

◆ SetPlaceBOUNDARY()

void DSN::STRUCTURE::SetPlaceBOUNDARY ( BOUNDARY aBoundary)
inline

Definition at line 1590 of file specctra.h.

References m_place_boundary, and DSN::ELEM::SetParent().

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1655 of file specctra.h.

Member Data Documentation

◆ kids

◆ m_boundary

BOUNDARY* DSN::STRUCTURE::m_boundary
private

◆ m_control

CONTROL* DSN::STRUCTURE::m_control
private

Definition at line 1666 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSTRUCTURE(), FormatContents(), STRUCTURE(), and ~STRUCTURE().

◆ m_grids

GRIDS DSN::STRUCTURE::m_grids
private

Definition at line 1679 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSTRUCTURE(), and FormatContents().

◆ m_keepouts

KEEPOUTS DSN::STRUCTURE::m_keepouts
private

◆ m_layer_noise_weight

LAYER_NOISE_WEIGHT* DSN::STRUCTURE::m_layer_noise_weight
private

Definition at line 1661 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSTRUCTURE(), FormatContents(), STRUCTURE(), and ~STRUCTURE().

◆ m_layers

LAYERS DSN::STRUCTURE::m_layers
private

◆ m_place_boundary

BOUNDARY* DSN::STRUCTURE::m_place_boundary
private

◆ m_place_rules

RULE* DSN::STRUCTURE::m_place_rules
private

Definition at line 1676 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSTRUCTURE(), FormatContents(), STRUCTURE(), and ~STRUCTURE().

◆ m_planes

COPPER_PLANES DSN::STRUCTURE::m_planes
private

◆ m_regions

REGIONS DSN::STRUCTURE::m_regions
private

Definition at line 1674 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSTRUCTURE(), and FormatContents().

◆ m_rules

◆ m_unit

UNIT_RES* DSN::STRUCTURE::m_unit
private

◆ m_via

◆ 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: