pcb_field.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2023 Mike Williams, [email protected]
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef PCB_FIELD_H
#define PCB_FIELD_H
 
#include <pcb_text.h>
#include <template_fieldnames.h>
 
class BOARD_DESIGN_SETTINGS;
 
namespace kiapi::board::types
{
    class Field;
}
 
class PCB_FIELD : public PCB_TEXT
{
public:
    PCB_FIELD( FOOTPRINT* aParent, FIELD_T aFieldId, const wxString& aName = wxEmptyString );
 
    PCB_FIELD( const PCB_TEXT& aText, FIELD_T aFieldId, const wxString& aName = wxEmptyString );
 
    PCB_FIELD( const PCB_FIELD& aField );
 
    void Serialize( google::protobuf::Any &aContainer ) const override;
    bool Deserialize( const google::protobuf::Any &aContainer ) override;
 
    void Serialize( kiapi::board::types::Field& aOutput ) const;
    bool Deserialize( const kiapi::board::types::Field& aInput );
 
    void CopyFrom( const BOARD_ITEM* aOther ) override;
 
    static inline bool ClassOf( const EDA_ITEM* aItem )
    {
        return aItem && PCB_FIELD_T == aItem->Type();
    }
 
    wxString GetClass() const override { return wxT( "PCB_FIELD" ); }
 
    bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override
    {
        if( BOARD_ITEM::IsType( aScanTypes ) )
            return true;
 
        for( KICAD_T scanType : aScanTypes )
        {
            if( scanType == PCB_FIELD_LOCATE_REFERENCE_T && m_id == FIELD_T::REFERENCE )
                return true;
            else if( scanType == PCB_FIELD_LOCATE_VALUE_T && m_id == FIELD_T::VALUE )
                return true;
            else if( scanType == PCB_FIELD_LOCATE_DATASHEET_T && m_id == FIELD_T::DATASHEET )
                return true;
        }
 
        return false;
    }
 
    bool IsReference() const { return m_id == FIELD_T::REFERENCE; }
    bool IsValue() const { return m_id == FIELD_T::VALUE; }
    bool IsDatasheet() const { return m_id == FIELD_T::DATASHEET; }
    bool IsComponentClass() const { return GetName() == wxT( "Component Class" ); }
    bool IsPrivate() const { return m_private; }
    void SetPrivate( bool aPrivate ) { m_private = aPrivate; }
 
    bool IsMandatory() const;
 
    bool HasHypertext() const;
 
    wxString GetTextTypeDescription() const override;
 
    bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override;
 
    wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
 
    double ViewGetLOD( int aLayer, const KIGFX::VIEW* aView ) const override;
 
    EDA_ITEM* Clone() const override;

    PCB_FIELD* CloneField() const { return (PCB_FIELD*) Clone(); }

    wxString GetName( bool aUseDefaultName = true ) const;

    wxString GetUntranslatedName() const;
 
    wxString GetShownText( RESOLUTION_CONTEXT aContext, int aDepth = 0 ) const override;
 
    void SetName( const wxString& aName ) { m_name = aName; }
 
    FIELD_T GetId() const { return m_id; }
 
    int GetOrdinal() const
    {
        return IsMandatory() ? (int) m_id : m_ordinal;
    }
    void SetOrdinal( int aOrdinal, FIELD_T aType )
    {
        m_id = aType;
        m_ordinal = aOrdinal;
    }
 
    double Similarity( const BOARD_ITEM& aOther ) const override;
 
    bool operator==( const PCB_FIELD& aOther ) const;
    bool operator==( const BOARD_ITEM& aOther ) const override;
 
protected:
    void swapData( BOARD_ITEM* aImage ) override;
 
private:
    void setId( FIELD_T aId ) { m_id = aId; }
 
private:
    FIELD_T  m_id;           
    int      m_ordinal;      
    wxString m_name;
    bool     m_private = false; 
};
 
#endif