schematic_settings.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 3 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 KICAD_SCHEMATIC_SETTINGS_H
#define KICAD_SCHEMATIC_SETTINGS_H
 
#include <default_values.h>
#include <settings/nested_settings.h>
#include <settings/bom_settings.h>
#include <font/font_metrics.h>
 
class NGSPICE_SETTINGS;
class REFDES_TRACKER;
 
 
// The minimal grid size allowed to place a pin is 25 mils.  Tthe best grid size is 50 mils,
// but 25 mils is still usable.
// This is because all symbols are using a 50 mils grid to place pins, and therefore the wires
// must be on the 50 mils grid.
#define MIN_CONNECTION_GRID_MILS 25
#define DEFAULT_CONNECTION_GRID_MILS 50
 
 
class SYMBOL_PARITY_SETTINGS
{
public:
    SYMBOL_PARITY_SETTINGS();
 
    bool m_MissingFields;
    bool m_ExtraFields;
    bool m_FieldTexts;
    bool m_FieldVisibilities;
    bool m_FieldStyles;
    bool m_FieldPositions;
    bool m_PinVisibilities;
    bool m_PinAltFunctions;
    bool m_ExcludeFromBoardFlags;
    bool m_DNPFlags;
    bool m_ExcludeFromBOMFlags;
    bool m_ExcludeFromPosFileFlags;
};
 

class SCHEMATIC_SETTINGS : public NESTED_SETTINGS, public FIELDS_TABLE_BOM_SETTINGS
{
public:
    SCHEMATIC_SETTINGS( JSON_SETTINGS* aParent, const std::string& aPath );
 
    virtual ~SCHEMATIC_SETTINGS();
 
    wxString SubReference( int aUnit, bool aAddSeparator = true ) const;

    int GetJunctionSize();

    double GetHopOverScale();

    int SymbolCompareFlags();
 
public:
    // Default sizes are all stored in IU here, and in mils in the JSON file
 
    int       m_DefaultLineWidth;
    int       m_DefaultTextSize;
    double    m_LabelSizeRatio;
    double    m_TextOffsetRatio;
    int       m_PinSymbolSize;
 
    int       m_JunctionSizeChoice;     // none = 0, smallest = 1, small = 2, etc.
    int       m_HopOverSizeChoice;      // none = 0, smallest = 1, etc.
    bool      m_ShowDNPMarkers;
 
    int       m_ConnectionGridSize;     // usually 50mils (IU internally; mils in the JSON file)
 
    int       m_AnnotateStartNum;       // Starting value for annotation
    int       m_AnnotateSortOrder;      // Annotation sort order
    int       m_AnnotateMethod;         // Annotation numbering method (linear, sheet * 100, etc)
 
    int       m_SubpartIdSeparator;     // the separator char between the subpart id and the
                                        //   reference like U1A, U1.A or U1-A
    int       m_SubpartFirstId;         // the ASCII char value to calculate the subpart symbol
                                        //   id from the symbol number: only 'A', 'a' or '1' can
                                        //   be used, other values have no sense.
 
    bool      m_IntersheetRefsShow;
    bool      m_IntersheetRefsListOwnPage;
    bool      m_IntersheetRefsFormatShort;
    wxString  m_IntersheetRefsPrefix;
    wxString  m_IntersheetRefsSuffix;
 
    double    m_DashedLineDashRatio;        // Dash length as ratio of the lineWidth
    double    m_DashedLineGapRatio;         // Gap length as ratio of the lineWidth
 
    int       m_OPO_VPrecision;         // Operating-point overlay voltage significant digits
    wxString  m_OPO_VRange;             // Operating-point overlay voltage range
    int       m_OPO_IPrecision;         // Operating-point overlay current significant digits
    wxString  m_OPO_IRange;             // Operating-point overlay current range
 
    wxString  m_SchDrawingSheetFileName;
    wxString  m_PlotDirectoryName;
 
    KIFONT::METRICS             m_FontMetrics;

    int                         m_MaxError;
 
    SYMBOL_PARITY_SETTINGS      m_SymbolParity;

    std::shared_ptr<NGSPICE_SETTINGS> m_NgspiceSettings;

    std::shared_ptr<REFDES_TRACKER> m_refDesTracker;

    std::map<wxString, wxString> m_VariantDescriptions;
};
 
#endif