Inheritance diagram for inviwo::ColumnOptionProperty:

Public Types
enum class	AddNoneOption { No , Yes }

Public Types inherited from inviwo::OptionProperty< int >
using	value_type

Public Member Functions
virtual ColumnOptionProperty *	clone () const override

	ColumnOptionProperty (const ColumnOptionProperty &rhs)

	ColumnOptionProperty (std::string_view identifier, std::string_view displayName, AddNoneOption noneOption=AddNoneOption::No, int defaultIndex=0)

	ColumnOptionProperty (std::string_view identifier, std::string_view displayName, DataFrameInport &port, AddNoneOption noneOption=AddNoneOption::No, int defaultIndex=0)

	ColumnOptionProperty (std::string_view identifier, std::string_view displayName, Document help, AddNoneOption noneOption=AddNoneOption::No, int defaultIndex=0)

	ColumnOptionProperty (std::string_view identifier, std::string_view displayName, Document help, DataFrameInport &port, AddNoneOption noneOption=AddNoneOption::No, int defaultIndex=0)

virtual std::string_view	getClassIdentifier () const override

const std::string &	getSelectedColumnHeader () const

bool	isNoneSelected () const

virtual void	set (const Property *p) override

void	setDefaultSelectedIndex (int index)

void	setOptions (const DataFrame &dataframe)

void	setPort (DataFrameInport &port)

Public Member Functions inherited from inviwo::OptionProperty< int >
OptionProperty &	addOption (int value)

OptionProperty &	addOption (std::string_view identifier, std::string_view displayName)

OptionProperty &	addOption (std::string_view identifier, std::string_view displayName, const int &value)
	Adds an option to the property.

OptionProperty &	addOption (std::string_view identifier, std::string_view displayName, std::string_view value)

virtual OptionProperty &	clearOptions () override

virtual void	deserialize (Deserializer &d) override

const int &	get () const

virtual std::string_view	getClassIdentifierForWidget () const override
	Returns which property's widget should be used when the WidgetFactory tries to create a widget. Defaults to getClassIdentifier(), should only be overridden if a subclass want to reuse another property's widget.

virtual Document	getDescription () const override

virtual std::vector< std::string >	getDisplayNames () const override

virtual std::vector< std::string >	getIdentifiers () const override

virtual const std::string &	getOptionDisplayName (size_t index) const override

virtual const std::string &	getOptionIdentifier (size_t index) const override

const std::vector< OptionPropertyOption< int > > &	getOptions () const

const OptionPropertyOption< int > &	getOptions (size_t index) const

const int &	getOptionValue (size_t index) const

virtual const std::string &	getSelectedDisplayName () const override

virtual const std::string &	getSelectedIdentifier () const override

virtual size_t	getSelectedIndex () const override

const int &	getSelectedValue () const

std::vector< int >	getValues () const

virtual bool	isDefaultState () const override

virtual bool	isSelectedDisplayName (std::string_view name) const override

virtual bool	isSelectedIdentifier (std::string_view identifier) const override

virtual bool	isSelectedIndex (size_t index) const override

bool	isSelectedValue (const int &val) const

	operator const int & () const

	operator std::string_view () const

const int &	operator* () const

