From CADSTAR Help: "Area is for creating areas within which, and nowhere else, certain operations are carried out (e.g. More...

#include <cadstar_pcb_archive_parser.h>

Inheritance diagram for CADSTAR_PCB_ARCHIVE_PARSER::AREA:

Public Member Functions
void	Parse (XNODE aNode, PARSER_CONTEXT aContext) override

Public Attributes
AREA_ID	ID

LINECODE_ID	LineCodeID

wxString	Name

LAYER_ID	LayerID

SHAPE	Shape

RULESET_ID	RuleSetID = wxEmptyString

bool	Fixed = false

bool	Placement = false
	From CADSTAR Help: "Auto Placement can place components within this area. More...

bool	Routing = false
	From CADSTAR Help: "Area can be used to place routes during Automatic Routing. More...

bool	Keepout = false
	From CADSTAR Help: "Auto Placement cannot place components within this area. More...

bool	NoTracks = false
	From CADSTAR Help: "Area cannot be used to place routes during automatic routing. More...

bool	NoVias = false
	From CADSTAR Help: "No vias will be placed within this area by the automatic router. More...

long	AreaHeight = UNDEFINED_VALUE
	From CADSTAR Help: "The Height value specified for the PCB component is checked against the Height value assigned to the Area in which the component is placed. More...

GROUP_ID	GroupID = wxEmptyString
	If not empty, this AREA is part of a group. More...

REUSEBLOCKREF	ReuseBlockRef

std::map< ATTRIBUTE_ID, ATTRIBUTE_VALUE >	AttributeValues

Detailed Description

From CADSTAR Help: "Area is for creating areas within which, and nowhere else, certain operations are carried out (e.g.

Placement.); and for creating 'keep out' areas, within which no operations are carried out and where no items are placed by operations such as Placement and Routing. [...] More than one function can be assigned to an area."

Definition at line 818 of file cadstar_pcb_archive_parser.h.

Member Function Documentation

◆ Parse()

void CADSTAR_PCB_ARCHIVE_PARSER::AREA::Parse	(	XNODE *	aNode,
		PARSER_CONTEXT *	aContext
	)

overridevirtual

Implements CADSTAR_ARCHIVE_PARSER::PARSER.

Definition at line 1651 of file cadstar_pcb_archive_parser.cpp.

 {
     wxASSERT( aNode->GetName() == wxT( "AREA" ) );
 
     ID         = GetXmlAttributeIDString( aNode, 0 );
     LineCodeID = GetXmlAttributeIDString( aNode, 1 );
     Name       = GetXmlAttributeIDString( aNode, 2 );
     LayerID    = GetXmlAttributeIDString( aNode, 4 );
 
     XNODE*   cNode              = aNode->GetChildren();
     bool     shapeIsInitialised = false; // Stop more than one Shape Object
     wxString location           = wxString::Format( "AREA %s", ID );
 
     if( !cNode )
         THROW_MISSING_NODE_IO_ERROR( wxT( "Shape" ), location );
 
     for( ; cNode; cNode = cNode->GetNext() )
     {
         wxString cNodeName = cNode->GetName();
 
         if( !shapeIsInitialised && SHAPE::IsShape( cNode ) )
         {
             Shape.Parse( cNode, aContext );
             shapeIsInitialised = true;
         }
         else if( cNodeName == wxT( "FIX" ) )
         {
             Fixed = true;
         }
         else if( cNodeName == wxT( "USAGE" ) )
         {
             wxXmlAttribute* xmlAttribute = cNode->GetAttributes();
 
             for( ; xmlAttribute; xmlAttribute = xmlAttribute->GetNext() )
             {
                 if( !IsValidAttribute( xmlAttribute ) )
                     continue;
 
                 if( xmlAttribute->GetValue() == wxT( "PLACEMENT" ) )
                     Placement = true;
                 else if( xmlAttribute->GetValue() == wxT( "ROUTING" ) )
                     Routing = true;
                 else if( xmlAttribute->GetValue() == wxT( "KEEPOUT" ) )
                     Keepout = true;
                 else if( xmlAttribute->GetValue() == wxT( "NO_TRACKS" ) )
                     NoTracks = true;
                 else if( xmlAttribute->GetValue() == wxT( "NO_VIAS" ) )
                     NoVias = true;
                 else
                     THROW_UNKNOWN_PARAMETER_IO_ERROR( xmlAttribute->GetValue(), location );
             }
 
             CheckNoChildNodes( cNode );
         }
         else if( cNodeName == wxT( "AREAHEIGHT" ) )
         {
             AreaHeight = GetXmlAttributeIDLong( cNode, 0 );
         }
         else if( cNodeName == wxT( "GROUPREF" ) )
         {
             GroupID = GetXmlAttributeIDString( cNode, 0 );
         }
         else if( cNodeName == wxT( "REUSEBLOCKREF" ) )
         {
             ReuseBlockRef.Parse( cNode, aContext );
         }
         else if( cNodeName == wxT( "ATTR" ) )
         {
             ATTRIBUTE_VALUE attr;
             attr.Parse( cNode, aContext );
             AttributeValues.insert( std::make_pair( attr.AttributeID, attr ) );
         }
         else
         {
             THROW_UNKNOWN_NODE_IO_ERROR( cNodeName, location );
         }
     }
 }

References CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::AttributeID, CADSTAR_ARCHIVE_PARSER::CheckNoChildNodes(), Format(), XNODE::GetChildren(), XNODE::GetNext(), CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDLong(), CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), CADSTAR_ARCHIVE_PARSER::SHAPE::IsShape(), CADSTAR_ARCHIVE_PARSER::IsValidAttribute(), CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::Parse(), THROW_MISSING_NODE_IO_ERROR, THROW_UNKNOWN_NODE_IO_ERROR, and THROW_UNKNOWN_PARAMETER_IO_ERROR.

Referenced by CADSTAR_PCB_ARCHIVE_PARSER::LAYOUT::Parse().

Member Data Documentation

◆ AreaHeight

long CADSTAR_PCB_ARCHIVE_PARSER::AREA::AreaHeight = UNDEFINED_VALUE

From CADSTAR Help: "The Height value specified for the PCB component is checked against the Height value assigned to the Area in which the component is placed.

If the component height exceeds the area height, an error is output"

Definition at line 842 of file cadstar_pcb_archive_parser.h.