X2_gerber_attributes.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2010-2018 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

 
#ifndef X2_GERBER_ATTRIBUTE_H
#define X2_GERBER_ATTRIBUTE_H
 
/*
 * Manage the gerber extensions (attributes) in the new X2 version
 * only few extensions are handled
 * See http://www.ucamco.com/files/downloads/file/81/the_gerber_file_format_specification.pdf
 *
 * gerber attributes in the new X2 version look like:
 * %TF.FileFunction,Copper,L1,Top*%
 *
 * Currently:
 * .FileFunction .FileFunction Identifies the file's function in the PCB.
 *  Other Standard Attributes, not yet used in Gerbview:
 * .Part Identifies the part the file represents, e.g. a single PCB
 * .MD5 Sets the MD5 file signature or checksum.
 */
 
#include <wx/arrstr.h>

 
class X2_ATTRIBUTE
{
public:
    X2_ATTRIBUTE();
    ~X2_ATTRIBUTE();

    wxArrayString& GetPrms() { return m_Prms; }

    const wxString& GetPrm( int aIdx );

    const wxString& GetAttribute();

    int GetPrmCount() { return int( m_Prms.GetCount() ); }

    bool ParseAttribCmd( FILE* aFile, char *aBuffer, int aBuffSize, char* &aText, int& aLineNum );

    void DbgListPrms();

    bool IsFileFunction()
    {
        return GetAttribute().IsSameAs( wxT(".FileFunction"), false );
    }

    bool IsFileMD5()
    {
        return GetAttribute().IsSameAs( wxT(".MD5"), false );
    }

    bool IsFilePart()
    {
        return GetAttribute().IsSameAs( wxT(".Part"), false );
    }
 
protected:
    wxArrayString m_Prms;   
};

 
class X2_ATTRIBUTE_FILEFUNCTION : public X2_ATTRIBUTE
{
public:
    X2_ATTRIBUTE_FILEFUNCTION( X2_ATTRIBUTE& aAttributeBase );
 
    bool IsCopper();                    

    bool IsDrillFile();
 
    const wxString& GetFileType();      
    const wxString& GetBrdLayerId();    

    const wxString GetDrillLayerPair();

    const wxString& GetLPType();

    const wxString& GetRouteType();
 
    const wxString& GetBrdLayerSide();  
    const wxString& GetLabel();         
 
    int GetZOrder() { return m_z_order; }           
    int GetZSubOrder() { return m_z_sub_order; }    
 
private:

    void set_Z_Order();
 
    int m_z_order;              // the z order of the layer for a board
    int m_z_sub_order;          // the z sub_order of the copper layer for a board
};
 
#endif      // X2_GERBER_ATTRIBUTE_H