component_class.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 <http://www.gnu.org/licenses/>.
 */
 
 
#ifndef PCBNEW_COMPONENT_CLASS_H
#define PCBNEW_COMPONENT_CLASS_H
 
#include <wx/string.h>
#include <vector>
 
class COMPONENT_CLASS
{
public:
    enum class USAGE
    {
        STATIC,
        DYNAMIC,
        STATIC_AND_DYNAMIC,
        EFFECTIVE
    };
 
    explicit COMPONENT_CLASS( const wxString& name, const USAGE aUsageContext ) :
            m_name( name ), m_usageContext( aUsageContext )
    {
    }
 
    wxString GetHumanReadableName() const;
 
    const wxString& GetName() const { return m_name; }
 
    void AddConstituentClass( COMPONENT_CLASS* componentClass );
 
    const COMPONENT_CLASS* GetConstituentClass( const wxString& className ) const;
 
    bool ContainsClassName( const wxString& className ) const;
 
    bool IsEmpty() const;
 
    const std::vector<COMPONENT_CLASS*>& GetConstituentClasses() const
    {
        return m_constituentClasses;
    }
 
    USAGE GetUsageContext() const { return m_usageContext; }
 
    void SetUsageContext( const USAGE aUsageContext ) { m_usageContext = aUsageContext; }
 
    bool operator==( const COMPONENT_CLASS& aComponent ) const;
 
    bool operator!=( const COMPONENT_CLASS& aComponent ) const;
 
private:
    wxString m_name;
 
    std::vector<COMPONENT_CLASS*> m_constituentClasses;
 
    USAGE m_usageContext;
};
 
#endif //PCBNEW_COMPONENT_CLASS_H