CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION Struct Reference

Corresponds to CADSTAR "origin". More...

#include <cadstar_archive_parser.h>

Inheritance diagram for CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION:

Public Member Functions
	TEXT_LOCATION ()
void	Parse (XNODE *aNode, PARSER_CONTEXT *aContext) override
void	ParseIdentifiers (XNODE *aNode, PARSER_CONTEXT *aContext)
bool	ParseSubNode (XNODE *aChildNode, PARSER_CONTEXT *aContext)

Public Attributes
ATTRIBUTE_ID	AttributeID
TEXTCODE_ID	TextCodeID
LAYER_ID	LayerID
POINT	Position
long	OrientAngle = 0
bool	Mirror = false
bool	Fixed = false
JUSTIFICATION	Justification
	Note: Justification has no effect on single lines of text. More...
ALIGNMENT	Alignment
	In CADSTAR The default alignment for a TEXT object (when "(No Alignment()" is selected) Bottom Left of the first line. More...

Detailed Description

Corresponds to CADSTAR "origin".

This is used for setting a location of an attribute e.g. Designator (called Component Name in CADSTAR), Part Name (name of component in the library), etc. The atom identifier is "TEXTLOC"

Definition at line 742 of file cadstar_archive_parser.h.

Constructor & Destructor Documentation

TEXT_LOCATION()

CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::TEXT_LOCATION ( )

inline

Definition at line 744 of file cadstar_archive_parser.h.

        {
            // The default alignment for TEXT_LOCATION (when "NO_ALIGNMENT" is selected) is
            // Bottom left, matching CADSTAR's default behaviour
            Alignment = ALIGNMENT::BOTTOMLEFT;
        }

References CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::Alignment, and CADSTAR_ARCHIVE_PARSER::BOTTOMLEFT.

Member Function Documentation

Parse()

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

overridevirtual

Reimplemented from CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION.

Definition at line 1203 of file cadstar_archive_parser.cpp.

{
    wxASSERT( aNode->GetName() == wxT( "TEXTLOC" ) );

    wxString attributeStr     = GetXmlAttributeIDString( aNode, 0 );
    bool     attributeIDisSet = false;

    if( attributeStr == wxT( "PART_NAME" ) )
    {
        AttributeID      = PART_NAME_ATTRID;
        attributeIDisSet = true;
    }
    else if( attributeStr == wxT( "COMP_NAME" ) )
    {
        AttributeID      = COMPONENT_NAME_ATTRID;
        attributeIDisSet = true;
    }
    else if( attributeStr == wxT( "COMP_NAME2" ) )
    {
        AttributeID      = COMPONENT_NAME_2_ATTRID;
        attributeIDisSet = true;
    }
    else if( attributeStr == wxT( "SYMBOL_NAME" ) )
    {
        AttributeID      = SYMBOL_NAME_ATTRID;
        attributeIDisSet = true;
    }
    else if( attributeStr == wxT( "LINK_ORIGIN" ) )
    {
        AttributeID      = LINK_ORIGIN_ATTRID;
        attributeIDisSet = true;
    }
    else if( attributeStr == wxT( "SIGNALNAME_ORIGIN" ) )
    {
        AttributeID      = SIGNALNAME_ORIGIN_ATTRID;
        attributeIDisSet = true;
    }
    else if( attributeStr == wxT( "ATTRREF" ) )
    {
        //We will initialise when we parse all child nodes
        attributeIDisSet = false;
    }
    else
    {
        THROW_UNKNOWN_PARAMETER_IO_ERROR( attributeStr, wxT( "TEXTLOC" ) );
    }

    TextCodeID = GetXmlAttributeIDString( aNode, 1 );
    LayerID    = GetXmlAttributeIDString( aNode, 2, false );

    //Parse child nodes
    XNODE* cNode = aNode->GetChildren();

    for( ; cNode; cNode = cNode->GetNext() )
    {
        wxString cNodeName = cNode->GetName();

        if( ParseSubNode( cNode, aContext ) )
        {
            continue;
        }
        else if( !attributeIDisSet && cNodeName == wxT( "ATTRREF" ) )
        {
            AttributeID      = GetXmlAttributeIDString( cNode, 0 );
            attributeIDisSet = true;
        }
        else if( cNodeName == wxT( "ORIENT" ) )
        {
            OrientAngle = GetXmlAttributeIDLong( cNode, 0 );
        }
        else if( cNodeName == wxT( "MIRROR" ) )
        {
            Mirror = true;
        }
        else if( cNodeName == wxT( "FIX" ) )
        {
            Fixed = true;
        }
        else if( cNodeName == wxT( "ALIGN" ) )
        {
            Alignment = ParseAlignment( cNode );
        }
        else if( cNodeName == wxT( "JUSTIFICATION" ) )
        {
            Justification = ParseJustification( cNode );
        }
        else
        {
            THROW_UNKNOWN_NODE_IO_ERROR( cNodeName, wxT( "TEXTLOC" ) );
        }
    }

    if( !Position.IsFullySpecified() )
        THROW_MISSING_NODE_IO_ERROR( wxT( "PT" ), wxT( "TEXTLOC" ) );
}

