NodeMapDictionary Class Reference

Device dictionary holding all node maps. More...

Inherits ReadOnlyDictionaryBase< TKey, TValue >.

Inherited by , and DeviceNodeMapDictionary.

Public Member Functions
void	Dispose ()
	Dispose of all node maps immediately.
override bool	TryGetValue (string name, out NodeMap value)
	Tries to get the node map with the given name .
Public Member Functions inherited from ReadOnlyDictionaryBase< TKey, TValue >
virtual bool	ContainsKey (TKey key)
	Determines whether the key is in this collection.
virtual bool	TryGetValue (TKey key, out TValue value)
	Retrieves the value that is associated with the specific key .

Static Public Member Functions
static NodeMapDictionary	FromImage (MultiPartImage image)
	Creates a new NodeMapDictionary from a given MultiPartImage.
static NodeMapDictionary	FromPointCloud (PointCloud pointCloud)
	Creates a new NodeMapDictionary from a given PointCloud.
static NodeMapDictionary	FromComposite (Composite composite)
	Creates a new NodeMapDictionary from a given Composite.

Protected Member Functions
virtual void	Dispose (bool disposing)
	Disposable implementation.
override bool	Contains (KeyValuePair< string, NodeMap > item)
	Gets whether the given pair item is contained in this node map dictionary.
override void	CopyTo (KeyValuePair< string, NodeMap >[] array, int arrayIndex)
	Copies the elements of this dictionary into the given array starting at index arrayIndex .
override IEnumerator< KeyValuePair< string, NodeMap > >	GetEnumerator ()
	Gets the enumerator for the KeyValuePair<TKey, TValue>s.
Protected Member Functions inherited from ReadOnlyDictionaryBase< TKey, TValue >
	ReadOnlyDictionaryBase (IDictionary< TKey, TValue > dictionary)
	Creates a new ReadOnlyDictionary wrapping the given dictionary .
virtual bool	Contains (KeyValuePair< TKey, TValue > item)
	Determines whether the item is in this collection.
virtual void	CopyTo (KeyValuePair< TKey, TValue >[] array, int arrayIndex)
	Copies the entire collection to a compatible one-dimensional array , starting at the specified arrayIndex .

Protected Attributes
IntPtr	ParentHandle
	Native handle of the parent object holding the node maps.

Properties
virtual bool	IsDisposed [get]
	Gets whether this object has been disposed.
override NodeMap	this[string name] [get]
	Indexer to retrieve a node map with the given name .
override ICollection< NodeMap >	Values [get]
	Gets the value-collection containing all available nodes maps.
Properties inherited from ReadOnlyDictionaryBase< TKey, TValue >
IDictionary< TKey, TValue >	Dictionary [get]
	Gets the wrapped dictionary.
virtual TValue	this[TKey key] [get]
	Gets the element that has the specified key .
int	Count [get]
	Gets the number of items in the dictionary.
virtual ICollection< TKey >	Keys [get]
	Gets a read-only collection of all keys in this dictionary.
virtual ICollection< TValue >	Values [get]
	Gets a read-only collection of all values in this dictionary.

Detailed Description

Device dictionary holding all node maps.

Member Function Documentation

Contains()

override bool Contains ( KeyValuePair< string, NodeMap > item )

protected

Gets whether the given pair item is contained in this node map dictionary.

Parameters

item	Element to be checked.

Returns

true if the key/value pair exists; false otherwise.

CopyTo()

override void CopyTo ( KeyValuePair< string, NodeMap >[] array, int arrayIndex )

protected

Copies the elements of this dictionary into the given array starting at index arrayIndex .

Parameters

array	Array to copy elements into.
arrayIndex	Start index to copy to.

Dispose()

virtual void Dispose ( bool disposing )

protectedvirtual

Disposable implementation.

Parameters

disposing

true if called from IDisposable.Dispose; false if called from finalizer.

FromComposite()

static NodeMapDictionary FromComposite ( Composite composite )

static

Creates a new NodeMapDictionary from a given Composite.

Parameters

composite

Composite object.

Returns

FromImage()

static NodeMapDictionary FromImage ( MultiPartImage image )

static

Creates a new NodeMapDictionary from a given MultiPartImage.

Parameters

image

Returns

FromPointCloud()

static NodeMapDictionary FromPointCloud ( PointCloud pointCloud )

static

Creates a new NodeMapDictionary from a given PointCloud.

Parameters

pointCloud

Point cloud object.

Returns

GetEnumerator()

override IEnumerator< KeyValuePair< string, NodeMap > > GetEnumerator ( )

protectedvirtual

Gets the enumerator for the KeyValuePair<TKey, TValue>s.

Returns

Typed enumerator.

Reimplemented from ReadOnlyDictionaryBase< TKey, TValue >.

TryGetValue()

override bool TryGetValue	(	string	name,
		out NodeMap	value )

Tries to get the node map with the given name .

Parameters

name	Name of the node map.
value	Will contain the NodeMap object if present.

Returns

true if name is contained in this dictionary; false otherwise.

Property Documentation

this[string name]

override NodeMap this[string name]

get

Indexer to retrieve a node map with the given name .

Parameters

name	Name of the node map.

Returns

NodeMap with the given name .

Exceptions

ArgumentNullException	Thrown if name is null.
KeyNotFoundException	Thrown if name does not exist in this collection.