/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 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 MICROWAVE_INDUCTOR__H_
#define MICROWAVE_INDUCTOR__H_

#include <wx/wx.h> // for wxPoint

class MODULE;
class PCB_EDIT_FRAME;

namespace MWAVE
{

/**
 * Parameters for construction of a microwave inductor
 */
struct INDUCTOR_PATTERN
{
public:
    wxPoint m_Start;
    wxPoint m_End;
    int     m_length;       // full length trace.
    int     m_Width;        // Trace width.
};

/**
 * Creates an S-shaped coil footprint for microwave applications.
 */
MODULE* CreateMicrowaveInductor( INDUCTOR_PATTERN& aPattern,
        PCB_EDIT_FRAME* aPcbFrame, wxString& aErrorMessage );

}

#endif // MICROWAVE_INDUCTOR__H_
