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

#include <specctra.h>

Inheritance diagram for DSN::REGION:
DSN::ELEM_HOLDER DSN::ELEM

Public Member Functions

 REGION (ELEM *aParent)
 
 ~REGION ()
 
void FormatContents (OUTPUTFORMATTER *out, int nestLevel) override
 Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
 
int FindElem (DSN_T aType, int instanceNum=0)
 Find a particular instance number of a given type of ELEM.
 
int Length () const
 Return the number of ELEMs in this holder.
 
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 UNIT_RESGetUnits () const
 Return the units for this section.
 
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 Types

typedef boost::ptr_vector< ELEMELEM_ARRAY
 

Private Attributes

std::string m_region_id
 
RECTANGLEm_rectangle
 
PATHm_polygon
 
RULEm_rules
 
ELEM_ARRAY kids
 ELEM pointers.
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 1427 of file specctra.h.

Member Typedef Documentation

◆ ELEM_ARRAY

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

Definition at line 363 of file specctra.h.

Constructor & Destructor Documentation

◆ REGION()

DSN::REGION::REGION ( ELEM * aParent)
inline

Definition at line 1430 of file specctra.h.

References DSN::ELEM_HOLDER::ELEM_HOLDER(), m_polygon, m_rectangle, and m_rules.

◆ ~REGION()

DSN::REGION::~REGION ( )
inline

Definition at line 1438 of file specctra.h.

References m_polygon, m_rectangle, and m_rules.

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

References 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 3799 of file specctra.cpp.

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

◆ Format()

void DSN::ELEM::Format ( OUTPUTFORMATTER * out,
int nestLevel )
virtualinherited

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 in DSN::ANCESTOR, DSN::BOUNDARY, DSN::CIRCLE, DSN::CLASS, DSN::COMP_ORDER, DSN::COMPONENT, DSN::CONTROL, DSN::FROMTO, DSN::GRID, DSN::IMAGE, DSN::KEEPOUT, DSN::LAYER, DSN::LAYER_NOISE_WEIGHT, DSN::LAYER_RULE, DSN::NET, DSN::NET_OUT, DSN::PADSTACK, DSN::PATH, DSN::PCB, DSN::PIN, DSN::PLACE, DSN::QARC, DSN::RECTANGLE, DSN::RULE, DSN::SESSION, DSN::SHAPE, DSN::SPECCTRA_LAYER_PAIR, DSN::STRINGPROP, DSN::SUPPLY_PIN, DSN::TOKPROP, DSN::UNIT_RES, DSN::VIA, DSN::WINDOW, DSN::WIRE, and DSN::WIRE_VIA.

Definition at line 3782 of file specctra.cpp.

References FormatContents(), Name(), and OUTPUTFORMATTER::Print().

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

◆ FormatContents()

void DSN::REGION::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 1445 of file specctra.h.

References DSN::ELEM_HOLDER::FormatContents(), OUTPUTFORMATTER::GetQuoteChar(), m_polygon, m_rectangle, m_region_id, m_rules, and OUTPUTFORMATTER::Print().

◆ 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::IMAGE, DSN::LIBRARY, DSN::PADSTACK, DSN::PCB, DSN::PLACEMENT, DSN::ROUTE, DSN::STRUCTURE, and DSN::WIRING.

Definition at line 3773 of file specctra.cpp.

References DSN::UNIT_RES::Default, and parent.

Referenced by DSN::SPECCTRA_DB::FromSESSION(), DSN::IMAGE::GetUnits(), DSN::LIBRARY::GetUnits(), DSN::PADSTACK::GetUnits(), DSN::PCB::GetUnits(), DSN::PLACEMENT::GetUnits(), DSN::ROUTE::GetUnits(), DSN::STRUCTURE::GetUnits(), and DSN::WIRING::GetUnits().

◆ Insert()

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

Definition at line 344 of file specctra.h.

References DSN::ELEM::ELEM(), and 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 322 of file specctra.h.

References kids.

Referenced by DSN::CONTROL::Format(), FormatContents(), DSN::STRUCTURE::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 268 of file specctra.h.

References FormatContents(), and sf.

Referenced by DSN::IMAGE::Compare(), and DSN::PADSTACK::Compare().

◆ Name()

◆ operator[]()

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

Definition at line 353 of file specctra.h.

References At(), and DSN::ELEM::ELEM().

◆ Remove()

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

Definition at line 338 of file specctra.h.

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

◆ Replace()

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

Definition at line 332 of file specctra.h.

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

◆ SetParent()

◆ Type()

Friends And Related Symbol Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1466 of file specctra.h.

References SPECCTRA_DB.

Referenced by SPECCTRA_DB.

Member Data Documentation

◆ kids

ELEM_ARRAY DSN::ELEM_HOLDER::kids
privateinherited

ELEM pointers.

Definition at line 365 of file specctra.h.

Referenced by Append(), At(), Delete(), FindElem(), Insert(), Length(), Remove(), and Replace().

◆ m_polygon

PATH* DSN::REGION::m_polygon
private

Definition at line 1472 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doREGION(), FormatContents(), REGION(), and ~REGION().

◆ m_rectangle

RECTANGLE* DSN::REGION::m_rectangle
private

Definition at line 1471 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doREGION(), FormatContents(), REGION(), and ~REGION().

◆ m_region_id

std::string DSN::REGION::m_region_id
private

Definition at line 1468 of file specctra.h.

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

◆ m_rules

RULE* DSN::REGION::m_rules
private

Definition at line 1479 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doREGION(), FormatContents(), REGION(), and ~REGION().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 281 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 278 of file specctra.h.

Referenced by makeHash().

◆ type

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 280 of file specctra.h.

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


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