WIZARD_PARAMETER Class Reference

#include <footprint_wizard.h>

Inheritance diagram for WIZARD_PARAMETER:

Public Member Functions
	WIZARD_PARAMETER ()=default
virtual	~WIZARD_PARAMETER ()=default
virtual void	Reset ()=0
virtual kiapi::common::types::WizardParameter	Pack (bool aCompact=true)
	Packs the current state of this parameter back into a protobuf message.

Static Public Member Functions
static std::unique_ptr< WIZARD_PARAMETER >	Create (const kiapi::common::types::WizardParameter &aProto)
static wxString	ParameterCategoryName (kiapi::common::types::WizardParameterCategory aCategory)

Public Attributes
wxString	identifier
wxString	name
wxString	description
kiapi::common::types::WizardParameterCategory	category = kiapi::common::types::WPC_UNKNOWN
kiapi::common::types::WizardParameterDataType	type = kiapi::common::types::WPDT_UNKNOWN

Detailed Description

Definition at line 45 of file footprint_wizard.h.

Constructor & Destructor Documentation

WIZARD_PARAMETER()

WIZARD_PARAMETER::WIZARD_PARAMETER ( )

default

~WIZARD_PARAMETER()

virtual WIZARD_PARAMETER::~WIZARD_PARAMETER ( )

virtualdefault

Member Function Documentation

Create()

std::unique_ptr< WIZARD_PARAMETER > WIZARD_PARAMETER::Create ( const kiapi::common::types::WizardParameter & aProto )

static

Definition at line 215 of file footprint_wizard.cpp.

References WIZARD_BOOL_PARAMETER::FromProto(), WIZARD_INT_PARAMETER::FromProto(), WIZARD_REAL_PARAMETER::FromProto(), and WIZARD_STRING_PARAMETER::FromProto().

Referenced by WIZARD_INFO::FromProto().

Pack()

kiapi::common::types::WizardParameter WIZARD_PARAMETER::Pack ( bool aCompact = true )

virtual

Packs the current state of this parameter back into a protobuf message.

Parameters

aCompact

will only include the identifier and value if true

Returns

a protobuf message describing this parameter

Reimplemented in WIZARD_BOOL_PARAMETER, WIZARD_INT_PARAMETER, WIZARD_REAL_PARAMETER, and WIZARD_STRING_PARAMETER.

Definition at line 250 of file footprint_wizard.cpp.

References category, description, identifier, name, and type.

Referenced by WIZARD_BOOL_PARAMETER::Pack(), WIZARD_INT_PARAMETER::Pack(), WIZARD_REAL_PARAMETER::Pack(), and WIZARD_STRING_PARAMETER::Pack().

ParameterCategoryName()

wxString WIZARD_PARAMETER::ParameterCategoryName ( kiapi::common::types::WizardParameterCategory aCategory )

static

Definition at line 197 of file footprint_wizard.cpp.

References _.

Referenced by FOOTPRINT_WIZARD_PROPERTIES_PANEL::RebuildParameters().

Reset()

virtual void WIZARD_PARAMETER::Reset ( )

pure virtual

Implemented in WIZARD_BOOL_PARAMETER, WIZARD_INT_PARAMETER, WIZARD_REAL_PARAMETER, and WIZARD_STRING_PARAMETER.

Member Data Documentation

category

kiapi::common::types::WizardParameterCategory WIZARD_PARAMETER::category = kiapi::common::types::WPC_UNKNOWN

Definition at line 63 of file footprint_wizard.h.

Referenced by Pack().

description

wxString WIZARD_PARAMETER::description

Definition at line 62 of file footprint_wizard.h.

Referenced by FOOTPRINT_WIZARD_PROPERTIES_PANEL::createPGProperty(), and Pack().

identifier

wxString WIZARD_PARAMETER::identifier

Definition at line 60 of file footprint_wizard.h.

Referenced by FOOTPRINT_WIZARD_PROPERTIES_PANEL::createPGProperty(), and Pack().

name

wxString WIZARD_PARAMETER::name

Definition at line 61 of file footprint_wizard.h.

Referenced by FOOTPRINT_WIZARD_PROPERTIES_PANEL::createPGProperty(), and Pack().

type

kiapi::common::types::WizardParameterDataType WIZARD_PARAMETER::type = kiapi::common::types::WPDT_UNKNOWN

Definition at line 64 of file footprint_wizard.h.

Referenced by FOOTPRINT_WIZARD_PROPERTIES_PANEL::createPGProperty(), and Pack().

---

The documentation for this class was generated from the following files:

• footprint_wizard.h
• footprint_wizard.cpp