const int *	operator-> () const

	OptionProperty (const OptionProperty< int > &rhs)

	OptionProperty (std::string_view identifier, std::string_view displayName, const std::vector< OptionPropertyOption< int > > &options, size_t selectedIndex=0, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	OptionProperty (std::string_view identifier, std::string_view displayName, const std::vector< U > &options, size_t selectedIndex=0, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	OptionProperty (std::string_view identifier, std::string_view displayName, Document help, const std::vector< int > &options, size_t selectedIndex=0, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	OptionProperty (std::string_view identifier, std::string_view displayName, Document help, const std::vector< OptionPropertyOption< int > > &options, size_t selectedIndex=0, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	OptionProperty (std::string_view identifier, std::string_view displayName, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	OptionProperty (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	OptionProperty (std::string_view identifier, std::string_view displayName, OptionPropertyState< int > state)

virtual OptionProperty &	removeOption (size_t index)

virtual OptionProperty &	removeOption (std::string_view identifier)

OptionProperty &	replaceOptions (const std::vector< int > &values)

virtual OptionProperty &	replaceOptions (const std::vector< std::string > &ids, const std::vector< std::string > &displayNames, const std::vector< int > &values)

virtual OptionProperty &	replaceOptions (std::vector< OptionPropertyOption< int > > options)

virtual OptionProperty &	resetToDefaultState () override

virtual void	serialize (Serializer &s) const override

bool	set (const int &value)
	Set the selected index to that of the value provided if found in the list of options.

void	set (const OptionProperty *srcProperty)

bool	set (std::string_view value)
	Set the selected index to that of the value provided if found in the list of options.

virtual OptionProperty &	setCurrentStateAsDefault () override

OptionProperty< int > &	setDefault (const int &value)

OptionProperty< int > &	setDefaultSelectedIndex (size_t index)

virtual bool	setSelectedDisplayName (std::string_view name) override

virtual bool	setSelectedIdentifier (std::string_view identifier) override

virtual bool	setSelectedIndex (size_t index) override

bool	setSelectedValue (const int &val)
	Set the selected index to that of the value provided if found in the list of options.

bool	setSelectedValue (std::string_view value)
	Set the selected index to that of the value provided if found in the list of options.

virtual size_t	size () const override

OptionProperty &	updateOptions (Func &&updater)

OptionProperty< int > &	updateOptions (Func &&updater)

Public Member Functions inherited from inviwo::BaseOptionProperty
	BaseOptionProperty (const BaseOptionProperty &rhs)

	BaseOptionProperty (std::string_view identifier, std::string_view displayName, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

bool	empty () const

void	set (const BaseOptionProperty *srcProperty)

Public Member Functions inherited from inviwo::Property
virtual void	accept (NetworkVisitor &visitor)
	Accept a NetworkVisitor, the visitor will visit this Property.

template<typename P >
Property &	autoLinkToProperty (std::string_view propertyPath)

void	clearInitiatingWidget ()

void	deregisterWidget (PropertyWidget *propertyWidget)

const std::vector< std::pair< std::string, std::string > > &	getAutoLinkToProperty () const

virtual std::string_view	getDisplayName () const

Document &	getHelp ()

const Document &	getHelp () const

virtual std::string_view	getIdentifier () const

virtual InvalidationLevel	getInvalidationLevel () const

PropertyOwner *	getOwner ()

const PropertyOwner *	getOwner () const

std::string_view	getPath () const
	Get the property path as string.

void	getPath (std::pmr::string &out) const

virtual bool	getReadOnly () const

virtual PropertySemantics	getSemantics () const

virtual PropertySerializationMode	getSerializationMode () const

virtual bool	getVisible () const

const std::vector< PropertyWidget * > &	getWidgets () const

bool	hasWidgets () const

virtual bool	isModified () const

virtual bool	needsSerialization () const

const BaseCallBack *	onChange (std::function< void()> callback)

std::shared_ptr< std::function< void()> >	onChangeScoped (std::function< void()> callback)

	Property (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel, PropertySemantics semantics=PropertySemantics::Default)

	Property (std::string_view identifier="", std::string_view displayName="", Document help={}, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default, ReadOnly readOnly=ReadOnly::No)

virtual Property &	propertyModified ()

template<typename P , typename DecisionFunc >
Property &	readonlyDependsOn (P &prop, DecisionFunc callback)

void	registerWidget (PropertyWidget *propertyWidget)

void	removeOnChange (const BaseCallBack *callback)

virtual Property &	setDisplayName (std::string_view displayName)
	A property's name displayed to the user.

Property &	setHelp (Document help)

virtual Property &	setIdentifier (std::string_view identifier)

void	setInitiatingWidget (PropertyWidget *propertyWidget)

virtual Property &	setInvalidationLevel (InvalidationLevel invalidationLevel)

virtual Property &	setModified ()

virtual void	setOwner (PropertyOwner *owner)

virtual Property &	setReadOnly (bool value)
	Enable or disable editing of property.

virtual Property &	setSemantics (const PropertySemantics &semantics)

virtual Property &	setSerializationMode (PropertySerializationMode mode)

virtual void	setValid ()

virtual Property &	setVisible (bool val)

void	updateWidgets ()

template<typename P , typename DecisionFunc >
Property &	visibilityDependsOn (P &prop, DecisionFunc callback)

virtual	~Property ()
	Removes itself from its PropertyOwner.

Public Member Functions inherited from inviwo::Observable< PropertyObserver >
void	addObserver (PropertyObserver *observer)

bool	isObservedBy (PropertyObserver *observer) const

	Observable (const Observable< PropertyObserver > &other)

	Observable (Observable< PropertyObserver > &&other) noexcept

Observable< PropertyObserver > &	operator= (const Observable< PropertyObserver > &other)

Observable< PropertyObserver > &	operator= (Observable< PropertyObserver > &&other) noexcept

void	removeObserver (PropertyObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Public Member Functions inherited from inviwo::MetaDataOwner
void	copyMetaDataFrom (const MetaDataOwner &src)

void	copyMetaDataTo (MetaDataOwner &dst)

template<typename T > requires std::derived_from<T, MetaData>
T *	createMetaData (std::string_view key)

void	deserialize (Deserializer &d)

template<typename T > requires std::derived_from<T, MetaData>
T *	getMetaData (std::string_view key)

template<typename T > requires std::derived_from<T, MetaData>
const T *	getMetaData (std::string_view key) const

template<typename T , typename U > requires std::derived_from<T, MetaData> && Gettable<T, U>
U	getMetaData (std::string_view key, U val) const

MetaDataMap *	getMetaDataMap ()

const MetaDataMap *	getMetaDataMap () const

bool	hasMetaData (std::string_view key) const

template<typename T > requires std::derived_from<T, MetaData>
bool	hasMetaData (std::string_view key) const

	MetaDataOwner (const MetaDataOwner &rhs)=default

	MetaDataOwner (MetaDataOwner &rhs)=default

MetaDataOwner &	operator= (const MetaDataOwner &rhs)=default

MetaDataOwner &	operator= (MetaDataOwner &)=default

void	serialize (Serializer &s) const

template<typename T , typename U > requires std::derived_from<T, MetaData> && Settable<T, U>
void	setMetaData (std::string_view key, U value)

template<typename T > requires std::derived_from<T, MetaData>
bool	unsetMetaData (std::string_view key)
	unset, i.e. remove the metadata entry matching the given key and type

Static Public Attributes
static constexpr std::string_view	classIdentifier {"org.inviwo.DataFrameColumnProperty"}

Additional Inherited Members
Static Public Member Functions inherited from inviwo::Property
template<typename T , typename U >
static void	setStateAsDefault (T &property, const U &state)

Protected Member Functions inherited from inviwo::OptionProperty< int >
std::optional< size_t >	findId (std::string_view id)

const OptionPropertyOption< int > &	opt (size_t index) const

const std::vector< OptionPropertyOption< int > > &	opts () const

std::vector< OptionPropertyOption< int > > &	optsMut ()

Protected Member Functions inherited from inviwo::Property
void	notifyAboutChange ()

Property &	operator= (const Property &that)=delete

Property &	operator= (Property &&that)

	Property (const Property &rhs)

	Property (Property &&rhs)

Protected Member Functions inherited from inviwo::PropertyObservable
void	notifyObserversOnSetDisplayName (Property *property, const std::string &displayName)

void	notifyObserversOnSetIdentifier (Property *property, const std::string &identifier)

void	notifyObserversOnSetReadOnly (Property *property, bool readonly)

void	notifyObserversOnSetSemantics (Property *property, const PropertySemantics &semantics)

void	notifyObserversOnSetVisible (Property *property, bool visible)

Protected Member Functions inherited from inviwo::Observable< PropertyObserver >
void	forEachObserver (C callback)

Protected Member Functions inherited from inviwo::ObservableInterface
void	addObservationHelper (Observer *observer)

void	removeObservationHelper (Observer *observer)

Protected Attributes inherited from inviwo::OptionProperty< int >
size_t	selectedIndex_

Protected Attributes inherited from inviwo::Property
CallBackList	onChangeCallback_

PropertySerializationMode	serializationMode_

Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap	metaData_

Constructor & Destructor Documentation

◆ ColumnOptionProperty() [1/4]

inviwo::ColumnOptionProperty::ColumnOptionProperty	(	std::string_view	identifier,
		std::string_view	displayName,
		Document	help,
		AddNoneOption	noneOption = AddNoneOption::No,
		int	defaultIndex = 0 )

Constructor. If noneOption is set to AddNoneOption::Yes, an additional option ("None") is added to allow for not selecting any column.

Parameters

identifier
displayName
help
noneOption	if equal to AddNoneOption::Yes, "None" will be added as option
defaultIndex	index of the selected column when the property options are updated

◆ ColumnOptionProperty() [2/4]

inviwo::ColumnOptionProperty::ColumnOptionProperty	(	std::string_view	identifier,
		std::string_view	displayName,
		AddNoneOption	noneOption = AddNoneOption::No,
		int	defaultIndex = 0 )

Constructor, no options will be created unless noneOption is set to AddNoneOption::Yes

Parameters

identifier
displayName
noneOption	if equal to AddNoneOption::Yes, "None" will be added as option
defaultIndex	index of the selected column when the property options are updated

◆ ColumnOptionProperty() [3/4]

inviwo::ColumnOptionProperty::ColumnOptionProperty	(	std::string_view	identifier,
		std::string_view	displayName,
		Document	help,
		DataFrameInport &	port,
		AddNoneOption	noneOption = AddNoneOption::No,
		int	defaultIndex = 0 )

Constructor using an inport port to populate the options. The onChange event of port will trigger an update of the options.

Parameters

identifier
displayName
help
port
noneOption	if equal to AddNoneOption::Yes, "None" will be added as option
defaultIndex	index of the selected column when the property options are updated

◆ ColumnOptionProperty() [4/4]

inviwo::ColumnOptionProperty::ColumnOptionProperty	(	std::string_view	identifier,
		std::string_view	displayName,
		DataFrameInport &	port,
		AddNoneOption	noneOption = AddNoneOption::No,
		int	defaultIndex = 0 )

Constructor using an inport port to populate the options. The onChange event of port will trigger an update of the options.

Parameters

identifier
displayName
port
noneOption	if equal to AddNoneOption::Yes, "None" will be added as option
defaultIndex	index of the selected column when the property options are updated

Member Function Documentation

◆ clone()

virtual ColumnOptionProperty * inviwo::ColumnOptionProperty::clone ( ) const

overridevirtual

Creates a clone of this property. The clone will have the same identifier, hence the identifier must be changed if the clone should be added to the same owner as this. The new clone does not have any owner set.

Reimplemented from inviwo::OptionProperty< int >.

◆ getClassIdentifier()

virtual std::string_view inviwo::ColumnOptionProperty::getClassIdentifier ( ) const

overridevirtual

Reimplemented from inviwo::OptionProperty< int >.

◆ getSelectedColumnHeader()

const std::string & inviwo::ColumnOptionProperty::getSelectedColumnHeader ( ) const

Return the header of the currently selected column

Returns: column header. If "None" is selected, an empty string is returned

◆ isNoneSelected()

bool inviwo::ColumnOptionProperty::isNoneSelected ( ) const

Return whether no column is selected.

Returns: true if there is a "None" option and it is selected

◆ set()

virtual void inviwo::ColumnOptionProperty::set ( const Property * srcProperty )

overridevirtual

Set the value of this to that of src. The "value" is in this case considered to be for example the string in a StringProperty or the float value in a FloatProperty. But not things like the identifier of display name.

Reimplemented from inviwo::OptionProperty< int >.

◆ setDefaultSelectedIndex()

void inviwo::ColumnOptionProperty::setDefaultSelectedIndex ( int index )

Set the index of the selected column when the property options are updated. If index is negative and the property has a "None" option, that one will be the new default.

Parameters

index

◆ setOptions()

void inviwo::ColumnOptionProperty::setOptions ( const DataFrame & dataframe )

Replace the options based on the columns in dataframe

◆ setPort()

void inviwo::ColumnOptionProperty::setPort ( DataFrameInport & port )

Populate the options with the data owned by port. The onChange event of port will trigger an update of the options.

Note: A reference to the port will be kept, so the port must outlive the scope of the property.

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

modules/dataframe/include/inviwo/dataframe/properties/columnoptionproperty.h

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ColumnOptionProperty() [1/4]

◆ ColumnOptionProperty() [2/4]

◆ ColumnOptionProperty() [3/4]

◆ ColumnOptionProperty() [4/4]

Member Function Documentation

◆ clone()

◆ getClassIdentifier()

◆ getSelectedColumnHeader()

◆ isNoneSelected()

◆ set()

◆ setDefaultSelectedIndex()

◆ setOptions()

◆ setPort()