inviwo::Settings Class Reference

Inheritance diagram for inviwo::Settings:

Public Member Functions
	Settings (const std::string &id, InviwoApplication *app)
	Settings (const std::string &id="")
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 ()
virtual const std::string &	getIdentifier () const override
virtual InviwoApplication *	getInviwoApplication () override
Public Member Functions inherited from inviwo::PropertyOwner
PropertyOwner &	operator= (const PropertyOwner &that)=delete
virtual	~PropertyOwner ()
	Removes all properties and notifies its observers of the removal.
void	addProperty (Property *property, bool owner=true)
void	addProperty (Property &property)
Property *	addProperty (std::unique_ptr< Property > property)
template<typename... Ts>
void	addProperties (Ts &... properties)
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.
Property *	removeProperty (std::string_view identifier)
Property *	removeProperty (Property *property)
Property *	removeProperty (Property &property)
Property *	removeProperty (size_t index)
	remove property referred to by index
virtual Property *	removeProperty (iterator it)
virtual bool	move (Property *property, size_t newIndex)
virtual void	clear ()
	Remove all properties; Owned properties will be deleted.
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
virtual void	setValid ()
InvalidationLevel	getInvalidationLevel () const
virtual void	invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty)
virtual Processor *	getProcessor ()
virtual const Processor *	getProcessor () const
virtual const PropertyOwner *	getOwner () const
virtual PropertyOwner *	getOwner ()
virtual void	serialize (Serializer &s) const override
virtual void	deserialize (Deserializer &d) override
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< PropertyOwnerObserver > &	operator= (const Observable< PropertyOwnerObserver > &other)
void	addObserver (PropertyOwnerObserver *observer)
void	removeObserver (PropertyOwnerObserver *observer)
bool	isObservedBy (PropertyOwnerObserver *observer) const
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
	PropertyOwner (const PropertyOwner &rhs)
	PropertyOwner (PropertyOwner &&rhs)
PropertyOwner &	operator= (PropertyOwner &&that)
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::ObservableInterface
virtual void	addObserver (Observer *observer)=0
virtual void	removeObserver (Observer *observer)=0
void	addObservationHelper (Observer *observer)
void	removeObservationHelper (Observer *observer)

Protected Attributes
std::string	identifier_
bool	isDeserializing_
InviwoApplication *	app_
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_

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

Member Function Documentation

getIdentifier()

virtual const std::string & inviwo::Settings::getIdentifier ( ) const

overridevirtual

Reimplemented from 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:

• settings.h