A list property with different sub-properties for defining row and item filters. More...

#include <filterlistproperty.h>

Inheritance diagram for inviwo::FilterListProperty:

Public Member Functions
virtual std::string_view	getClassIdentifier () const override

	FilterListProperty (std::string_view identifier, std::string_view displayName, bool supportsFilterOnHeader=false, FilterTypes supportedFilters=FilterTypes(flags::any), size_t maxNumberOfElements=0, ListPropertyUIFlags uiFlags=ListPropertyUIFlag::Add\|ListPropertyUIFlag::Remove, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

virtual FilterListProperty *	clone () const override

Public Member Functions inherited from inviwo::ListProperty
	ListProperty (std::string_view identifier, std::string_view displayName, Document help={}, std::vector< std::unique_ptr< Property > > prefabs={}, size_t maxNumberOfElements=0, ListPropertyUIFlags uiFlags=ListPropertyUIFlag::Add\|ListPropertyUIFlag::Remove, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

	ListProperty (std::string_view identifier, std::string_view displayName, std::vector< std::unique_ptr< Property > > prefabs, size_t maxNumberOfElements=0, ListPropertyUIFlags uiFlags=ListPropertyUIFlag::Add\|ListPropertyUIFlag::Remove, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

	ListProperty (std::string_view identifier, std::string_view displayName, std::unique_ptr< Property > prefab, size_t maxNumberOfElements=0, ListPropertyUIFlags uiFlags=ListPropertyUIFlag::Add\|ListPropertyUIFlag::Remove, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

	ListProperty (std::string_view identifier, std::string_view displayName, size_t maxNumberOfElements, ListPropertyUIFlags uiFlags=ListPropertyUIFlag::Add\|ListPropertyUIFlag::Remove, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

	ListProperty (const ListProperty &rhs)

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 void	set (const Property *src) override

void	set (const ListProperty *src)

void	setMaxNumberOfElements (size_t n)
	set the max number of list elements. This will remove additional properties if the list property contains more than `n` items.

size_t	getMaxNumberOfElements () const

virtual void	clear () override
	remove all list entries

Property *	constructProperty (size_t prefabIndex)
	construct a list entry which is created from the respective prefab object. This function has no effect if the list size will exceed the maximum number of elements.

virtual void	addProperty (Property *property, bool owner=true) override
	add `property` as new list entry. The type of the property must match one of the prefab objects. This function has no effect if the list size will exceed the maximum number of elements.

virtual void	addProperty (Property &property) override
	add `property` as new list entry. The type of the property must match one of the prefab objects. This function has no effect if the list size will exceed the maximum number of elements.

virtual void	insertProperty (size_t index, Property *property, bool owner=true) override
	insert `property` in the list at position `index` If `index` is not valid, the property is appended. The type of the property must match one of the prefab objects. This function has no effect if the list size will exceed the maximum number of elements.

virtual void	insertProperty (size_t index, Property &property) override
	insert `property` in the list at position `index` If `index` is not valid, the property is appended. The type of the property must match one of the prefab objects. This function has no effect if the list size will exceed the maximum number of elements.

virtual Property *	removeProperty (std::string_view identifier) override

virtual Property *	removeProperty (Property *property) override

virtual Property *	removeProperty (Property &property) override

virtual Property *	removeProperty (size_t index) override
	remove property referred to by `index`

virtual bool	move (Property *property, size_t newIndex) override

size_t	getPrefabCount () const
	return number of prefab objects

void	addPrefab (std::unique_ptr< Property > p)
	add a new prefab object `p` to be used as template when instantiating new list elements

const std::vector< std::unique_ptr< Property > > &	getPrefabs () const

ListPropertyUIFlags	getUIFlags () const

virtual ListProperty &	setCurrentStateAsDefault () override

virtual ListProperty &	resetToDefaultState () override

virtual bool	isDefaultState () const override

virtual bool	needsSerialization () const override

virtual void	serialize (Serializer &s) const override

virtual void	deserialize (Deserializer &d) override

Public Member Functions inherited from inviwo::CompositeProperty
	CompositeProperty (std::string_view identifier, std::string_view displayName, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

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

	CompositeProperty (const CompositeProperty &rhs)=default

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

virtual bool	isCollapsed () const

virtual CompositeProperty &	setCollapsed (bool value)

CompositeProperty &	setCollapsed (CollapseAction action, CollapseTarget target)

virtual void	setOwner (PropertyOwner *owner) override

void	set (const CompositeProperty *src)

virtual void	setValid () override

virtual InvalidationLevel	getInvalidationLevel () const override

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

virtual void	invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty=0) override

virtual Processor *	getProcessor () override

virtual const Processor *	getProcessor () const override

virtual const PropertyOwner *	getOwner () const override

virtual PropertyOwner *	getOwner () override

virtual InviwoApplication *	getInviwoApplication () override

virtual void	accept (NetworkVisitor &visitor) override
	Accept a NetworkVisitor, the visitor will visit this and then each Property of the CompositeProperty in an undefined order. The Visitor will then visit each Properties's properties and so on.

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

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

virtual	~Property ()
	Removes itself from its PropertyOwner.

virtual Property &	setIdentifier (std::string_view identifier)

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

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

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

virtual const std::string &	getDisplayName () const

virtual Property &	setSemantics (const PropertySemantics &semantics)

virtual PropertySemantics	getSemantics () const

virtual bool	getReadOnly () const

virtual Property &	setInvalidationLevel (InvalidationLevel invalidationLevel)

PropertyOwner *	getOwner ()

const PropertyOwner *	getOwner () const

void	registerWidget (PropertyWidget *propertyWidget)

void	deregisterWidget (PropertyWidget *propertyWidget)

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

void	setInitiatingWidget (PropertyWidget *propertyWidget)

void	clearInitiatingWidget ()

void	updateWidgets ()

bool	hasWidgets () const

virtual Property &	setSerializationMode (PropertySerializationMode mode)

virtual PropertySerializationMode	getSerializationMode () const

virtual Property &	propertyModified ()

virtual Property &	setModified ()

virtual bool	isModified () const

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

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

void	removeOnChange (const BaseCallBack *callback)

virtual Property &	setVisible (bool val)

virtual bool	getVisible () const

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

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

const Document &	getHelp () const

Document &	getHelp ()

Property &	setHelp (Document help)

virtual Document	getDescription () const

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

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

Public Member Functions inherited from inviwo::Observable< PropertyObserver >
	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	addObserver (PropertyObserver *observer)

void	removeObserver (PropertyObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Public Member Functions inherited from inviwo::ObservableInterface
Public Member Functions inherited from inviwo::Serializable
Public Member Functions inherited from inviwo::MetaDataOwner
	MetaDataOwner (const MetaDataOwner &rhs)=default

	MetaDataOwner (MetaDataOwner &rhs)=default

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

MetaDataOwner &	operator= (MetaDataOwner &)=default

void	copyMetaDataFrom (const MetaDataOwner &src)

void	copyMetaDataTo (MetaDataOwner &dst)

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

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

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

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

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

void	serialize (Serializer &s) const

void	deserialize (Deserializer &d)

Public Member Functions inherited from inviwo::PropertyOwner
virtual	~PropertyOwner ()
	Removes all properties and notifies its observers of the removal.

virtual Property *	addProperty (std::unique_ptr< Property > property)

template<typename... Ts>
void	addProperties (Ts &... properties)

virtual Property *	insertProperty (size_t index, std::unique_ptr< Property > property)
	insert property `property` at position `index` If `index` is not valid, the property is appended.

const std::vector< Property * > &	getProperties () const

const std::vector< CompositeProperty * > &	getCompositeProperties () const

std::vector< Property * >	getPropertiesRecursive () const

std::vector< Property * > &	getPropertiesRecursive (std::vector< Property * > &destination) const

Property *	getPropertyByIdentifier (std::string_view identifier, bool recursiveSearch=false) const

Property *	getPropertyByPath (std::string_view path) const

template<class T >
std::vector< T * >	getPropertiesByType (bool recursiveSearch=false) const

bool	empty () const

size_t	size () const

Property *	operator[] (size_t)

const Property *	operator[] (size_t) const

const_iterator	find (Property *property) const

iterator	begin ()

iterator	end ()

const_iterator	begin () const

const_iterator	end () const

const_iterator	cbegin () const

const_iterator	cend () const

virtual bool	isValid () const

InvalidationLevel	getInvalidationLevel () const

virtual void	setAllPropertiesCurrentStateAsDefault ()

virtual void	resetAllProperties ()

virtual void	invokeEvent (Event *event) override

Public Member Functions inherited from inviwo::PropertyOwnerObservable
void	notifyObserversWillAddProperty (PropertyOwner owner, Property property, size_t index)

void	notifyObserversDidAddProperty (Property *property, size_t index)

void	notifyObserversWillRemoveProperty (Property *property, size_t index)

void	notifyObserversDidRemoveProperty (PropertyOwner owner, Property property, size_t index)

Public Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
	Observable (const Observable< PropertyOwnerObserver > &other)

	Observable (Observable< PropertyOwnerObserver > &&other) noexcept

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

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

void	addObserver (PropertyOwnerObserver *observer)

void	removeObserver (PropertyOwnerObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Public Member Functions inherited from inviwo::EventListener
Public Member Functions inherited from inviwo::Observable< CompositePropertyObserver >
	Observable (const Observable< CompositePropertyObserver > &other)

	Observable (Observable< CompositePropertyObserver > &&other) noexcept

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

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

void	addObserver (CompositePropertyObserver *observer)

void	removeObserver (CompositePropertyObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

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

Static Public Attributes inherited from inviwo::ListProperty
static constexpr std::string_view	classIdentifier {"org.inviwo.ListProperty"}

Static Public Attributes inherited from inviwo::CompositeProperty
static constexpr std::string_view	classIdentifier {"org.inviwo.CompositeProperty"}

Additional Inherited Members
Public Types inherited from inviwo::ListProperty
using	iterator = std::vector<Property*>::iterator

using	const_iterator = std::vector<std::unique_ptr<Property>>::const_iterator

Public Types inherited from inviwo::CompositeProperty
enum class	CollapseAction { Collapse , Expand }

enum class	CollapseTarget { Current , Recursive , Children , Siblings }

Public Types inherited from inviwo::PropertyOwner
using	iterator = std::vector<Property*>::iterator

using	const_iterator = std::vector<Property*>::const_iterator

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::Property
	Property (const Property &rhs)

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

void	notifyAboutChange ()

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

void	notifyObserversOnSetDisplayName (Property *property, const std::string &displayName)

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

void	notifyObserversOnSetReadOnly (Property *property, bool readonly)

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 Member Functions inherited from inviwo::PropertyOwner
	PropertyOwner (const PropertyOwner &rhs)

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

void	forEachProperty (std::function< void(Property &)> callback, bool recursiveSearch=false) const

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

Protected Member Functions inherited from inviwo::CompositePropertyObservable
void	notifyObserversOnSetCollapsed (bool collapsed)

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

Protected Attributes inherited from inviwo::Property
CallBackList	onChangeCallback_

PropertySerializationMode	serializationMode_

Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap	metaData_

Protected Attributes inherited from inviwo::PropertyOwner
std::vector< Property * >	properties_

std::vector< EventProperty * >	eventProperties_

std::vector< CompositeProperty * >	compositeProperties_

std::vector< std::unique_ptr< Property > >	ownedProperties_

Detailed Description

A list property with different sub-properties for defining row and item filters.

This property has a number of prefab objects for adding row and item filter properties (BoolCompositeProperty). A row filter is applied to the entire row of a dataset. Item filters, in contrast, are applied to the individual data items. The distinction between row and item filters is based on the property identifiers.

Identifiers of the properties for row filters begin with the following names and hold the listed sub-properties:

emptyLines: Matches empty lines
rowBegin: StringProperty match for matching the beginning of a row
lineRange: IntMinMaxProperty range for a line range (inclusive)

Row filter properties also own a BoolProperty filterOnHeader. If true, the filter should be applied to all rows including headers where applicable (for example in the CSVReader).

Item filters own an IntProperty column defining the target column. Identifiers begin with:

stringItem: StringProperty match for matching strings and a OptionProperty<filters::StringComp> comp for the comparison
intItem: Int64Property value, OptionProperty<filters::NumberComp> comp for the comparison
doubleItem: DoubleProperty value and DoubleProperty epsilon, OptionProperty<filters::NumberComp> comp for the comparison
intRangeItem: Int64MinMaxProperty range for an inclusive range [min, max]
doubleRangeItem: DoubleMinMaxProperty range for an inclusive range [min, max]

See also: CSVReader

Member Function Documentation

◆ clone()

virtual FilterListProperty * inviwo::FilterListProperty::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::ListProperty.

◆ getClassIdentifier()

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

overridevirtual

Reimplemented from inviwo::ListProperty.

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

filterlistproperty.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ getClassIdentifier()