vtkMRMLIOProperties Class Reference

#include <Libs/MRML/Logic/vtkMRMLIOProperties.h>

Inheritance diagram for vtkMRMLIOProperties:

Collaboration diagram for vtkMRMLIOProperties:

Public Types
typedef vtkObject	Superclass

Public Member Functions
void	Copy (vtkMRMLIOProperties *source)
	Replace these properties with the properties of another set.
bool	GetBoolProperty (const std::string &name, bool defaultValue=false) const
virtual const char *	GetClassName ()
double	GetDoubleProperty (const std::string &name, double defaultValue=0.0) const
int	GetIntProperty (const std::string &name, int defaultValue=0) const
bool	GetListProperty (const std::string &name, vtkVariantArray *values) const
vtkMRMLIOProperties *	GetMapProperty (const std::string &name) const
vtkObject *	GetObjectProperty (const std::string &name) const
	The value of an object property, or nullptr if it is not there or not an object.
vtkVariant	GetProperty (const std::string &name) const
	The value of a property, or an invalid variant if it is not there.
std::vector< std::string >	GetPropertyNames () const
	The names of the properties that are set, in the order they were first set.
std::vector< std::string >	GetStringListProperty (const std::string &name) const
std::string	GetStringProperty (const std::string &name, const std::string &defaultValue="") const
	The value of a property as a string; defaultValue if it is not there.
bool	HasProperty (const std::string &name) const
virtual int	IsA (const char *type)
bool	IsBoolProperty (const std::string &name) const
bool	IsListProperty (const std::string &name) const
bool	IsMapProperty (const std::string &name) const
bool	IsObjectProperty (const std::string &name) const
bool	IsStringListProperty (const std::string &name) const
void	PrintSelf (ostream &os, vtkIndent indent) override
void	RemoveAllProperties ()
void	RemoveProperty (const std::string &name)
void	SetBoolProperty (const std::string &name, bool value)
void	SetDoubleProperty (const std::string &name, double value)
void	SetIntProperty (const std::string &name, int value)
void	SetListProperty (const std::string &name, vtkVariantArray *values)
void	SetMapProperty (const std::string &name, vtkMRMLIOProperties *values)
	Set a property to a nested set of properties (a map). The properties are copied.
void	SetObjectProperty (const std::string &name, vtkObject *value)
	Set a property to an object (such as the "screenShot" image of a scene). The object is referenced.
void	SetProperty (const std::string &name, const vtkVariant &value)
	Set a property. A value that is already there is replaced.
void	SetStringListProperty (const std::string &name, const std::vector< std::string > &values)
	Set a property to a list of strings (such as "fileNames").
void	SetStringProperty (const std::string &name, const std::string &value)
void	Update (vtkMRMLIOProperties *source)
	Add the properties of another set to these, replacing values that are already set.

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLIOProperties *	New ()
static vtkMRMLIOProperties *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkMRMLIOProperties ()
	~vtkMRMLIOProperties () override

Detailed Description

Named values that specify a file reading or writing request, such as "fileName", "name", "nodeID", and the values of reader or writer options. This is the VTK equivalent of qSlicerIO::IOProperties.

See https://slicer.readthedocs.io/en/latest/developer_guide/mrml_overview.html#file-reading-and-writing

Definition at line 36 of file vtkMRMLIOProperties.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkMRMLIOProperties::Superclass

Definition at line 40 of file vtkMRMLIOProperties.h.

Constructor & Destructor Documentation

vtkMRMLIOProperties()

vtkMRMLIOProperties::vtkMRMLIOProperties ( )

protected

~vtkMRMLIOProperties()

vtkMRMLIOProperties::~vtkMRMLIOProperties ( )

overrideprotected

Member Function Documentation

Copy()

void vtkMRMLIOProperties::Copy

(

vtkMRMLIOProperties *

source

)

Replace these properties with the properties of another set.

GetBoolProperty()

bool vtkMRMLIOProperties::GetBoolProperty	(	const std::string &	name,
		bool	defaultValue = false ) const

GetClassName()

virtual const char * vtkMRMLIOProperties::GetClassName ( )

virtual

GetDoubleProperty()

double vtkMRMLIOProperties::GetDoubleProperty	(	const std::string &	name,
		double	defaultValue = 0.0 ) const

GetIntProperty()

int vtkMRMLIOProperties::GetIntProperty	(	const std::string &	name,
		int	defaultValue = 0 ) const

GetListProperty()

bool vtkMRMLIOProperties::GetListProperty	(	const std::string &	name,
		vtkVariantArray *	values ) const

The value of a list property. Values of a list of strings property are returned as well. Returns false if the property is not a list.

GetMapProperty()

