ArchiveBase Class Reference

Inheritance diagram for ArchiveBase:

Public Member Functions
bool	HasKey (string key)
	Determines whether a value exists for the specified key. Parameters key The key to check. Returns true if the key exists in the archive; otherwise, false.
ArchiveValueKind	GetValueKind (string key)
	Gets the value kind associated with the specified key. Parameters key The key whose value kind is requested. Returns The kind of value stored under the key.
IReadOnlyList< string >	GetKeys ()
	Gets all keys currently stored in the archive. Returns A read-only list containing all stored keys.
void	SetBool (string key, bool value)
	Stores a boolean value under the specified key. Parameters key The key under which the value is stored. value The boolean value to store. If a value already exists for key , it is overwritten.
bool	GetBool (string key)
	Retrieves a boolean value by key. Parameters key The key of the value to retrieve. Returns The stored boolean value.
void	SetInt64 (string key, long value)
	Stores a 64-bit integer value under the specified key. Parameters key The key under which the value is stored. value The integer value to store. If a value already exists for key , it is overwritten.
long	GetInt64 (string key)
	Retrieves a 64-bit integer value by key. Parameters key The key of the value to retrieve. Returns The stored integer value.
void	SetDouble (string key, double value)
	Stores a double-precision floating-point value under the specified key. Parameters key The key under which the value is stored. value The floating-point value to store.
double	GetDouble (string key)
	Retrieves a double-precision floating-point value by key. Parameters key The key of the value to retrieve. Returns The stored floating-point value.
void	SetString (string key, string value)
	Stores a string value under the specified key. Parameters key The key under which the value is stored. value The string value to store. Must not be null.
string	GetString (string key)
	Retrieves a string value by key. Parameters key The key of the value to retrieve. Returns The stored string value.
void	SetArchive (string key, IArchive value)
	Stores a nested archive under the specified key. Parameters key The key under which the archive is stored. value The archive to store. Must not be null.
IArchive	GetArchive (string key)
	Retrieves a nested archive by key. Parameters key The key of the archive to retrieve. Returns The stored child archive.
int	GetArrayCount (string key)
	Gets the number of elements in an array stored under the specified key. Parameters key The key referencing the array. Returns The number of elements in the array.
void	SetBoolArray (string key, IEnumerable< bool > value)
	Stores an array of boolean values under the specified key. Parameters key The key under which the array is stored. value The boolean values to store. Must not be null.
IReadOnlyList< bool >	GetBoolArray (string key)
	Retrieves an array of boolean values by key. Parameters key The key of the array to retrieve. Returns A read-only list of boolean values.
void	SetInt64Array (string key, IEnumerable< long > value)
	Stores an array of 64-bit integer values under the specified key. Parameters key The key under which the array is stored. value The integer values to store. Must not be null.
IReadOnlyList< long >	GetInt64Array (string key)
	Retrieves an array of 64-bit integer values by key. Parameters key The key of the array to retrieve. Returns A read-only list of integer values.
void	SetDoubleArray (string key, IEnumerable< double > value)
	Stores an array of double-precision floating-point values under the specified key. Parameters key The key under which the array is stored. value The floating-point values to store. Must not be null.
IReadOnlyList< double >	GetDoubleArray (string key)
	Retrieves an array of double-precision floating-point values by key. Parameters key The key of the array to retrieve. Returns A read-only list of floating-point values.
void	SetStringArray (string key, IEnumerable< string > value)
	Stores an array of string values under the specified key. Parameters key The key under which the array is stored. value The string values to store. Must not be null.
IReadOnlyList< string >	GetStringArray (string key)
	Retrieves an array of string values by key. Parameters key The key of the array to retrieve. Returns A read-only list of string values.
void	SetArchiveArray (string key, IEnumerable< IArchive > value)
	Stores an array of nested archives under the specified key. Parameters key The key under which the array is stored. value The archives to store. Must not be null.
IReadOnlyList< IArchive >	GetArchiveArray (string key)
	Retrieves an array of nested archives by key. Parameters key The key of the array to retrieve. Returns A read-only list of child archives.
IArchive	CreateArchive ()
	Creates a new, empty archive instance of the same concrete type.The returned archive is empty and not automatically stored in the current archive.

Detailed Description

Base class for IArchive implementations.

This class does not currently provide shared behavior. It exists to allow future extension and to provide a common inheritance root.

Since

IDSImaging.Peak.Common 1.3

Definition at line 17 of file ArchiveBase.cs.

Member Function Documentation

CreateArchive()

IArchive CreateArchive ( )

abstract

Creates a new, empty archive instance of the same concrete type.The returned archive is empty and not automatically stored in the current archive.

Implements IArchive.

GetArchive()

IArchive GetArchive ( string key )

abstract

Retrieves a nested archive by key.

Parameters

key	The key of the archive to retrieve.

Returns

The stored child archive.

Implements IArchive.

GetArchiveArray()

IReadOnlyList< IArchive > GetArchiveArray ( string key )

abstract

Retrieves an array of nested archives by key.

Parameters

key	The key of the array to retrieve.

