CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL Struct Reference

#include <cadstar_archive_parser.h>

Inheritance diagram for CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL:

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

Public Attributes
DOCUMENTATION_SYMBOL_ID	ID
SYMDEF_ID	SymdefID
	Normally documentation symbols only have TEXT, FIGURE and TEXT_LOCATION objects which are all drawn on the "(Undefined)" Layer. More...
LAYER_ID	LayerID
	Move all objects in the Symdef to this layer. More...
POINT	Origin
	Origin of the component (this is used as the reference point when placing the component in the design) More...
GROUP_ID	GroupID = wxEmptyString
	If not empty, this component is part of a group. More...
REUSEBLOCKREF	ReuseBlockRef
long	OrientAngle = 0
bool	Mirror = false
bool	Fixed = false
READABILITY	Readability = READABILITY::BOTTOM_TO_TOP
long	ScaleRatioNumerator = 1
	Documentation symbols can be arbitrarily scaled when added to a design. More...
long	ScaleRatioDenominator = 1
	Documentation symbols can be arbitrarily scaled when added to a design. More...
std::map< ATTRIBUTE_ID, ATTRIBUTE_VALUE >	AttributeValues

Detailed Description

Definition at line 1233 of file cadstar_archive_parser.h.

Member Function Documentation

Parse()

void CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::Parse ( XNODE *  aNode, PARSER_CONTEXT *  aContext  )

overridevirtual

Implements CADSTAR_ARCHIVE_PARSER::PARSER.

Definition at line 2227 of file cadstar_archive_parser.cpp.

{
 wxASSERT( aNode->GetName() == wxT( "DOCSYMBOL" ) );
 
 ID = GetXmlAttributeIDString( aNode, 0 );
 SymdefID = GetXmlAttributeIDString( aNode, 1 );
 LayerID = GetXmlAttributeIDString( aNode, 2 );
 
 XNODE* cNode = aNode->GetChildren();
 bool originParsed = false;
 
 for( ; cNode; cNode = cNode->GetNext() )
 {
 wxString cNodeName = cNode->GetName();
 
 if( !originParsed && cNodeName == wxT( "PT" ) )
 {
 Origin.Parse( cNode, aContext );
 originParsed = true;
 }
 else if( cNodeName == wxT( "GROUPREF" ) )
 {
 GroupID = GetXmlAttributeIDString( cNode, 0 );
 }
 else if( cNodeName == wxT( "REUSEBLOCKREF" ) )
 {
 ReuseBlockRef.Parse( cNode, aContext );
 }
 else if( cNodeName == wxT( "FIX" ) )
 {
 Fixed = true;
 }
 else if( cNodeName == wxT( "MIRROR" ) )
 {
 Mirror = true;
 }
 else if( cNodeName == wxT( "READABILITY" ) )
 {
 Readability = ParseReadability( cNode );
 }
 else if( cNodeName == wxT( "ORIENT" ) )
 {
 OrientAngle = GetXmlAttributeIDLong( cNode, 0 );
 }
 else if( cNodeName == wxT( "ATTR" ) )
 {
 ATTRIBUTE_VALUE attr;
 attr.Parse( cNode, aContext );
 AttributeValues.insert( std::make_pair( attr.AttributeID, attr ) );
 }
 else if( cNodeName == wxT( "SCALE" ) )
 {
 ScaleRatioNumerator = GetXmlAttributeIDLong( cNode, 0 );
 ScaleRatioDenominator = GetXmlAttributeIDLong( cNode, 1 );
 }
 else
 {
 THROW_UNKNOWN_NODE_IO_ERROR( cNodeName, aNode->GetName() );
 }
 }
 
 if( !originParsed )
 THROW_MISSING_PARAMETER_IO_ERROR( wxT( "PT" ), aNode->GetName() );
}

References CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::AttributeID, XNODE::GetChildren(), XNODE::GetNext(), CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDLong(), CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::Parse(), CADSTAR_ARCHIVE_PARSER::ParseReadability(), THROW_MISSING_PARAMETER_IO_ERROR, and THROW_UNKNOWN_NODE_IO_ERROR.

Referenced by CADSTAR_SCH_ARCHIVE_PARSER::CADSTAR_SCHEMATIC::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::LAYOUT::Parse().

Member Data Documentation

AttributeValues

std::map<ATTRIBUTE_ID, ATTRIBUTE_VALUE> CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::AttributeValues

Definition at line 1257 of file cadstar_archive_parser.h.

Fixed

bool CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::Fixed = false

Definition at line 1249 of file cadstar_archive_parser.h.

GroupID

GROUP_ID CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::GroupID = wxEmptyString

If not empty, this component is part of a group.

Definition at line 1245 of file cadstar_archive_parser.h.

ID

DOCUMENTATION_SYMBOL_ID CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::ID

Definition at line 1235 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_SCH_ARCHIVE_PARSER::CADSTAR_SCHEMATIC::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::LAYOUT::Parse().

LayerID

LAYER_ID CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::LayerID

Move all objects in the Symdef to this layer.

Definition at line 1241 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), and CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols().

Mirror

bool CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::Mirror = false

Definition at line 1248 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), and CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols().

OrientAngle

long CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::OrientAngle = 0

Definition at line 1247 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), and CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols().

Origin

POINT CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::Origin

Origin of the component (this is used as the reference point when placing the component in the design)

Definition at line 1242 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), and CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols().

Readability

READABILITY CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::Readability = READABILITY::BOTTOM_TO_TOP

Definition at line 1250 of file cadstar_archive_parser.h.

ReuseBlockRef

REUSEBLOCKREF CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::ReuseBlockRef

Definition at line 1246 of file cadstar_archive_parser.h.

ScaleRatioDenominator

long CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::ScaleRatioDenominator = 1

Documentation symbols can be arbitrarily scaled when added to a design.

Definition at line 1254 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), and CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols().

ScaleRatioNumerator

long CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::ScaleRatioNumerator = 1

Documentation symbols can be arbitrarily scaled when added to a design.

Definition at line 1252 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), and CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols().

SymdefID

SYMDEF_ID CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::SymdefID

Normally documentation symbols only have TEXT, FIGURE and TEXT_LOCATION objects which are all drawn on the "(Undefined)" Layer.

When used in the design, the user has to specify which layer to draw it on.

Definition at line 1237 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), and CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols().

---

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

• cadstar_archive_parser.h
• cadstar_archive_parser.cpp