Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::ColumnOptionProperty Class Reference
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 std::string_view getClassIdentifier () const override
 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, 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)
 ColumnOptionProperty (std::string_view identifier, std::string_view displayName, DataFrameInport &port, AddNoneOption noneOption=AddNoneOption::No, int defaultIndex=0)
 ColumnOptionProperty (const ColumnOptionProperty &rhs)
virtual ColumnOptionPropertyclone () const override
void setPort (DataFrameInport &port)
void setOptions (const DataFrame &dataframe)
void setDefaultSelectedIndex (int index)
const std::string & getSelectedColumnHeader () const
bool isNoneSelected () const
virtual void set (const Property *p) override
Public Member Functions inherited from inviwo::OptionProperty< int >
 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, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 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, 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, OptionPropertyState< int > state)
 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 (const OptionProperty< int > &rhs)
 operator const int & () const
 operator std::string_view () const
OptionPropertyaddOption (std::string_view identifier, std::string_view displayName, const int &value)
 Adds an option to the property.
OptionPropertyaddOption (std::string_view identifier, std::string_view displayName)
OptionPropertyaddOption (std::string_view identifier, std::string_view displayName, std::string_view value)
OptionPropertyaddOption (int value)
virtual OptionPropertyremoveOption (std::string_view identifier)
virtual OptionPropertyremoveOption (size_t index)
virtual OptionPropertyclearOptions () override
virtual size_t size () const override
virtual size_t getSelectedIndex () const override
virtual const std::string & getSelectedIdentifier () const override
virtual const std::string & getSelectedDisplayName () const override
const int & getSelectedValue () const
virtual std::vector< std::string > getIdentifiers () const override
virtual std::vector< std::string > getDisplayNames () const override
std::vector< int > getValues () const
const std::vector< OptionPropertyOption< int > > & getOptions () const
virtual const std::string & getOptionIdentifier (size_t index) const override
virtual const std::string & getOptionDisplayName (size_t index) const override
const int & getOptionValue (size_t index) const
const OptionPropertyOption< int > & getOptions (size_t index) const
virtual bool setSelectedIndex (size_t index) override
virtual bool setSelectedIdentifier (std::string_view identifier) override
virtual bool setSelectedDisplayName (std::string_view name) 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 OptionPropertyreplaceOptions (const std::vector< std::string > &ids, const std::vector< std::string > &displayNames, const std::vector< int > &values)
virtual OptionPropertyreplaceOptions (std::vector< OptionPropertyOption< int > > options)
OptionPropertyreplaceOptions (const std::vector< int > &values)
OptionPropertyupdateOptions (Func &&updater)
virtual bool isSelectedIndex (size_t index) const override
virtual bool isSelectedIdentifier (std::string_view identifier) const override
virtual bool isSelectedDisplayName (std::string_view name) const override
bool isSelectedValue (const int &val) const
const int & get () const
const int & operator* () const
const int * operator-> () const
bool set (const int &value)
 Set the selected index to that of the value provided if found in the list of options.
bool set (std::string_view value)
 Set the selected index to that of the value provided if found in the list of options.
void set (const OptionProperty *srcProperty)
virtual OptionPropertysetCurrentStateAsDefault () override
OptionProperty< int > & setDefault (const int &value)
OptionProperty< int > & setDefaultSelectedIndex (size_t index)
virtual OptionPropertyresetToDefaultState () override
virtual bool isDefaultState () const override
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 serialize (Serializer &s) const override
virtual void deserialize (Deserializer &d) override
virtual Document getDescription () const override
OptionProperty< int > & updateOptions (Func &&updater)
 operator const int & () const
Public Member Functions inherited from inviwo::BaseOptionProperty
 BaseOptionProperty (std::string_view identifier, std::string_view displayName, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 BaseOptionProperty (const BaseOptionProperty &rhs)
bool empty () const
void set (const BaseOptionProperty *srcProperty)
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 PropertysetIdentifier (std::string_view identifier)
virtual const std::string & getIdentifier () const
const std::string & getPath () const
 Get the property path as string.
void getPath (std::pmr::string &out) const
virtual PropertysetDisplayName (std::string_view displayName)
 A property's name displayed to the user.
virtual const std::string & getDisplayName () const
virtual PropertysetSemantics (const PropertySemantics &semantics)
virtual PropertySemantics getSemantics () const
virtual PropertysetReadOnly (bool value)
 Enable or disable editing of property.
virtual bool getReadOnly () const
virtual PropertysetInvalidationLevel (InvalidationLevel invalidationLevel)
virtual InvalidationLevel getInvalidationLevel () const
virtual void setOwner (PropertyOwner *owner)
PropertyOwnergetOwner ()
const PropertyOwnergetOwner () 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 PropertysetSerializationMode (PropertySerializationMode mode)
virtual PropertySerializationMode getSerializationMode () const
virtual bool needsSerialization () const
virtual PropertypropertyModified ()
virtual void setValid ()
virtual PropertysetModified ()
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 PropertysetVisible (bool val)
virtual bool getVisible () const
template<typename P, typename DecisionFunc>
PropertyvisibilityDependsOn (P &prop, DecisionFunc callback)
template<typename P, typename DecisionFunc>
PropertyreadonlyDependsOn (P &prop, DecisionFunc callback)
const DocumentgetHelp () const
DocumentgetHelp ()
PropertysetHelp (Document help)
template<typename P>
PropertyautoLinkToProperty (std::string_view propertyPath)
const std::vector< std::pair< std::string, std::string > > & getAutoLinkToProperty () const
virtual void accept (NetworkVisitor &visitor)
 Accept a NetworkVisitor, the visitor will visit this Property.
Public Member Functions inherited from inviwo::Observable< PropertyObserver >
Observable< PropertyObserver > & operator= (const Observable< PropertyObserver > &other)
void addObserver (PropertyObserver *observer)
void removeObserver (PropertyObserver *observer)
virtual void startBlockingNotifications () override final
virtual void stopBlockingNotifications () override final
Public Member Functions inherited from inviwo::MetaDataOwner
 MetaDataOwner (const MetaDataOwner &rhs)=default
 MetaDataOwner (MetaDataOwner &rhs)=default
MetaDataOwneroperator= (const MetaDataOwner &rhs)=default
MetaDataOwneroperator= (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>
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
MetaDataMapgetMetaDataMap ()
const MetaDataMapgetMetaDataMap () 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)

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 >
const std::vector< OptionPropertyOption< int > > & opts () const
const OptionPropertyOption< int > & opt (size_t index) const
std::vector< OptionPropertyOption< int > > & optsMut ()
std::optional< size_t > findId (std::string_view id)
Protected Member Functions inherited from inviwo::Property
 Property (const Property &rhs)
Propertyoperator= (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
virtual void addObserver (Observer *observer)=0
virtual void removeObserver (Observer *observer)=0
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
noneOptionif equal to AddNoneOption::Yes, "None" will be added as option
defaultIndexindex 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
noneOptionif equal to AddNoneOption::Yes, "None" will be added as option
defaultIndexindex 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
noneOptionif equal to AddNoneOption::Yes, "None" will be added as option
defaultIndexindex 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
noneOptionif equal to AddNoneOption::Yes, "None" will be added as option
defaultIndexindex 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 * src)
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:
  • columnoptionproperty.h