drc_re_bool_input_constraint_data.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2024 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 DRC_RE_BOOL_INPUT_CONSTRAINT_DATA_H_
#define DRC_RE_BOOL_INPUT_CONSTRAINT_DATA_H_
 
#include "drc_re_base_constraint_data.h"
 
 
class DRC_RE_BOOL_INPUT_CONSTRAINT_DATA : public DRC_RE_BASE_CONSTRAINT_DATA
{
public:
    DRC_RE_BOOL_INPUT_CONSTRAINT_DATA() = default;
 
    explicit DRC_RE_BOOL_INPUT_CONSTRAINT_DATA( const DRC_RE_BASE_CONSTRAINT_DATA& aBaseData ) :
            DRC_RE_BASE_CONSTRAINT_DATA( aBaseData )
    {
    }
 
    explicit DRC_RE_BOOL_INPUT_CONSTRAINT_DATA( int aId, int aParentId, bool aBoolInputValue,
                                                const wxString& aRuleName ) :
            DRC_RE_BASE_CONSTRAINT_DATA( aId, aParentId, aRuleName ),
            m_boolInputValue( aBoolInputValue )
    {
    }
 
    virtual ~DRC_RE_BOOL_INPUT_CONSTRAINT_DATA() = default;
 
    BITMAPS GetOverlayBitmap() const override { return BITMAPS::constraint_vias_under_smd; }
 
    std::vector<DRC_RE_FIELD_POSITION> GetFieldPositions() const override
    {
        // Positions measured from constraint_vias_under_smd.png (~280x160)
        // Format: { xStart, xEnd, yTop, tabOrder }
        return {
            { 90 + DRC_RE_OVERLAY_XO, 110 + DRC_RE_OVERLAY_XO, 150 + DRC_RE_OVERLAY_YO, 1, _( "Disallow" ), LABEL_POSITION::RIGHT }, // checkbox (bottom left corner)
        };
    }
 
    VALIDATION_RESULT Validate() const override
    {
        // Boolean inputs are always valid - any true/false value is acceptable
        return VALIDATION_RESULT();
    }
 
    std::vector<wxString> GetConstraintClauses( const RULE_GENERATION_CONTEXT& aContext ) const override
    {
        if( !m_boolInputValue )
            return {};
 
        wxString code = GetConstraintCode();
        return { wxString::Format( wxS( "(constraint %s)" ), code ) };
    }
 
    wxString GenerateRule( const RULE_GENERATION_CONTEXT& aContext ) override
    {
        auto clauses = GetConstraintClauses( aContext );
 
        if( clauses.empty() )
            return wxEmptyString;
 
        return buildRule( aContext, clauses );
    }
 
    bool GetBoolInputValue() { return m_boolInputValue; }
 
    void SetBoolInputValue( bool aBoolInputValue ) { m_boolInputValue = aBoolInputValue; }
 
    void CopyFrom( const ICopyable& aSource ) override
    {
        const auto& source = dynamic_cast<const DRC_RE_BOOL_INPUT_CONSTRAINT_DATA&>( aSource );
 
        DRC_RE_BASE_CONSTRAINT_DATA::CopyFrom( source );
 
        m_boolInputValue = source.m_boolInputValue;
    }
 
private:
    bool m_boolInputValue{ false };
};
 
#endif // DRC_RE_BOOL_INPUT_CONSTRAINT_DATA_H_