#include <specctra.h>

Inheritance diagram for DSN::REGION:

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

ELEM *	Replace (int aIndex, ELEM *aElem)

ELEM *	Remove (int aIndex)

void	Insert (int aIndex, ELEM *aElem)

ELEM *	At (int aIndex) const

ELEM *	operator[] (int aIndex) const

void	Delete (int aIndex)

DSN_T	Type () const

const char *	Name () const

virtual UNIT_RES *	GetUnits () const
	Return the units for this section. More...

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

ELEM *	parent

Static Protected Attributes
static STRING_FORMATTER	sf

Private Types
typedef boost::ptr_vector< ELEM >	ELEM_ARRAY

Private Attributes
std::string	region_id

RECTANGLE *	rectangle

PATH *	polygon

RULE *	rules

ELEM_ARRAY	kids
	ELEM pointers. More...

Friends
class	SPECCTRA_DB

Detailed Description

Definition at line 1422 of file specctra.h.

Member Typedef Documentation

◆ ELEM_ARRAY

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

privateinherited

Definition at line 358 of file specctra.h.

Constructor & Destructor Documentation

◆ REGION()

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

inline

Definition at line 1425 of file specctra.h.

 :
 ELEM_HOLDER( T_region, aParent )
 {
 rectangle = 0;
 polygon = 0;
 rules = 0;
 }

References polygon, rectangle, and rules.

◆ ~REGION()

DSN::REGION::~REGION ( )

inline

Definition at line 1433 of file specctra.h.

 {
 delete rectangle;
 delete polygon;
 delete rules;
 }

References polygon, rectangle, and rules.

Member Function Documentation

◆ Append()

void DSN::ELEM_HOLDER::Append ( ELEM * aElem )

inlineinherited

Definition at line 322 of file specctra.h.

 {
 kids.push_back( aElem );
 }

References DSN::ELEM_HOLDER::kids.

Referenced by DSN::SPECCTRA_DB::doCLASS_CLASS(), DSN::SPECCTRA_DB::doCONTROL(), DSN::SPECCTRA_DB::doIMAGE(), DSN::SPECCTRA_DB::doPADSTACK(), DSN::SPECCTRA_DB::doREGION(), DSN::SPECCTRA_DB::doSTRUCTURE(), DSN::SPECCTRA_DB::makePADSTACK(), and DSN::SPECCTRA_DB::makeVia().

◆ At()

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

inlineinherited

Definition at line 341 of file specctra.h.

 {
 // we have varying sized objects and are using polymorphism, so we
 // must return a pointer not a reference.
 return (ELEM*) &kids[aIndex];
 }

References DSN::ELEM_HOLDER::kids.

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

◆ Delete()

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

inlineinherited

Definition at line 353 of file specctra.h.

353{ kids.erase( kids.begin() + aIndex ); }

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

aType	The type of ELEM to find
instanceNum	The 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 3791 of file specctra.cpp.

{
 int repeats=0;
 
 for( unsigned i = 0; i < kids.size(); ++i )
 {
 if( kids[i].Type() == aType )
 {
 if( repeats == instanceNum )
 return i;
 
 ++repeats;
 }
 }
 
 return -1;
}

References DSN::ELEM_HOLDER::kids, 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

out	The formatter to write to.
nestLevel	A multiple of the number of spaces to precede the output with.

Exceptions

IO_ERROR if a system error writing the output, such as a full disk.

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

Definition at line 3774 of file specctra.cpp.

{
 out->Print( nestLevel, "(%s\n", Name() );
 
 FormatContents( out, nestLevel+1 );
 
 out->Print( nestLevel, ")\n" );
}

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

Referenced by DSN::WINDOW::Format(), DSN::KEEPOUT::Format(), DSN::CONTROL::Format(), DSN::PLACE::Format(), DSN::SHAPE::Format(), DSN::CLASS::Format(), DSN::WIRE::Format(), DSN::PCB::Format(), DSN::SESSION::Format(), DSN::ELEM_HOLDER::FormatContents(), DSN::CLASS_CLASS::FormatContents(), DSN::STRUCTURE::FormatContents(), and DSN::ROUTE::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

out	The formatter to write to.
nestLevel	A multiple of the number of spaces to precede the output with.

Exceptions

IO_ERROR if a system error writing the output, such as a full disk.

Reimplemented from DSN::ELEM_HOLDER.

Definition at line 1440 of file specctra.h.

 {
 if( region_id.size() )
 {
 const char* quote = out->GetQuoteChar( region_id.c_str() );
 out->Print( nestLevel, "%s%s%s\n", quote, region_id.c_str(), quote );
 }
 
 if( rectangle )
 rectangle->Format( out, nestLevel );
 
 if( polygon )
 polygon->Format( out, nestLevel );
 
 ELEM_HOLDER::FormatContents( out, nestLevel );
 
 if( rules )
 rules->Format( out, nestLevel );
 }

References DSN::RECTANGLE::Format(), DSN::RULE::Format(), DSN::PATH::Format(), DSN::ELEM_HOLDER::FormatContents(), OUTPUTFORMATTER::GetQuoteChar(), polygon, OUTPUTFORMATTER::Print(), rectangle, region_id, and rules.

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

Definition at line 3765 of file specctra.cpp.

{
 if( parent )
 return parent->GetUnits();
 
 return &UNIT_RES::Default;
}

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

