Implement a <placement_reference> in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::PLACE:

Public Member Functions
	PLACE (ELEM *aParent)

	~PLACE ()

void	SetVertex (const POINT &aVertex)

void	SetRotation (double aRotation)

void	Format (OUTPUTFORMATTER *out, int nestLevel) override
	Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...

DSN_T	Type () const

const char *	Name () const

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

virtual void	FormatContents (OUTPUTFORMATTER *out, int nestLevel)
	Write the contents 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 Attributes
std::string	component_id
	reference designator More...

DSN_T	side

double	rotation

bool	hasVertex

POINT	vertex

DSN_T	mirror

DSN_T	status

std::string	logical_part

RULE *	place_rules

PROPERTIES	properties

DSN_T	lock_type

RULE *	rules

REGION *	region

std::string	part_number

Friends
class	SPECCTRA_DB

Detailed Description

Implement a <placement_reference> in the specctra dsn spec.

Definition at line 1687 of file specctra.h.

Constructor & Destructor Documentation

◆ PLACE()

DSN::PLACE::PLACE ( ELEM * aParent )

inline

Definition at line 1690 of file specctra.h.

                            :
         ELEM( T_place, aParent )
     {
         side = T_front;
 
         rotation = 0.0;
 
         hasVertex = false;
 
         mirror = T_NONE;
         status = T_NONE;
 
         place_rules = 0;
 
         lock_type = T_NONE;
         rules = 0;
         region = 0;
     }

References hasVertex, lock_type, mirror, place_rules, region, rotation, rules, side, and status.

◆ ~PLACE()

DSN::PLACE::~PLACE ( )

inline

Definition at line 1709 of file specctra.h.

     {
         delete place_rules;
         delete rules;
         delete region;
     }

References place_rules, region, and rules.

Member Function Documentation

◆ Format()

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

overridevirtual

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

Definition at line 3923 of file specctra.cpp.

 {
     bool        useMultiLine;
 
     const char* quote = out->GetQuoteChar( component_id.c_str() );
 
     if( place_rules || properties.size() || rules || region )
     {
         useMultiLine = true;
 
         out->Print( nestLevel, "(%s %s%s%s\n", Name(), quote, component_id.c_str(), quote );
         out->Print( nestLevel+1, "%s", "" );
     }
     else
     {
         useMultiLine = false;
 
         out->Print( nestLevel, "(%s %s%s%s", Name(), quote, component_id.c_str(), quote );
     }
 
     if( hasVertex )
     {
         out->Print( 0, " %.6f %.6f", vertex.x, vertex.y );
         out->Print( 0, " %s", GetTokenText( side ) );
         out->Print( 0, " %.6f", rotation );
     }
 
     const char* space = " ";    // one space, as c string.
 
     if( mirror != T_NONE )
     {
         out->Print( 0, "%s(mirror %s)", space, GetTokenText( mirror ) );
         space = "";
     }
 
     if( status != T_NONE )
     {
         out->Print( 0, "%s(status %s)", space, GetTokenText( status ) );
         space = "";
     }
 
     if( logical_part.size() )
     {
         quote = out->GetQuoteChar( logical_part.c_str() );
         out->Print( 0, "%s(logical_part %s%s%s)", space, quote, logical_part.c_str(), quote );
         space = "";
     }
 
     if( useMultiLine )
     {
         out->Print( 0, "\n" );
 
         if( place_rules )
         {
             place_rules->Format( out, nestLevel+1 );
         }
 
         if( properties.size() )
         {
             out->Print( nestLevel + 1, "(property \n" );
 
             for( PROPERTIES::const_iterator i = properties.begin(); i != properties.end(); ++i )
                 i->Format( out, nestLevel + 2 );
 
             out->Print( nestLevel + 1, ")\n" );
         }
 
         if( lock_type != T_NONE )
             out->Print( nestLevel + 1, "(lock_type %s)\n", GetTokenText( lock_type ) );
 
         if( rules )
             rules->Format( out, nestLevel+1 );
 
         if( region )
             region->Format( out, nestLevel+1 );
 
         if( part_number.size() )
         {
             quote = out->GetQuoteChar( part_number.c_str() );
             out->Print( nestLevel + 1, "(PN %s%s%s)\n", quote, part_number.c_str(), quote );
         }
     }
     else
     {
         if( lock_type != T_NONE )
         {
             out->Print( 0, "%s(lock_type %s)", space, GetTokenText( lock_type ) );
             space = "";
         }
 
         if( part_number.size() )
         {
             quote = out->GetQuoteChar( part_number.c_str() );
             out->Print( 0, "%s(PN %s%s%s)", space, quote, part_number.c_str(), quote );
         }
     }
 
     out->Print( 0, ")\n" );
 }

