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

Used for <keepout_descriptor> and <plane_descriptor>. More...

#include <specctra.h>

Inheritance diagram for DSN::KEEPOUT:
DSN::ELEM DSN::COPPER_PLANE

Public Member Functions

 KEEPOUT (ELEM *aParent, DSN_T aType)
 Require a DSN_T because this class is used for T_place_keepout, T_via_keepout, T_wire_keepout, T_bend_keepout, and T_elongate_keepout as well as T_keepout.
 
 ~KEEPOUT ()
 
void SetShape (ELEM *aShape)
 
void AddWindow (WINDOW *aWindow)
 
void Format (OUTPUTFORMATTER *out, int nestLevel) override
 Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
 
DSN_T Type () const
 
const char * Name () const
 
virtual UNIT_RESGetUnits () const
 Return the units for this section.
 
virtual void FormatContents (OUTPUTFORMATTER *out, int nestLevel)
 Write the contents 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

std::string m_name
 
int m_sequence_number
 
RULEm_rules
 
RULEm_place_rules
 
WINDOWS m_windows
 
ELEMm_shape
 
DSN_T type
 
ELEMparent
 

Static Protected Attributes

static STRING_FORMATTER sf
 

Friends

class SPECCTRA_DB
 

Detailed Description

Used for <keepout_descriptor> and <plane_descriptor>.

Definition at line 910 of file specctra.h.

Constructor & Destructor Documentation

◆ KEEPOUT()

DSN::KEEPOUT::KEEPOUT ( ELEM * aParent,
DSN_T aType )
inline

Require a DSN_T because this class is used for T_place_keepout, T_via_keepout, T_wire_keepout, T_bend_keepout, and T_elongate_keepout as well as T_keepout.

Definition at line 918 of file specctra.h.

References DSN::ELEM::ELEM(), m_place_rules, m_rules, m_sequence_number, and m_shape.

Referenced by DSN::COPPER_PLANE::COPPER_PLANE().

◆ ~KEEPOUT()

DSN::KEEPOUT::~KEEPOUT ( )
inline

Definition at line 928 of file specctra.h.

References m_place_rules, m_rules, and m_shape.

Member Function Documentation

◆ AddWindow()

void DSN::KEEPOUT::AddWindow ( WINDOW * aWindow)
inline

Definition at line 952 of file specctra.h.

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

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

◆ Format()

void DSN::KEEPOUT::Format ( OUTPUTFORMATTER * out,
int nestLevel )
inlineoverridevirtual

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

Definition at line 958 of file specctra.h.

References OUTPUTFORMATTER::GetQuoteChar(), m_name, m_place_rules, m_rules, m_sequence_number, m_shape, m_windows, DSN::ELEM::Name(), and OUTPUTFORMATTER::Print().

◆ FormatContents()

virtual void DSN::ELEM::FormatContents ( OUTPUTFORMATTER * out,
int nestLevel )
inlinevirtualinherited

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 in DSN::CLASS_CLASS, DSN::CLASSES, DSN::COMPONENT, DSN::ELEM_HOLDER, DSN::HISTORY, DSN::IMAGE, DSN::LIBRARY, DSN::NETWORK, DSN::PADSTACK, DSN::PARSER, DSN::PLACEMENT, DSN::REGION, DSN::ROUTE, DSN::STRUCTURE, DSN::STRUCTURE_OUT, DSN::TOPOLOGY, DSN::WAS_IS, and DSN::WIRING.

Definition at line 247 of file specctra.h.

Referenced by Format(), and makeHash().

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

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

◆ SetParent()

◆ SetShape()

void DSN::KEEPOUT::SetShape ( ELEM * aShape)
inline

◆ Type()

Friends And Related Symbol Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1034 of file specctra.h.

References SPECCTRA_DB.

Referenced by SPECCTRA_DB.

Member Data Documentation

◆ m_name

std::string DSN::KEEPOUT::m_name
protected

Definition at line 1017 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doKEEPOUT(), Format(), and DSN::SPECCTRA_DB::FromBOARD().

◆ m_place_rules

RULE* DSN::KEEPOUT::m_place_rules
protected

Definition at line 1020 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doKEEPOUT(), Format(), KEEPOUT(), and ~KEEPOUT().

◆ m_rules

RULE* DSN::KEEPOUT::m_rules
protected

Definition at line 1019 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doKEEPOUT(), Format(), KEEPOUT(), and ~KEEPOUT().

◆ m_sequence_number

int DSN::KEEPOUT::m_sequence_number
protected

Definition at line 1018 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doKEEPOUT(), Format(), and KEEPOUT().

◆ m_shape

ELEM* DSN::KEEPOUT::m_shape
protected

Definition at line 1031 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doKEEPOUT(), Format(), KEEPOUT(), SetShape(), and ~KEEPOUT().

◆ m_windows

WINDOWS DSN::KEEPOUT::m_windows
protected

Definition at line 1022 of file specctra.h.

Referenced by AddWindow(), DSN::SPECCTRA_DB::doKEEPOUT(), and Format().

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