References COMPONENT_NAME_2_ATTRID, COMPONENT_NAME_ATTRID, XNODE::GetChildren(), XNODE::GetNext(), CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDLong(), CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), LINK_ORIGIN_ATTRID, CADSTAR_ARCHIVE_PARSER::ParseAlignment(), CADSTAR_ARCHIVE_PARSER::ParseJustification(), PART_NAME_ATTRID, SIGNALNAME_ORIGIN_ATTRID, SYMBOL_NAME_ATTRID, THROW_MISSING_NODE_IO_ERROR, THROW_UNKNOWN_NODE_IO_ERROR, and THROW_UNKNOWN_PARAMETER_IO_ERROR.

Referenced by CADSTAR_ARCHIVE_PARSER::SYMDEF::ParseSubNode().

ParseIdentifiers()

void CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::ParseIdentifiers ( XNODE *  aNode, PARSER_CONTEXT *  aContext  )

inherited

Definition at line 999 of file cadstar_archive_parser.cpp.

{
    TextCodeID = GetXmlAttributeIDString( aNode, 0 );
    LayerID    = GetXmlAttributeIDString( aNode, 1 );
}

References CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString().

ParseSubNode()

bool CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::ParseSubNode ( XNODE *  aChildNode, PARSER_CONTEXT *  aContext  )

inherited

Definition at line 1006 of file cadstar_archive_parser.cpp.

{
    wxString cNodeName = aChildNode->GetName();

    if( cNodeName == wxT( "PT" ) )
        Position.Parse( aChildNode, aContext );
    else if( cNodeName == wxT( "ORIENT" ) )
        OrientAngle = GetXmlAttributeIDLong( aChildNode, 0 );
    else if( cNodeName == wxT( "MIRROR" ) )
        Mirror = true;
    else if( cNodeName == wxT( "FIX" ) )
        Fixed = true;
    else if( cNodeName == wxT( "ALIGN" ) )
        Alignment = ParseAlignment( aChildNode );
    else if( cNodeName == wxT( "JUSTIFICATION" ) )
        Justification = ParseJustification( aChildNode );
    else
        return false;

    return true;
}

References CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDLong(), CADSTAR_ARCHIVE_PARSER::ParseAlignment(), and CADSTAR_ARCHIVE_PARSER::ParseJustification().

Member Data Documentation

Alignment

ALIGNMENT CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::Alignment

inherited

Initial value:

= ALIGNMENT::
                NO_ALIGNMENT

In CADSTAR The default alignment for a TEXT object (when "(No Alignment()" is selected) Bottom Left of the first line.

Note that this is different from BOTTOM_LEFT (which is bottom left of the whole text block)

Definition at line 667 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute(), and TEXT_LOCATION().

AttributeID

ATTRIBUTE_ID CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::AttributeID

Definition at line 750 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadComponentAttributes(), and CADSTAR_ARCHIVE_PARSER::SYMDEF::ParseSubNode().

Fixed

bool CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::Fixed = false

inherited

Definition at line 664 of file cadstar_archive_parser.h.

Justification

JUSTIFICATION CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::Justification

inherited

Initial value:

=
                JUSTIFICATION::LEFT

Note: Justification has no effect on single lines of text.

Definition at line 665 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute().

LayerID

LAYER_ID CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::LayerID

inherited

Definition at line 660 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute().

Mirror

bool CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::Mirror = false

inherited

Definition at line 663 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute().

OrientAngle

long CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::OrientAngle = 0

inherited

Definition at line 662 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute().

Position

POINT CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::Position

inherited

Definition at line 661 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute().

TextCodeID

TEXTCODE_ID CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::TextCodeID

inherited

Definition at line 659 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute().

---

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

• cadstar_archive_parser.h
• cadstar_archive_parser.cpp