References component_id, DSN::ELEM::Format(), DSN::RULE::Format(), OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), hasVertex, lock_type, logical_part, mirror, DSN::ELEM::Name(), part_number, place_rules, OUTPUTFORMATTER::Print(), properties, region, rotation, rules, side, status, vertex, DSN::POINT::x, and DSN::POINT::y.

◆ 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

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

Definition at line 242 of file specctra.h.

     {
         // overridden in ELEM_HOLDER
     }

Referenced by DSN::ELEM::Format(), and DSN::ELEM::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::ROUTE, DSN::PCB, DSN::WIRING, DSN::LIBRARY, DSN::PADSTACK, DSN::IMAGE, DSN::PLACEMENT, and DSN::STRUCTURE.

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

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

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

◆ SetRotation()

void DSN::PLACE::SetRotation ( double aRotation )

inline

Definition at line 1723 of file specctra.h.

     {
         rotation = aRotation;
     }

References rotation.

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

◆ SetVertex()

void DSN::PLACE::SetVertex ( const POINT & aVertex )

inline

Definition at line 1716 of file specctra.h.

     {
         vertex = aVertex;
         vertex.FixNegativeZero();
         hasVertex = true;
     }

References DSN::POINT::FixNegativeZero(), hasVertex, and vertex.

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

◆ Type()

DSN_T DSN::ELEM::Type ( ) const

inlineinherited

Definition at line 210 of file specctra.h.

210 { return type; }

DSN::ELEM::type

DSN_T type

Definition: specctra.h:275

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

Member Data Documentation

◆ component_id

std::string DSN::PLACE::component_id

private

reference designator

Definition at line 1733 of file specctra.h.

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

◆ hasVertex

bool DSN::PLACE::hasVertex

private

Definition at line 1739 of file specctra.h.

Referenced by Format(), DSN::SPECCTRA_DB::FromSESSION(), PLACE(), and SetVertex().

◆ lock_type

DSN_T DSN::PLACE::lock_type

private

Definition at line 1751 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACE(), Format(), and PLACE().

◆ logical_part

std::string DSN::PLACE::logical_part

private

Definition at line 1745 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACE(), and Format().

◆ mirror

DSN_T DSN::PLACE::mirror

private

Definition at line 1742 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACE(), Format(), and PLACE().

◆ parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 276 of file specctra.h.

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

◆ part_number

std::string DSN::PLACE::part_number

private

Definition at line 1758 of file specctra.h.

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

◆ place_rules

RULE* DSN::PLACE::place_rules

private

Definition at line 1747 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACE(), Format(), PLACE(), and ~PLACE().

◆ properties

PROPERTIES DSN::PLACE::properties

private

Definition at line 1749 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACE(), and Format().

◆ region

REGION* DSN::PLACE::region

private

Definition at line 1755 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACE(), Format(), PLACE(), and ~PLACE().

◆ rotation

double DSN::PLACE::rotation

private

Definition at line 1737 of file specctra.h.

Referenced by Format(), DSN::SPECCTRA_DB::FromSESSION(), PLACE(), and SetRotation().

◆ rules

RULE* DSN::PLACE::rules

private

Definition at line 1754 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACE(), Format(), PLACE(), and ~PLACE().

◆ sf

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 273 of file specctra.h.

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

◆ side

DSN_T DSN::PLACE::side

private

Definition at line 1735 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACE(), Format(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::FromSESSION(), and PLACE().

◆ status

DSN_T DSN::PLACE::status

private

Definition at line 1743 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPLACE(), Format(), and PLACE().

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

◆ vertex

POINT DSN::PLACE::vertex

private

Definition at line 1740 of file specctra.h.

Referenced by Format(), DSN::SPECCTRA_DB::FromSESSION(), and SetVertex().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PLACE()

◆ ~PLACE()

Member Function Documentation

◆ Format()

◆ FormatContents()

◆ GetUnits()

◆ makeHash()

◆ Name()

◆ SetParent()

◆ SetRotation()

◆ SetVertex()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

Member Data Documentation

◆ component_id

◆ hasVertex

◆ lock_type

◆ logical_part

◆ mirror

◆ parent

◆ part_number

◆ place_rules

◆ properties

◆ region

◆ rotation

◆ rules

◆ sf

◆ side

◆ status

◆ type

◆ vertex