DSN::REGION Class Reference

#include <specctra.h>

Inheritance diagram for DSN::REGION:

Public Member Functions
	REGION (ELEM *aParent)
	~REGION ()
void	FormatContents (OUTPUTFORMATTER *out, int nestLevel) override
	Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
int	FindElem (DSN_T aType, int instanceNum=0)
	Function FindElem finds a particular instance number of a given type of ELEM. More...
int	Length () const
	Function Length returns the number of ELEMs in this ELEM. 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
	Function GetUnits returns the units for this section. More...
virtual void	Format (OUTPUTFORMATTER *out, int nestLevel)
	Function Format writes 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 ()
	Function makeHash returns a string which uniquely represents this ELEM amoung 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 Attributes
std::string	region_id
RECTANGLE *	rectangle
PATH *	polygon
RULE *	rules

Friends
class	SPECCTRA_DB

Detailed Description

Definition at line 1390 of file specctra.h.

Constructor & Destructor Documentation

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

inline

Definition at line 1408 of file specctra.h.

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

DSN::REGION::~REGION ( )

inline

Definition at line 1416 of file specctra.h.

References polygon, rectangle, and rules.

    {
        delete rectangle;
        delete polygon;
        delete rules;
    }

Member Function Documentation

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

inlineinherited

Definition at line 321 of file specctra.h.

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::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), and DSN::SPECCTRA_DB::makeVia().

    {
        kids.push_back( aElem );
    }

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

inlineinherited

Definition at line 343 of file specctra.h.

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

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

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

inlineinherited

Definition at line 355 of file specctra.h.

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

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

inherited

Function FindElem finds 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 3530 of file specctra.cpp.

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

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

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

virtualinherited

Function Format writes 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 preceed the output with.

Exceptions

IO_ERROR

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

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

Definition at line 3511 of file specctra.cpp.

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

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

    FormatContents( out, nestLevel+1 );

    out->Print( nestLevel, ")\n" );
}

void DSN::REGION::FormatContents ( OUTPUTFORMATTER *  out, int  nestLevel  )

inlineoverridevirtual

Function FormatContents writes 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 preceed 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 1423 of file specctra.h.

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

    {
        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 );
    }

UNIT_RES * DSN::ELEM::GetUnits ( ) const

virtualinherited

Function GetUnits returns the units for this section.

Derived classes may override this to check for section specific overrides.

Returns

UNIT_RES* - from a local or parent scope

Reimplemented in DSN::ROUTE, DSN::PCB, DSN::WIRING, DSN::LIBRARY, DSN::PADSTACK, DSN::IMAGE, DSN::PLACEMENT, and DSN::STRUCTURE.

Definition at line 3502 of file specctra.cpp.

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

{
    if( parent )
        return parent->GetUnits();

    return &UNIT_RES::Default;
}

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

inlineinherited

Definition at line 338 of file specctra.h.

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

int DSN::ELEM_HOLDER::Length ( ) const

inlineinherited

Function Length returns the number of ELEMs in this ELEM.

Returns

int - the count of children

Definition at line 316 of file specctra.h.

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

    {
        return kids.size();
    }

std::string DSN::ELEM::makeHash ( )

inlineprotectedinherited

Function makeHash returns a string which uniquely represents this ELEM amoung other ELEMs of the same derived class as "this" one.

It is not useable 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 212 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().

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

        return sf.GetString();
    }

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

inherited

Definition at line 3497 of file specctra.cpp.

References SPECCTRA_LEXER::TokenName(), and 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().

{
    return SPECCTRA_DB::TokenName( type );
}

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

inlineinherited

Definition at line 350 of file specctra.h.

References DSN::ELEM_HOLDER::At().

    {
        return At( aIndex );
    }

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

inlineinherited

Definition at line 332 of file specctra.h.

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

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

inlineinherited

Definition at line 326 of file specctra.h.

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

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

inlineinherited

Definition at line 269 of file specctra.h.

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

    {
        parent = aParent;
    }

DSN_T DSN::ELEM::Type ( ) const

inlineinherited

Definition at line 231 of file specctra.h.

References DSN::ELEM::type.

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

{ return type; }

Friends And Related Function Documentation

friend class SPECCTRA_DB

friend

Definition at line 1392 of file specctra.h.

Member Data Documentation

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 200 of file specctra.h.

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

PATH* DSN::REGION::polygon

private

Definition at line 1398 of file specctra.h.

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

RECTANGLE* DSN::REGION::rectangle

private

Definition at line 1397 of file specctra.h.

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

std::string DSN::REGION::region_id

private

Definition at line 1394 of file specctra.h.

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

RULE* DSN::REGION::rules

private

Definition at line 1405 of file specctra.h.

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

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 222 of file specctra.h.

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

DSN_T DSN::ELEM::type

protectedinherited

Definition at line 199 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