IOFormat.GeneralOptions Class Reference

Inheritance diagram for IOFormat.GeneralOptions:

Public Member Functions
	GeneralOptions (global::System.IntPtr cPtr, bool cMemoryOwn)
long[]	GetIntArray (string key)
	Return an option value as an array of integers.
double[]	GetFloatArray (string key)
	Return an option value as an array of floats.
void	SetInt (string key, long[] values)
	Associate an integer array with a specific key.
void	SetFloat (string key, double[] values)
	Associate a float array with a specific key.
	GeneralOptions (GeneralOptions other)
new bool	Has (string key)
	std::string&) const
new DataType	Dtype (string key)
	std::string&) const
new uint	Count (string key)
	std::string&) const
new void	Remove (string key)
	std::string&)
new bool	GetBool (string key)
	std::string&) const
new string	GetString (string key)
	std::string&) const
new long	GetInt (string key, uint index)
	std::string&, size_t) const
new long	GetInt (string key)
	std::string&) const
new double	GetFloat (string key, uint index)
	std::string&, size_t) const
new double	GetFloat (string key)
	std::string&) const
new void	SetBool (string key, bool value)
	std::string&, bool)
new void	SetString (string key, string value)
	std::string&, const std::string&)
new void	SetInt (string key, long value)
	std::string&, int64_t)
new void	SetFloat (string key, double value)
	std::string&, double)
OptionMap	Select (string plugin, string format)
	Select a subset of options.
Public Member Functions inherited from IOFormat.OptionMap
	OptionMap (global::System.IntPtr cPtr, bool cMemoryOwn)
void	Dispose ()
long[]	GetIntArray (string key)
	Return an option value as an array of integers.
double[]	GetFloatArray (string key)
	Return an option value as an array of floats.
void	SetInt (string key, long[] values)
	Associate an integer array with a specific key.
void	SetFloat (string key, double[] values)
	Associate a float array with a specific key.
	OptionMap (OptionMap other)
uint	Size ()
	Get the number of element in the option map.
bool	Empty ()
	Check if the option map is empty.
bool	Has (string key)
	Check if a key is present.
DataType	Dtype (string key)
	Get the option data type.
uint	Count (string key)
	Get the number of values associated with a key.
void	Remove (string key)
	Remove a key from the option map.
string	ToString ()
	Get a string representation of the option map.
bool	GetBool (string key)
	Get a boolean value.
string	GetString (string key)
	Get a string value.
long	GetInt (string key, uint index)
	Get the integer value at a given index.
long	GetInt (string key)
	Get an integer value.
double	GetFloat (string key, uint index)
	Get the float value at the given index.
double	GetFloat (string key)
	Get a float value.
void	SetBool (string key, bool value)
	Associate a boolean value with a specific key.
void	SetString (string key, string value)
	Associate a string value with a specific key.
void	SetInt (string key, long value)
	Associate an integer value with a specific key.
void	SetFloat (string key, double value)
	Associate a float value with a specific key.

Static Public Member Functions
static global::System.Runtime.InteropServices.HandleRef	getCPtr (GeneralOptions obj)
static global::System.Runtime.InteropServices.HandleRef	swigRelease (GeneralOptions obj)
Static Public Member Functions inherited from IOFormat.OptionMap
static global::System.Runtime.InteropServices.HandleRef	getCPtr (OptionMap obj)
static global::System.Runtime.InteropServices.HandleRef	swigRelease (OptionMap obj)

Protected Member Functions
override void	Dispose (bool disposing)

Additional Inherited Members
Protected Attributes inherited from IOFormat.OptionMap
bool	swigCMemOwn

Member Function Documentation

Dispose()

override void IOFormat.GeneralOptions.Dispose ( bool  disposing )

inlineprotectedvirtual

Reimplemented from IOFormat.OptionMap.

GetFloatArray()

double[] IOFormat.GeneralOptions.GetFloatArray ( string  key )

inline

Return an option value as an array of floats.

Parameters

key	The key to fetch.

GetIntArray()

long[] IOFormat.GeneralOptions.GetIntArray ( string  key )

inline

Return an option value as an array of integers.

Parameters

key	The key to fetch.

Select()

OptionMap IOFormat.GeneralOptions.Select ( string  plugin, string  format  )

inline

Select a subset of options.

This method will return a new OptionMap containing only the options that match the given plugin and format/protocol. You can use the special values "all" and "ANY" to match any plugin or format/protocol. If two selected options have the same third segment, the one that is more specific will be kept. Option keys get a point of priority for each segment that match the requested one (excluding the special values). For example, if you select "all:TIFF", the option "all:ANY:compression" will be less specific than "all:TIFF:compression", and the TIFF one will be selected.

Parameters

plugin	The plugin to filter on.
format	The format or protocol to filter on.

Returns

Filtered options as an OptionMap.

SetFloat()

void IOFormat.GeneralOptions.SetFloat ( string  key, double[]  values  )

inline

Associate a float array with a specific key.

Parameters

key	The key to set.
values	The values to set.

SetInt()

void IOFormat.GeneralOptions.SetInt ( string  key, long[]  values  )

inline

Associate an integer array with a specific key.

Parameters

key	The key to set.
values	The values to set.

---

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

• Release/net/generated/GeneralOptions.cs