Returns

A read-only list of child archives.

Implements IArchive.

GetArrayCount()

int GetArrayCount ( string key )

abstract

Gets the number of elements in an array stored under the specified key.

Parameters

key	The key referencing the array.

Returns

The number of elements in the array.

Implements IArchive.

GetBool()

bool GetBool ( string key )

abstract

Retrieves a boolean value by key.

Parameters

key	The key of the value to retrieve.

Returns

The stored boolean value.

Implements IArchive.

GetBoolArray()

IReadOnlyList< bool > GetBoolArray ( string key )

abstract

Retrieves an array of boolean values by key.

Parameters

key	The key of the array to retrieve.

Returns

A read-only list of boolean values.

Implements IArchive.

GetDouble()

double GetDouble ( string key )

abstract

Retrieves a double-precision floating-point value by key.

Parameters

key	The key of the value to retrieve.

Returns

The stored floating-point value.

Implements IArchive.

GetDoubleArray()

IReadOnlyList< double > GetDoubleArray ( string key )

abstract

Retrieves an array of double-precision floating-point values by key.

Parameters

key	The key of the array to retrieve.

Returns

A read-only list of floating-point values.

Implements IArchive.

GetInt64()

long GetInt64 ( string key )

abstract

Retrieves a 64-bit integer value by key.

Parameters

key	The key of the value to retrieve.

Returns

The stored integer value.

Implements IArchive.

GetInt64Array()

IReadOnlyList< long > GetInt64Array ( string key )

abstract

Retrieves an array of 64-bit integer values by key.

Parameters

key	The key of the array to retrieve.

Returns

A read-only list of integer values.

Implements IArchive.

GetKeys()

IReadOnlyList< string > GetKeys ( )

abstract

Gets all keys currently stored in the archive.

Returns

A read-only list containing all stored keys.

Implements IArchive.

GetString()

string GetString ( string key )

abstract

Retrieves a string value by key.

Parameters

key	The key of the value to retrieve.

Returns

The stored string value.

Implements IArchive.

GetStringArray()

IReadOnlyList< string > GetStringArray ( string key )

abstract

Retrieves an array of string values by key.

Parameters

key	The key of the array to retrieve.

Returns

A read-only list of string values.

Implements IArchive.

GetValueKind()

ArchiveValueKind GetValueKind ( string key )

abstract

Gets the value kind associated with the specified key.

Parameters

key	The key whose value kind is requested.

Returns

The kind of value stored under the key.

Implements IArchive.

HasKey()

bool HasKey ( string key )

abstract

Determines whether a value exists for the specified key.

Parameters

key	The key to check.

Returns

true if the key exists in the archive; otherwise, false.

Implements IArchive.

SetArchive()

void SetArchive ( string key, IArchive value )

abstract

Stores a nested archive under the specified key.

Parameters

key	The key under which the archive is stored.
value	The archive to store. Must not be null.

Implements IArchive.

SetArchiveArray()

void SetArchiveArray ( string key, IEnumerable< IArchive > value )

abstract

Stores an array of nested archives under the specified key.

Parameters

key	The key under which the array is stored.
value	The archives to store. Must not be null.

Implements IArchive.

SetBool()

void SetBool ( string key, bool value )

abstract

Stores a boolean value under the specified key.

Parameters

key	The key under which the value is stored.
value	The boolean value to store.

If a value already exists for key , it is overwritten.

Implements IArchive.

SetBoolArray()

void SetBoolArray ( string key, IEnumerable< bool > value )

abstract

Stores an array of boolean values under the specified key.

Parameters

key	The key under which the array is stored.
value	The boolean values to store. Must not be null.

Implements IArchive.

SetDouble()

void SetDouble ( string key, double value )

abstract

Stores a double-precision floating-point value under the specified key.

Parameters

key	The key under which the value is stored.
value	The floating-point value to store.

Implements IArchive.

SetDoubleArray()

void SetDoubleArray ( string key, IEnumerable< double > value )

abstract

Stores an array of double-precision floating-point values under the specified key.

Parameters

key	The key under which the array is stored.
value	The floating-point values to store. Must not be null.

Implements IArchive.

SetInt64()

void SetInt64 ( string key, long value )

abstract

Stores a 64-bit integer value under the specified key.

Parameters

key	The key under which the value is stored.
value	The integer value to store.

If a value already exists for key , it is overwritten.

Implements IArchive.

SetInt64Array()

void SetInt64Array ( string key, IEnumerable< long > value )

abstract

Stores an array of 64-bit integer values under the specified key.

Parameters

key	The key under which the array is stored.
value	The integer values to store. Must not be null.

Implements IArchive.

SetString()

void SetString ( string key, string value )

abstract

Stores a string value under the specified key.

Parameters

key	The key under which the value is stored.
value	The string value to store. Must not be null.

Implements IArchive.

SetStringArray()

void SetStringArray ( string key, IEnumerable< string > value )

abstract

Stores an array of string values under the specified key.

Parameters

key	The key under which the array is stored.
value	The string values to store. Must not be null.

Implements IArchive.