gbr_netlist_metadata.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * 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 GBR_NETLIST_METADATA_H
#define GBR_NETLIST_METADATA_H

class GBR_CMP_PNP_METADATA
{
public:
    enum MOUNT_TYPE
    {
        MOUNT_TYPE_UNSPECIFIED,
        MOUNT_TYPE_SMD,
        MOUNT_TYPE_TH
    };
 
    GBR_CMP_PNP_METADATA() :
        m_Orientation( 0.0 ),
        m_MountType( MOUNT_TYPE_UNSPECIFIED )
    {}
 
    void ClearData();           // Clear all strings

    wxString FormatCmpPnPMetadata();
 
 
    double m_Orientation;       // orientation in degree
    wxString m_Manufacturer;    // Manufacturer name
    wxString m_MPN;             // Manufacturer part number
    wxString m_Package;         // Package, as per IPC-7351
    wxString m_Footprint;       // Footprint name, from library
    wxString m_LibraryName;     // Library name, containing the footprint
    wxString m_LibraryDescr;    // Library description
    wxString m_Value;           // Component value
    MOUNT_TYPE m_MountType;     // SMD|TH|Other
};

class GBR_DATA_FIELD
{
public:
    GBR_DATA_FIELD() : m_useUTF8( false ), m_escapeString( false )
    {}
 
    void clear()
    {
        m_field.clear();
        m_useUTF8 = false;
        m_escapeString = false;
    }
 
    void Clear() { clear(); }
 
    const wxString& GetValue() const { return m_field; }
 
    void SetField( const wxString& aField, bool aUseUTF8, bool aEscapeString )
    {
        m_field = aField;
        m_useUTF8 = aUseUTF8;
        m_escapeString = aEscapeString;
    }
 
    bool IsEmpty() const { return m_field.IsEmpty(); }
 
    std::string GetGerberString() const;
 
private:
    wxString m_field;       
    bool m_useUTF8;         
    bool m_escapeString;    
};
 

class GBR_NETLIST_METADATA
{
public:
    // This enum enables the different net attributes attached to the object
    // the values can be ORed for items which can have more than one attribute
    // (A flashed pad has all allowed attributes)
    enum GBR_NETINFO_TYPE
    {
        GBR_NETINFO_UNSPECIFIED,    
        GBR_NETINFO_PAD = 1,        
        GBR_NETINFO_NET = 2,        
        GBR_NETINFO_CMP = 4         
    };
 
    GBR_NETLIST_METADATA(): m_NetAttribType( GBR_NETINFO_UNSPECIFIED ),
            m_NotInNet( false ), m_TryKeepPreviousAttributes( false )
    {
    }

    void ClearExtraData()
    {
        m_ExtraData.Clear();
    }

    void SetExtraData( const wxString& aExtraData)
    {
        m_ExtraData = aExtraData;
    }

    void ClearAttribute( const wxString* aName )
    {
        if( m_NetAttribType == GBR_NETINFO_UNSPECIFIED )
        {
            m_Padname.clear();
            m_PadPinFunction.clear();
            m_Cmpref.clear();
            m_Netname.clear();
            return;
        }
 
        if( !aName || aName->IsEmpty() || *aName == wxT( ".CN" ) )
        {
            m_NetAttribType = GBR_NETINFO_UNSPECIFIED;
            m_Padname.clear();
            m_PadPinFunction.clear();
            m_Cmpref.clear();
            m_Netname.clear();
            return;
        }
 
        if( *aName == wxT( ".C" ) )
        {
            m_NetAttribType &= ~GBR_NETINFO_CMP;
            m_Cmpref.clear();
            return;
        }
 
        if( *aName == wxT( ".N" ) )
        {
            m_NetAttribType &= ~GBR_NETINFO_NET;
            m_Netname.clear();
            return;
        }
 
        if( *aName == wxT( ".P" ) )
        {
            m_NetAttribType &= ~GBR_NETINFO_PAD;
            m_Padname.clear();
            m_PadPinFunction.clear();
            return;
        }
    }
 
    // these members are used in the %TO object attributes command.
    int      m_NetAttribType;   
    bool     m_NotInNet;        
    GBR_DATA_FIELD m_Padname;   
    GBR_DATA_FIELD m_PadPinFunction;  
    wxString m_Cmpref;    
    wxString m_Netname;   
 
    wxString m_ExtraData;       

    bool     m_TryKeepPreviousAttributes;
};
 
 
// Flashed pads use the full attribute set: this is a helper for flashed pads
#define GBR_NETINFO_ALL                                                               \
    ( GBR_NETLIST_METADATA::GBR_NETINFO_PAD | GBR_NETLIST_METADATA::GBR_NETINFO_NET   \
      | GBR_NETLIST_METADATA::GBR_NETINFO_CMP )
 
#endif      // GBR_NETLIST_METADATA_H