#include <property.h>

Inheritance diagram for PROPERTY_BASE:

Public Member Functions
	PROPERTY_BASE (const wxString &aName, PROPERTY_DISPLAY aDisplay=PT_DEFAULT, ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType=ORIGIN_TRANSFORMS::NOT_A_COORD)
	< Used to generate unique IDs. Must come up front so it's initialized before ctor. More...

virtual	~PROPERTY_BASE ()

const wxString &	Name () const

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

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

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

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...

virtual size_t	OwnerHash () const =0
	Return type-id of the Owner class. More...

virtual size_t	BaseHash () const =0
	Return type-id of the Base class. More...

virtual size_t	TypeHash () const =0
	Return type-id of the property type. More...

virtual bool	IsReadOnly () const =0

PROPERTY_DISPLAY	Display () const

ORIGIN_TRANSFORMS::COORD_TYPES_T	CoordType () const

void	SetIsInternal (bool aIsInternal)

bool	IsInternal () 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

Private Member Functions
virtual void	setter (void *aObject, wxAny &aValue)=0

virtual wxAny	getter (const void *aObject) const =0

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. More...

wxString	m_group
	Optional group identifier. More...

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

Friends
class	INSPECTABLE

Detailed Description

Definition at line 175 of file property.h.

Constructor & Destructor Documentation

◆ PROPERTY_BASE()

PROPERTY_BASE::PROPERTY_BASE	(	const wxString &	aName,
		PROPERTY_DISPLAY	aDisplay = `PT_DEFAULT`,
		ORIGIN_TRANSFORMS::COORD_TYPES_T	aCoordType = `ORIGIN_TRANSFORMS::NOT_A_COORD`
	)

inline

< Used to generate unique IDs. Must come up front so it's initialized before ctor.

Definition at line 181 of file property.h.

  :
 m_name( aName ),
 m_display( aDisplay ),
 m_coordType( aCoordType ),
 m_isInternal( false ),
 m_availFunc( [](INSPECTABLE*)->bool { return true; } )
 {
 }

◆ ~PROPERTY_BASE()

virtual PROPERTY_BASE::~PROPERTY_BASE ( )

inlinevirtual

Definition at line 191 of file property.h.

192 {

193 }

Member Function Documentation

◆ Available()

bool PROPERTY_BASE::Available ( INSPECTABLE * aObject ) const

inline

Return true if aObject offers this PROPERTY.

Definition at line 230 of file property.h.

 {
 return m_availFunc( aObject );
 }

Referenced by BOOST_AUTO_TEST_CASE().

◆ BaseHash()

virtual size_t PROPERTY_BASE::BaseHash ( ) const

pure virtual

Return type-id of the Base class.

Implemented in PROPERTY< Owner, T, Base >, and PROPERTY< Owner, T, Owner >.

Referenced by PROPERTY_MANAGER::ReplaceProperty().

◆ Choices()

virtual const wxPGChoices & PROPERTY_BASE::Choices ( ) const

inlinevirtual

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

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

Reimplemented in PROPERTY_ENUM< Owner, T, Base >.

Definition at line 204 of file property.h.

 {
 static wxPGChoices empty;
 return empty;
 }

References empty().

Referenced by BOOST_AUTO_TEST_CASE(), PCB_PROPERTIES_PANEL::createPGProperty(), and PGPropertyFactory().

◆ CoordType()

ORIGIN_TRANSFORMS::COORD_TYPES_T PROPERTY_BASE::CoordType ( ) const

inline

Definition at line 265 of file property.h.

265{ return m_coordType; }

Referenced by PGPropertyFactory().

◆ Display()

PROPERTY_DISPLAY PROPERTY_BASE::Display ( ) const

inline

Definition at line 260 of file property.h.

 {
 return m_display;
 }

Referenced by PGPropertyFactory().

◆ get()

template<typename T >

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

inlineprotected

Definition at line 294 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()

virtual wxAny PROPERTY_BASE::getter ( const void * aObject ) const

privatepure virtual

Implemented in PROPERTY< Owner, T, Base >, PROPERTY< Owner, T, Owner >, and PROPERTY_ENUM< Owner, T, Base >.

Referenced by INSPECTABLE::Get().

◆ Group()

wxString PROPERTY_BASE::Group ( ) const

inline

Definition at line 270 of file property.h.

270{ return m_group; }

PROPERTY_BASE::m_group

wxString m_group

Optional group identifier.

Definition: property.h:317

◆ HasChoices()

virtual bool PROPERTY_BASE::HasChoices ( ) const

inlinevirtual

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

See also: PROPERTY_BASE::Choices()

Reimplemented in PROPERTY_ENUM< Owner, T, Base >.

Definition at line 222 of file property.h.

 {
 return false;
 }

Referenced by BOOST_AUTO_TEST_CASE(), PCB_PROPERTIES_PANEL::createPGProperty(), PCB_EXPR_UCODE::CreateVarRef(), and PGPropertyFactory().