vtkMRMLIOProperties * vtkMRMLIOProperties::GetMapProperty

(

const std::string &

name

)

const

The value of a map property, or nullptr if it is not there or not a map. The returned object is owned by these properties.

GetObjectProperty()

vtkObject * vtkMRMLIOProperties::GetObjectProperty

(

const std::string &

name

)

const

The value of an object property, or nullptr if it is not there or not an object.

GetProperty()

vtkVariant vtkMRMLIOProperties::GetProperty

(

const std::string &

name

)

const

The value of a property, or an invalid variant if it is not there.

GetPropertyNames()

std::vector< std::string > vtkMRMLIOProperties::GetPropertyNames

(

)

const

The names of the properties that are set, in the order they were first set.

GetStringListProperty()

std::vector< std::string > vtkMRMLIOProperties::GetStringListProperty

(

const std::string &

name

)

const

The value of a property as a list of strings. A single string value is returned as a list of one item. Returns an empty list if the property is not there.

GetStringProperty()

std::string vtkMRMLIOProperties::GetStringProperty	(	const std::string &	name,
		const std::string &	defaultValue = "" ) const

The value of a property as a string; defaultValue if it is not there.

HasProperty()

bool vtkMRMLIOProperties::HasProperty

(

const std::string &

name

)

const

IsA()

virtual int vtkMRMLIOProperties::IsA ( const char * type )

virtual

IsBoolProperty()

bool vtkMRMLIOProperties::IsBoolProperty

(

const std::string &

name

)

const

Whether the property was set as a boolean (SetBoolProperty), a list of strings (SetStringListProperty), a list of values (SetListProperty), a map (SetMapProperty), or an object (SetObjectProperty). This allows converting the properties to other representations (such as a Python dictionary) without losing the type.

IsListProperty()

bool vtkMRMLIOProperties::IsListProperty

(

const std::string &

name

)

const

IsMapProperty()

bool vtkMRMLIOProperties::IsMapProperty

(

const std::string &

name

)

const

IsObjectProperty()

bool vtkMRMLIOProperties::IsObjectProperty

(

const std::string &

name

)

const

IsStringListProperty()

bool vtkMRMLIOProperties::IsStringListProperty

(

const std::string &

name

)

const

IsTypeOf()

static int vtkMRMLIOProperties::IsTypeOf ( const char * type )

static

New()

static vtkMRMLIOProperties * vtkMRMLIOProperties::New ( )

static

PrintSelf()

void vtkMRMLIOProperties::PrintSelf ( ostream & os, vtkIndent indent )

override

RemoveAllProperties()

void vtkMRMLIOProperties::RemoveAllProperties

(

)

RemoveProperty()

void vtkMRMLIOProperties::RemoveProperty

(

const std::string &

name

)

SafeDownCast()

static vtkMRMLIOProperties * vtkMRMLIOProperties::SafeDownCast ( vtkObject * o )

static

SetBoolProperty()

void vtkMRMLIOProperties::SetBoolProperty	(	const std::string &	name,
		bool	value )

SetDoubleProperty()

void vtkMRMLIOProperties::SetDoubleProperty	(	const std::string &	name,
		double	value )

SetIntProperty()

void vtkMRMLIOProperties::SetIntProperty	(	const std::string &	name,
		int	value )

SetListProperty()

void vtkMRMLIOProperties::SetListProperty	(	const std::string &	name,
		vtkVariantArray *	values )

Set a property to a list of values (strings, numbers, and booleans). The values are copied. Boolean values are stored as vtkVariant of char type (see vtkVariant(bool)).

SetMapProperty()

void vtkMRMLIOProperties::SetMapProperty	(	const std::string &	name,
		vtkMRMLIOProperties *	values )

Set a property to a nested set of properties (a map). The properties are copied.

SetObjectProperty()

void vtkMRMLIOProperties::SetObjectProperty	(	const std::string &	name,
		vtkObject *	value )

Set a property to an object (such as the "screenShot" image of a scene). The object is referenced.

SetProperty()

void vtkMRMLIOProperties::SetProperty	(	const std::string &	name,
		const vtkVariant &	value )

Set a property. A value that is already there is replaced.

SetStringListProperty()

void vtkMRMLIOProperties::SetStringListProperty	(	const std::string &	name,
		const std::vector< std::string > &	values )

Set a property to a list of strings (such as "fileNames").

SetStringProperty()

void vtkMRMLIOProperties::SetStringProperty	(	const std::string &	name,
		const std::string &	value )

Update()

void vtkMRMLIOProperties::Update

(

vtkMRMLIOProperties *

source

)

Add the properties of another set to these, replacing values that are already set.

---

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

• Libs/MRML/Logic/vtkMRMLIOProperties.h