◆ Insert()

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

inlineinherited

Definition at line 339 of file specctra.h.

339{ kids.insert( kids.begin() + aIndex, aElem ); }

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

 {
 return kids.size();
 }

References DSN::ELEM_HOLDER::kids.

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

 {
 sf.Clear();
 FormatContents( &sf, 0 );
 sf.StripUseless();
 
 return sf.GetString();
 }

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

const char * DSN::ELEM::Name ( ) const

inherited

Definition at line 3760 of file specctra.cpp.

{
 return SPECCTRA_DB::TokenName( type );
}

References DSN::ELEM::type.

Referenced by DSN::ELEM::Format(), DSN::UNIT_RES::Format(), DSN::RECTANGLE::Format(), DSN::RULE::Format(), DSN::LAYER_RULE::Format(), DSN::PATH::Format(), DSN::BOUNDARY::Format(), DSN::CIRCLE::Format(), DSN::QARC::Format(), DSN::WINDOW::Format(), DSN::KEEPOUT::Format(), DSN::VIA::Format(), DSN::CONTROL::Format(), DSN::LAYER::Format(), DSN::SPECCTRA_LAYER_PAIR::Format(), DSN::LAYER_NOISE_WEIGHT::Format(), DSN::TOKPROP::Format(), DSN::STRINGPROP::Format(), DSN::GRID::Format(), DSN::PLACE::Format(), DSN::COMPONENT::Format(), DSN::SHAPE::Format(), DSN::IMAGE::Format(), DSN::PADSTACK::Format(), DSN::FROMTO::Format(), DSN::COMP_ORDER::Format(), DSN::NET::Format(), DSN::CLASS::Format(), DSN::WIRE::Format(), DSN::WIRE_VIA::Format(), DSN::PCB::Format(), DSN::ANCESTOR::Format(), DSN::SUPPLY_PIN::Format(), and DSN::SESSION::Format().

◆ operator[]()

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

inlineinherited

Definition at line 348 of file specctra.h.

 {
 return At( aIndex );
 }

References DSN::ELEM_HOLDER::At().

◆ Remove()

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

inlineinherited

Definition at line 333 of file specctra.h.

 {
 ELEM_ARRAY::auto_type ret = kids.release( kids.begin() + aIndex );
 return ret.release();
 }

References DSN::ELEM_HOLDER::kids.

◆ Replace()

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

inlineinherited

Definition at line 327 of file specctra.h.

 {
 ELEM_ARRAY::auto_type ret = kids.replace( aIndex, aElem );
 return ret.release();
 }

References DSN::ELEM_HOLDER::kids.

◆ SetParent()

void DSN::ELEM::SetParent ( ELEM * aParent )

inlineinherited

Definition at line 247 of file specctra.h.

 {
 parent = aParent;
 }

References DSN::ELEM::parent.

Referenced by DSN::LIBRARY::AddPadstack(), DSN::KEEPOUT::AddWindow(), DSN::LIBRARY::AppendIMAGE(), DSN::LIBRARY::AppendPADSTACK(), DSN::LIBRARY::AppendVia(), DSN::STRUCTURE::SetBOUNDARY(), DSN::STRUCTURE::SetPlaceBOUNDARY(), DSN::WINDOW::SetShape(), DSN::KEEPOUT::SetShape(), and DSN::WIRE::SetShape().

◆ Type()

DSN_T DSN::ELEM::Type ( ) const

inlineinherited

Definition at line 210 of file specctra.h.

210{ return type; }

References DSN::ELEM::type.

Referenced by DSN::SPECCTRA_DB::doCLASS_CLASS(), DSN::ELEM_HOLDER::FindElem(), DSN::SPECCTRA_DB::FromSESSION(), DSN::SPECCTRA_DB::makeVIA(), DSN::WINDOW::SetShape(), DSN::KEEPOUT::SetShape(), and DSN::WIRE::SetShape().

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB

friend

Definition at line 1461 of file specctra.h.

Member Data Documentation

◆ kids

ELEM_ARRAY DSN::ELEM_HOLDER::kids

privateinherited

ELEM pointers.

Definition at line 360 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 276 of file specctra.h.

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

◆ polygon

PATH* DSN::REGION::polygon

private

Definition at line 1467 of file specctra.h.

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

◆ rectangle

RECTANGLE* DSN::REGION::rectangle

private

Definition at line 1466 of file specctra.h.

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

◆ region_id

std::string DSN::REGION::region_id

private

Definition at line 1463 of file specctra.h.

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

◆ rules

RULE* DSN::REGION::rules

private

Definition at line 1474 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 273 of file specctra.h.

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

◆ type

DSN_T DSN::ELEM::type

protectedinherited

Definition at line 275 of file specctra.h.

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

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

specctra.h

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ELEM_ARRAY

Constructor & Destructor Documentation

◆ REGION()

◆ ~REGION()

Member Function Documentation

◆ Append()

◆ At()

◆ Delete()

◆ FindElem()

◆ Format()

◆ FormatContents()

◆ GetUnits()

◆ Insert()

◆ Length()

◆ makeHash()

◆ Name()

◆ operator[]()

◆ Remove()

◆ Replace()

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

Member Data Documentation

◆ kids

◆ parent

◆ polygon

◆ rectangle

◆ region_id

◆ rules

◆ sf

◆ type