◆ IsInternal()

bool PROPERTY_BASE::IsInternal ( ) const

inline

Definition at line 268 of file property.h.

268{ return m_isInternal; }

◆ IsReadOnly()

virtual bool PROPERTY_BASE::IsReadOnly ( ) const

pure virtual

Implemented in PROPERTY< Owner, T, Base >, and PROPERTY< Owner, T, Owner >.

Referenced by PCB_PROPERTIES_PANEL::createPGProperty(), and PGPropertyFactory().

◆ Name()

const wxString & PROPERTY_BASE::Name ( ) const

inline

Definition at line 195 of file property.h.

 {
 return m_name;
 }

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

◆ OwnerHash()

virtual size_t PROPERTY_BASE::OwnerHash ( ) const

pure virtual

Return type-id of the Owner class.

Implemented in PROPERTY< Owner, T, Base >, and PROPERTY< Owner, T, Owner >.

Referenced by PROPERTY_MANAGER::AddProperty(), INSPECTABLE::Get(), PROPERTY_MANAGER::ReplaceProperty(), and INSPECTABLE::Set().

◆ set()

template<typename T >

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

inlineprotected

Definition at line 275 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 )
 {
 wxAny pv = getter( aObject );
 
 if( pv.CheckType<unsigned>() )
 a = static_cast<unsigned>( static_cast<wxVariant>( aValue ).GetLong() );
 }
 
 setter( aObject, a );
 }

Referenced by INSPECTABLE::Set().

◆ SetAvailableFunc()

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

inline

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

Definition at line 238 of file property.h.

 {
 m_availFunc = aFunc;
 }

◆ SetChoices()

virtual void PROPERTY_BASE::SetChoices ( const wxPGChoices & aChoices )

inlinevirtual

Set the possible values for for the property.

Reimplemented in PROPERTY_ENUM< Owner, T, Base >.

Definition at line 213 of file property.h.

 {
 wxFAIL; // only possible for PROPERTY_ENUM
 }

Referenced by PCB_PROPERTIES_PANEL::updateLists().

◆ SetGroup()

void PROPERTY_BASE::SetGroup ( const wxString & aGroup )

inline

Definition at line 271 of file property.h.

271{ m_group = aGroup; }

Referenced by PROPERTY_MANAGER::AddProperty().

◆ SetIsInternal()

void PROPERTY_BASE::SetIsInternal ( bool aIsInternal )

inline

Definition at line 267 of file property.h.

267{ m_isInternal = aIsInternal; }

◆ setter()

virtual void PROPERTY_BASE::setter	(	void *	aObject,
		wxAny &	aValue
	)

privatepure virtual

Implemented in PROPERTY< Owner, T, Base >, PROPERTY< Owner, T, Owner >, and PROPERTY_ENUM< Owner, T, Base >.

Referenced by INSPECTABLE::Set().

◆ TypeHash()

virtual size_t PROPERTY_BASE::TypeHash ( ) const

pure virtual

Return type-id of the property type.

Implemented in PROPERTY< Owner, T, Base >, and PROPERTY< Owner, T, Owner >.

Referenced by PCB_PROPERTIES_PANEL::createPGProperty(), PCB_EXPR_UCODE::CreateVarRef(), and PGPropertyFactory().

Friends And Related Function Documentation

◆ INSPECTABLE

friend class INSPECTABLE

friend

Definition at line 321 of file property.h.

Member Data Documentation

◆ m_availFunc

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

private

Eval to determine if prop is available.

Definition at line 319 of file property.h.

◆ m_coordType

const ORIGIN_TRANSFORMS::COORD_TYPES_T PROPERTY_BASE::m_coordType

private

Definition at line 311 of file property.h.

◆ m_display

const PROPERTY_DISPLAY PROPERTY_BASE::m_display

private

Definition at line 310 of file property.h.

◆ m_group

wxString PROPERTY_BASE::m_group

private

Optional group identifier.

Definition at line 317 of file property.h.

◆ m_isInternal

bool PROPERTY_BASE::m_isInternal

private

Internal properties are hidden from the GUI.

Definition at line 314 of file property.h.

◆ m_name

const wxString PROPERTY_BASE::m_name

private

Definition at line 309 of file property.h.

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

property.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PROPERTY_BASE()

◆ ~PROPERTY_BASE()

Member Function Documentation

◆ Available()

◆ BaseHash()

◆ Choices()

◆ CoordType()

◆ Display()

◆ get()

◆ getter()

◆ Group()

◆ HasChoices()

◆ IsInternal()

◆ IsReadOnly()

◆ Name()

◆ OwnerHash()

◆ set()

◆ SetAvailableFunc()

◆ SetChoices()

◆ SetGroup()

◆ SetIsInternal()

◆ setter()

◆ TypeHash()

Friends And Related Function Documentation

◆ INSPECTABLE

Member Data Documentation

◆ m_availFunc

◆ m_coordType

◆ m_display

◆ m_group

◆ m_isInternal

◆ m_name