array_axis.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 ARRAY_AXIS__H
#define ARRAY_AXIS__H
 
#include <kicommon.h>
#include <optional>
 
#include <wx/string.h>

class KICOMMON_API ARRAY_AXIS
{
public:
    enum NUMBERING_TYPE
    {
        NUMBERING_NUMERIC = 0, 
        NUMBERING_HEX,

        NUMBERING_ALPHA_NO_IOSQXZ,
        NUMBERING_ALPHA_FULL,      
    };

    static bool TypeIsNumeric( NUMBERING_TYPE type )
    {
        return type == NUMBERING_NUMERIC || type == NUMBERING_HEX;
    };
 
    ARRAY_AXIS();

    const wxString& GetAlphabet() const;

    void SetAxisType( NUMBERING_TYPE aType );

    bool SetOffset( const wxString& aOffsetName );

    void SetOffset( int aOffset );

    int GetOffset() const;

    void SetStep( int aStep );

    wxString GetItemNumber( int n ) const;
 
private:
    std::optional<int> getNumberingOffset( const wxString& str ) const;
 
    NUMBERING_TYPE m_type;
    int            m_offset;

    int m_step;

    bool m_useLowercase;
};
 
#endif // ARRAY_AXIS__H