Inheritance diagram for inviwo::Settings:

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

virtual InviwoApplication *	getInviwoApplication () override

void	insertProperty (size_t index, Property *property, bool owner) override
	insert property `property` at position `index` If `index` is not valid, the property is appended.

void	load ()

void	save ()

	Settings (const std::string &id, InviwoApplication *app)

	Settings (const std::string &id="")

Public Member Functions inherited from inviwo::PropertyOwner
template<typename... Ts>
void	addProperties (Ts &... properties)

void	addProperty (Property &property)

void	addProperty (Property *property, bool owner=true)

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

iterator	begin ()

const_iterator	begin () const

const_iterator	cbegin () const

const_iterator	cend () const

virtual void	clear ()
	Remove all properties; Owned properties will be deleted.

virtual void	deserialize (Deserializer &d) override

bool	empty () const

iterator	end ()

const_iterator	end () const

const_iterator	find (Property *property) const

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

InvalidationLevel	getInvalidationLevel () const

virtual PropertyOwner *	getOwner ()

virtual const PropertyOwner *	getOwner () const

virtual Processor *	getProcessor ()

virtual const Processor *	getProcessor () const

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

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

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

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

template<std::derived_from< Property > T = Property>
T *	getProperty (std::string_view identifier)

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

Property *	getPropertyByPath (std::string_view path) const

void	insertProperty (size_t index, Property &property)
	insert property `property` at position `index` If `index` is not valid, the property is appended.

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.

virtual void	invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty)

virtual void	invokeEvent (Event *event) override

virtual bool	isValid () const

virtual bool	move (Property *property, size_t newIndex)

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

Property *	operator[] (size_t)

const Property *	operator[] (size_t) const

virtual Property *	removeProperty (iterator it)

Property *	removeProperty (Property &property)

Property *	removeProperty (Property *property)

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

Property *	removeProperty (std::string_view identifier)

virtual void	resetAllProperties ()

virtual void	serialize (Serializer &s) const override

virtual void	setAllPropertiesCurrentStateAsDefault ()

virtual void	setValid ()

size_t	size () const

virtual	~PropertyOwner ()
	Removes all properties and notifies its observers of the removal.

Public Member Functions inherited from inviwo::PropertyOwnerObservable
void	notifyObserversDidAddProperty (Property *property, size_t index)

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

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

void	notifyObserversWillRemoveProperty (Property *property, size_t index)

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

bool	isObservedBy (PropertyOwnerObserver *observer) const

	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	removeObserver (PropertyOwnerObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Protected Member Functions
std::filesystem::path	getFileName () const

Protected Member Functions inherited from inviwo::PropertyOwner
void	forEachProperty (std::function< void(Property &)> callback, bool recursiveSearch=false) const

PropertyOwner &	operator= (PropertyOwner &&that)

	PropertyOwner (const PropertyOwner &rhs)

	PropertyOwner (PropertyOwner &&rhs)

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

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

void	removeObservationHelper (Observer *observer)

Protected Attributes
InviwoApplication *	app_

std::string	identifier_

bool	isDeserializing_

Protected Attributes inherited from inviwo::PropertyOwner
std::vector< CompositeProperty * >	compositeProperties_

std::vector< EventProperty * >	eventProperties_

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

std::vector< Property * >	properties_

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

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

Member Function Documentation

◆ getIdentifier()

virtual std::string_view inviwo::Settings::getIdentifier ( ) const

overridevirtual

Implements inviwo::PropertyOwner.

◆ getInviwoApplication()

virtual InviwoApplication * inviwo::Settings::getInviwoApplication ( )

overridevirtual

Implements inviwo::PropertyOwner.

◆ insertProperty()

void inviwo::Settings::insertProperty	(	size_t	index,
		Property *	property,
		bool	owner )

overridevirtual

insert property property at position index If index is not valid, the property is appended.

Parameters

index	insertion point for property
property	property to be inserted
owner	PropertyOwner will take ownership of the property if true

Reimplemented from inviwo::PropertyOwner.

◆ load()

void inviwo::Settings::load ( )

Load setting from disk. Each derived class needs to take care of calling this in the constructor

◆ save()

void inviwo::Settings::save ( )

Save is called automatically whenever a property changes.

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

include/inviwo/core/util/settings/settings.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ getIdentifier()

◆ getInviwoApplication()

◆ insertProperty()

◆ load()

◆ save()