KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL Struct Reference

#include <cadstar_archive_parser.h>

Inheritance diagram for CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL:
CADSTAR_ARCHIVE_PARSER::PARSER

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.
 
LAYER_ID LayerID
 Move all objects in the Symdef to this layer.
 
POINT Origin
 Origin of the component (this is used as the reference point when placing the component in the design).
 
GROUP_ID GroupID = wxEmptyString
 If not empty, this component is part of a group.
 
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.
 
long ScaleRatioDenominator = 1
 Documentation symbols can be arbitrarily scaled when added to a design.
 
std::map< ATTRIBUTE_ID, ATTRIBUTE_VALUE > AttributeValues
 

Detailed Description

Definition at line 1200 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 2273 of file cadstar_archive_parser.cpp.

References CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::AttributeID, AttributeValues, Fixed, XNODE::GetChildren(), XNODE::GetNext(), CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDLong(), CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), GroupID, ID, LayerID, Mirror, OrientAngle, Origin, CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::Parse(), CADSTAR_ARCHIVE_PARSER::ParseReadability(), Readability, ReuseBlockRef, ScaleRatioDenominator, ScaleRatioNumerator, SymdefID, THROW_MISSING_PARAMETER_IO_ERROR, and WARN_UNKNOWN_NODE_IO_ERROR.

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

Member Data Documentation

◆ AttributeValues

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

Definition at line 1222 of file cadstar_archive_parser.h.

Referenced by Parse().

◆ Fixed

bool CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::Fixed = false

Definition at line 1216 of file cadstar_archive_parser.h.

Referenced by Parse().

◆ GroupID

GROUP_ID CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::GroupID = wxEmptyString

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

Definition at line 1212 of file cadstar_archive_parser.h.

Referenced by Parse().

◆ ID

DOCUMENTATION_SYMBOL_ID CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::ID

Definition at line 1202 of file cadstar_archive_parser.h.

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

◆ LayerID

LAYER_ID CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::LayerID

Move all objects in the Symdef to this layer.

Definition at line 1208 of file cadstar_archive_parser.h.

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

◆ Mirror

bool CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::Mirror = false

Definition at line 1215 of file cadstar_archive_parser.h.

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

◆ OrientAngle

long CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::OrientAngle = 0

Definition at line 1214 of file cadstar_archive_parser.h.

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

◆ 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 1209 of file cadstar_archive_parser.h.

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

◆ Readability

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

Definition at line 1217 of file cadstar_archive_parser.h.

Referenced by Parse().

◆ ReuseBlockRef

REUSEBLOCKREF CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::ReuseBlockRef

Definition at line 1213 of file cadstar_archive_parser.h.

Referenced by Parse().

◆ ScaleRatioDenominator

long CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::ScaleRatioDenominator = 1

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

Definition at line 1220 of file cadstar_archive_parser.h.

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

◆ ScaleRatioNumerator

long CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::ScaleRatioNumerator = 1

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

Definition at line 1219 of file cadstar_archive_parser.h.

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

◆ 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 1204 of file cadstar_archive_parser.h.

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

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