#include <property.h>

Inheritance diagram for PROPERTY_ENUM< Owner, T, Base >:

Public Types
using	BASE_TYPE = typename std::decay< T >::type

Public Member Functions
template<typename SetType , typename GetType >
	PROPERTY_ENUM (const wxString &aName, void(Base::aSetter)(SetType), GetType(Base::aGetter)(), PROPERTY_DISPLAY aDisplay=PT_DEFAULT)

template<typename SetType , typename GetType >
	PROPERTY_ENUM (const wxString &aName, void(Base::aSetter)(SetType), GetType(Base::aGetter)() const, PROPERTY_DISPLAY aDisplay=PT_DEFAULT, ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType=ORIGIN_TRANSFORMS::NOT_A_COORD)

void	setter (void *obj, wxAny &v) override

wxAny	getter (const void *obj) const override
	Set method. More...

const wxPGChoices &	Choices () const override
	Return a limited set of possible values (e.g. More...

void	SetChoices (const wxPGChoices &aChoices) override
	Set the possible values for for the property. More...

bool	HasChoices () const override
	Return true if this PROPERTY has a limited set of possible values. More...

size_t	OwnerHash () const override
	Return type-id of the Owner class. More...

size_t	BaseHash () const override
	Return type-id of the Base class. More...

size_t	TypeHash () const override
	Return type-id of the property type. More...

bool	Writeable (INSPECTABLE *aObject) const override

const wxString &	Name () const

bool	Available (INSPECTABLE *aObject) const
	Return true if aObject offers this PROPERTY. More...

void	SetAvailableFunc (std::function< bool(INSPECTABLE *)> aFunc)
	Set a callback function to determine whether an object provides this property. More...

void	SetWriteableFunc (std::function< bool(INSPECTABLE *)> aFunc)

PROPERTY_DISPLAY	Display () const

ORIGIN_TRANSFORMS::COORD_TYPES_T	CoordType () const

void	SetIsInternal (bool aIsInternal=true)

bool	IsInternal () const

void	SetIsDeprecated (bool aIsDeprecated=true)

bool	IsDeprecated () const

wxString	Group () const

void	SetGroup (const wxString &aGroup)

Protected Member Functions
template<typename T >
void	set (void *aObject, T aValue)

template<typename T >
T	get (const void *aObject) const

Protected Attributes
wxPGChoices	m_choices

std::unique_ptr< SETTER_BASE< Owner, T > >	m_setter
	Get method. More...

std::unique_ptr< GETTER_BASE< Owner, T > >	m_getter
	Owner class type-id. More...

const size_t	m_ownerHash
	Base class type-id. More...

const size_t	m_baseHash
	Property value type-id. More...

const size_t	m_typeHash

Private Attributes
const wxString	m_name

const PROPERTY_DISPLAY	m_display

const ORIGIN_TRANSFORMS::COORD_TYPES_T	m_coordType

bool	m_isInternal
	Internal properties are hidden from the GUI but not from the rules editor autocomplete. More...

bool	m_isDeprecated
	Deprecated properties are hidden from the GUI and rules editor autocomplete. More...

wxString	m_group
	Optional group identifier. More...

std::function< bool(INSPECTABLE *)>	m_availFunc
	Eval to determine if prop is available. More...

std::function< bool(INSPECTABLE *)>	m_writeableFunc
	Eval to determine if prop is read-only. More...

Detailed Description

template<typename Owner, typename T, typename Base = Owner>
class PROPERTY_ENUM< Owner, T, Base >

Definition at line 446 of file property.h.

Member Typedef Documentation

◆ BASE_TYPE

using PROPERTY< Owner, T, Owner >::BASE_TYPE = typename std::decay<T>::type

inherited

Definition at line 356 of file property.h.

Constructor & Destructor Documentation

◆ PROPERTY_ENUM() [1/2]

template<typename Owner , typename T , typename Base = Owner>

template<typename SetType , typename GetType >

PROPERTY_ENUM< Owner, T, Base >::PROPERTY_ENUM	(	const wxString &	aName,
		void(Base::*)(SetType)	aSetter,
		GetType(Base::*)()	aGetter,
		PROPERTY_DISPLAY	aDisplay = `PT_DEFAULT`
	)

inline

Definition at line 450 of file property.h.

 : PROPERTY<Owner, T, Base>( aName, METHOD<Owner, T, Base>::Wrap( aSetter ),
 METHOD<Owner, T, Base>::Wrap( aGetter ), aDisplay )
 {
 if ( std::is_enum<T>::value )
 {
 m_choices = ENUM_MAP<T>::Instance().Choices();
 wxASSERT_MSG( m_choices.GetCount() > 0, wxT( "No enum choices defined" ) );
 }
 }

References ENUM_MAP< T >::Instance(), and PROPERTY_ENUM< Owner, T, Base >::m_choices.

◆ PROPERTY_ENUM() [2/2]

template<typename Owner , typename T , typename Base = Owner>

template<typename SetType , typename GetType >

PROPERTY_ENUM< Owner, T, Base >::PROPERTY_ENUM	(	const wxString &	aName,
		void(Base::*)(SetType)	aSetter,
		GetType(Base::*)() const	aGetter,
		PROPERTY_DISPLAY	aDisplay = `PT_DEFAULT`,
		ORIGIN_TRANSFORMS::COORD_TYPES_T	aCoordType = `ORIGIN_TRANSFORMS::NOT_A_COORD`
	)

inline

Definition at line 464 of file property.h.

 : PROPERTY<Owner, T, Base>( aName, METHOD<Owner, T, Base>::Wrap( aSetter ),
 METHOD<Owner, T, Base>::Wrap( aGetter ), aDisplay, aCoordType )
 {
 if ( std::is_enum<T>::value )
 {
 m_choices = ENUM_MAP<T>::Instance().Choices();
 wxASSERT_MSG( m_choices.GetCount() > 0, wxT( "No enum choices defined" ) );
 }
 }

References ENUM_MAP< T >::Instance(), and PROPERTY_ENUM< Owner, T, Base >::m_choices.

Member Function Documentation

◆ Available()

bool PROPERTY_BASE::Available ( INSPECTABLE * aObject ) const

inlineinherited

Return true if aObject offers this PROPERTY.

Definition at line 233 of file property.h.

 {
 return m_availFunc( aObject );
 }

Referenced by BOOST_AUTO_TEST_CASE(), and PROPERTY_MANAGER::IsAvailableFor().

◆ BaseHash()

size_t PROPERTY< Owner, T, Owner >::BaseHash ( ) const

inlineoverridevirtualinherited

Return type-id of the Base class.

Implements PROPERTY_BASE.

Definition at line 383 of file property.h.

 {
 return m_baseHash;
 }

◆ Choices()

template<typename Owner , typename T , typename Base = Owner>

const wxPGChoices & PROPERTY_ENUM< Owner, T, Base >::Choices ( ) const

inlineoverridevirtual

Return a limited set of possible values (e.g.

enum). Check with HasChoices() if a particular PROPERTY provides such set.

Reimplemented from PROPERTY_BASE.

Definition at line 506 of file property.h.

 {
 return m_choices.GetCount() > 0 ? m_choices : ENUM_MAP<T>::Instance().Choices();
 }

References ENUM_MAP< T >::Instance(), and PROPERTY_ENUM< Owner, T, Base >::m_choices.

Referenced by PROPERTY_ENUM< Owner, T, Base >::HasChoices().

◆ CoordType()

ORIGIN_TRANSFORMS::COORD_TYPES_T PROPERTY_BASE::CoordType ( ) const

inlineinherited

Definition at line 276 of file property.h.

276{ return m_coordType; }

PROPERTY_BASE::m_coordType

const ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType

Definition: property.h:333

Referenced by PGPropertyFactory().

◆ Display()

PROPERTY_DISPLAY PROPERTY_BASE::Display ( ) const

inlineinherited

Definition at line 271 of file property.h.

 {
 return m_display;
 }

Referenced by PGPropertyFactory().

◆ get()

template<typename T >

T PROPERTY_BASE::get ( const void * aObject ) const

inlineprotectedinherited

Definition at line 316 of file property.h.

 {
 wxAny a = getter( aObject );
 
 if ( !( std::is_enum<T>::value && a.CheckType<int>() ) && !a.CheckType<T>() )
 throw std::invalid_argument( "Invalid requested type" );
 
 return wxANY_AS( a, T );
 }

Referenced by INSPECTABLE::Get().

◆ getter()

template<typename Owner , typename T , typename Base = Owner>

wxAny PROPERTY_ENUM< Owner, T, Base >::getter ( const void * obj ) const

inlineoverridevirtual

Set method.

Reimplemented from PROPERTY< Owner, T, Owner >.

Definition at line 499 of file property.h.

 {
 const Owner* o = reinterpret_cast<const Owner*>( obj );
 wxAny res = static_cast<T>( (*PROPERTY<Owner, T, Base>::m_getter)( o ) );
 return res;
 }

References res.

◆ Group()

wxString PROPERTY_BASE::Group ( ) const

inlineinherited

Definition at line 284 of file property.h.

284{ return m_group; }

PROPERTY_BASE::m_group

wxString m_group

Optional group identifier.

Definition: property.h:342

◆ HasChoices()

template<typename Owner , typename T , typename Base = Owner>

bool PROPERTY_ENUM< Owner, T, Base >::HasChoices ( ) const

inlineoverridevirtual

Return true if this PROPERTY has a limited set of possible values.

See also: PROPERTY_BASE::Choices()

Reimplemented from PROPERTY_BASE.

Definition at line 516 of file property.h.

 {
 return Choices().GetCount() > 0;
 }

References PROPERTY_ENUM< Owner, T, Base >::Choices().

◆ IsDeprecated()

bool PROPERTY_BASE::IsDeprecated ( ) const

inlineinherited

Definition at line 282 of file property.h.

282{ return m_isDeprecated; }

PROPERTY_BASE::m_isDeprecated

bool m_isDeprecated

Deprecated properties are hidden from the GUI and rules editor autocomplete.

Definition: property.h:339

◆ IsInternal()

bool PROPERTY_BASE::IsInternal ( ) const

inlineinherited

Definition at line 279 of file property.h.

279{ return m_isInternal; }

PROPERTY_BASE::m_isInternal

bool m_isInternal

Internal properties are hidden from the GUI but not from the rules editor autocomplete.

Definition: property.h:336

◆ Name()

const wxString & PROPERTY_BASE::Name ( ) const

inlineinherited

Definition at line 198 of file property.h.

 {
 return m_name;
 }

Referenced by PROPERTY_MANAGER::AddProperty(), PCB_PROPERTIES_PANEL::createPGProperty(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::IsAvailableFor(), and PGPropertyFactory().

◆ OwnerHash()

size_t PROPERTY< Owner, T, Owner >::OwnerHash ( ) const

inlineoverridevirtualinherited

Return type-id of the Owner class.

Implements PROPERTY_BASE.

Definition at line 378 of file property.h.

 {
 return m_ownerHash;
 }

◆ set()

template<typename T >

void PROPERTY_BASE::set	(	void *	aObject,
		T	aValue
	)

inlineprotectedinherited

Definition at line 289 of file property.h.

 {
 wxAny a = aValue;
 
 // wxVariant will be type "long" even if the property is supposed to be
 // unsigned. Let's trust that we're coming from the property grid where
 // we used a UInt editor.
 if( std::is_same<T, wxVariant>::value )
 {
 wxVariant var = static_cast<wxVariant>( aValue );
 wxAny pv = getter( aObject );
 
 if( pv.CheckType<unsigned>() )
 {
 a = static_cast<unsigned>( var.GetLong() );
 }
 else if( pv.CheckType<EDA_ANGLE>() )
 {
 EDA_ANGLE_VARIANT_DATA* ad = static_cast<EDA_ANGLE_VARIANT_DATA*>( var.GetData() );
 a = ad->Angle();
 }
 }
 
 setter( aObject, a );
 }

References EDA_ANGLE_VARIANT_DATA::Angle().

Referenced by INSPECTABLE::Set().

◆ SetAvailableFunc()

void PROPERTY_BASE::SetAvailableFunc ( std::function< bool(INSPECTABLE *)> aFunc )

inlineinherited

Set a callback function to determine whether an object provides this property.

Definition at line 241 of file property.h.

 {
 m_availFunc = aFunc;
 }

◆ SetChoices()

template<typename Owner , typename T , typename Base = Owner>

void PROPERTY_ENUM< Owner, T, Base >::SetChoices ( const wxPGChoices & aChoices )

inlineoverridevirtual

Set the possible values for for the property.

Reimplemented from PROPERTY_BASE.

Definition at line 511 of file property.h.

 {
 m_choices = aChoices;
 }

References PROPERTY_ENUM< Owner, T, Base >::m_choices.

◆ SetGroup()

void PROPERTY_BASE::SetGroup ( const wxString & aGroup )

inlineinherited

Definition at line 285 of file property.h.

285{ m_group = aGroup; }

Referenced by PROPERTY_MANAGER::AddProperty().

◆ SetIsDeprecated()

void PROPERTY_BASE::SetIsDeprecated ( bool aIsDeprecated = true )

inlineinherited

Definition at line 281 of file property.h.

281{ m_isDeprecated = aIsDeprecated; }

◆ SetIsInternal()

void PROPERTY_BASE::SetIsInternal ( bool aIsInternal = true )

inlineinherited

Definition at line 278 of file property.h.

278{ m_isInternal = aIsInternal; }

◆ setter()

template<typename Owner , typename T , typename Base = Owner>

void PROPERTY_ENUM< Owner, T, Base >::setter	(	void *	obj,
		wxAny &	v
	)

inlineoverridevirtual

Reimplemented from PROPERTY< Owner, T, Owner >.

Definition at line 478 of file property.h.

 {
 wxCHECK( ( PROPERTY<Owner, T, Base>::m_setter ), /*void*/ );
 Owner* o = reinterpret_cast<Owner*>( obj );
 
 if( v.CheckType<T>() )
 {
 T value = wxANY_AS(v, T);
 (*PROPERTY<Owner, T, Base>::m_setter)( o, value );
 }
 else if (v.CheckType<int>() )
 {
 int value = wxANY_AS(v, int);
 (*PROPERTY<Owner, T, Base>::m_setter)( o, static_cast<T>( value ) );
 }
 else
 {
 throw std::invalid_argument( "Invalid type requested" );
 }
 }

◆ SetWriteableFunc()

void PROPERTY_BASE::SetWriteableFunc ( std::function< bool(INSPECTABLE *)> aFunc )

inlineinherited

Definition at line 251 of file property.h.

 {
 m_writeableFunc = aFunc;
 }

◆ TypeHash()

size_t PROPERTY< Owner, T, Owner >::TypeHash ( ) const

inlineoverridevirtualinherited

Return type-id of the property type.

Implements PROPERTY_BASE.

Definition at line 388 of file property.h.

 {
 return m_typeHash;
 }

◆ Writeable()

bool PROPERTY< Owner, T, Owner >::Writeable ( INSPECTABLE * aObject ) const

inlineoverridevirtualinherited

Reimplemented from PROPERTY_BASE.

Definition at line 393 of file property.h.

 {
 return m_setter && PROPERTY_BASE::Writeable( aObject );
 }

Member Data Documentation

◆ m_availFunc

std::function<bool(INSPECTABLE*)> PROPERTY_BASE::m_availFunc

privateinherited

Eval to determine if prop is available.

Definition at line 344 of file property.h.

◆ m_baseHash

const size_t PROPERTY< Owner, T, Owner >::m_baseHash

protectedinherited

Property value type-id.

Definition at line 438 of file property.h.

◆ m_choices

template<typename Owner , typename T , typename Base = Owner>

wxPGChoices PROPERTY_ENUM< Owner, T, Base >::m_choices

protected

Definition at line 522 of file property.h.

Referenced by PROPERTY_ENUM< Owner, T, Base >::Choices(), PROPERTY_ENUM< Owner, T, Base >::PROPERTY_ENUM(), and PROPERTY_ENUM< Owner, T, Base >::SetChoices().

◆ m_coordType

const ORIGIN_TRANSFORMS::COORD_TYPES_T PROPERTY_BASE::m_coordType

privateinherited

Definition at line 333 of file property.h.

◆ m_display

const PROPERTY_DISPLAY PROPERTY_BASE::m_display

privateinherited

Definition at line 332 of file property.h.

◆ m_getter

std::unique_ptr<GETTER_BASE<Owner, T> > PROPERTY< Owner, T, Owner >::m_getter

protectedinherited

Owner class type-id.

Definition at line 432 of file property.h.

◆ m_group

wxString PROPERTY_BASE::m_group

privateinherited

Optional group identifier.

Definition at line 342 of file property.h.

◆ m_isDeprecated

bool PROPERTY_BASE::m_isDeprecated

privateinherited

Deprecated properties are hidden from the GUI and rules editor autocomplete.

Definition at line 339 of file property.h.

◆ m_isInternal

bool PROPERTY_BASE::m_isInternal

privateinherited

Internal properties are hidden from the GUI but not from the rules editor autocomplete.

Definition at line 336 of file property.h.

◆ m_name

const wxString PROPERTY_BASE::m_name

privateinherited

Definition at line 331 of file property.h.

◆ m_ownerHash

const size_t PROPERTY< Owner, T, Owner >::m_ownerHash

protectedinherited

Base class type-id.

Definition at line 435 of file property.h.

◆ m_setter

std::unique_ptr<SETTER_BASE<Owner, T> > PROPERTY< Owner, T, Owner >::m_setter

protectedinherited

Get method.

Definition at line 429 of file property.h.

◆ m_typeHash

const size_t PROPERTY< Owner, T, Owner >::m_typeHash

protectedinherited

Definition at line 441 of file property.h.

◆ m_writeableFunc

std::function<bool(INSPECTABLE*)> PROPERTY_BASE::m_writeableFunc

privateinherited

Eval to determine if prop is read-only.

Definition at line 346 of file property.h.

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

property.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ BASE_TYPE

Constructor & Destructor Documentation

◆ PROPERTY_ENUM() [1/2]

◆ PROPERTY_ENUM() [2/2]

Member Function Documentation

◆ Available()

◆ BaseHash()

◆ Choices()

◆ CoordType()

◆ Display()

◆ get()

◆ getter()

◆ Group()

◆ HasChoices()

◆ IsDeprecated()

◆ IsInternal()

◆ Name()

◆ OwnerHash()

◆ set()

◆ SetAvailableFunc()

◆ SetChoices()

◆ SetGroup()

◆ SetIsDeprecated()

◆ SetIsInternal()

◆ setter()

◆ SetWriteableFunc()

◆ TypeHash()

◆ Writeable()

Member Data Documentation

◆ m_availFunc

◆ m_baseHash

◆ m_choices

◆ m_coordType

◆ m_display

◆ m_getter

◆ m_group

◆ m_isDeprecated

◆ m_isInternal

◆ m_name

◆ m_ownerHash

◆ m_setter

◆ m_typeHash

◆ m_writeableFunc