CogSerializableDictionaryBase(TKey, TValue) Class

CogSerializableDictionaryBase TKey, TValue Class

Cognex VisionPro 9.7

Base class for a generic non-ordered collection of key-and-value pairs that raises events whenever any change is made.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.Implementation CogSerializableDictionaryBase TKey, TValue

Namespace: Cognex.VisionPro.Implementation
Assembly: Cognex.VisionPro (in Cognex.VisionPro.dll) Version: 73.0.0.0 (73.0.0.0)

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogSerializableDictionaryBase<TKey, TValue> : CogSerializableChangedEventBase, 
	IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, 
	IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable, ICogDictionaryEvents, 
	IDeserializationCallback

[SerializableAttribute]
public class CogSerializableDictionaryBase<TKey, TValue> : CogSerializableChangedEventBase, 
	IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, 
	IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable, ICogDictionaryEvents, 
	IDeserializationCallback

<SerializableAttribute>
Public Class CogSerializableDictionaryBase(Of TKey, TValue)
	Inherits CogSerializableChangedEventBase 
	Implements IDictionary(Of TKey, TValue), ICollection(Of KeyValuePair(Of TKey, TValue)), 
	IEnumerable(Of KeyValuePair(Of TKey, TValue)), IEnumerable, 
	ICogDictionaryEvents, IDeserializationCallback

<SerializableAttribute>
Public Class CogSerializableDictionaryBase(Of TKey, TValue)
	Inherits CogSerializableChangedEventBase 
	Implements IDictionary(Of TKey, TValue), ICollection(Of KeyValuePair(Of TKey, TValue)), 
	IEnumerable(Of KeyValuePair(Of TKey, TValue)), IEnumerable, 
	ICogDictionaryEvents, IDeserializationCallback

[SerializableAttribute]
generic<typename TKey, typename TValue>
public ref class CogSerializableDictionaryBase : public CogSerializableChangedEventBase, 
	IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, 
	IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable, ICogDictionaryEvents, 
	IDeserializationCallback

[SerializableAttribute]
generic<typename TKey, typename TValue>
public ref class CogSerializableDictionaryBase : public CogSerializableChangedEventBase, 
	IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, 
	IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable, ICogDictionaryEvents, 
	IDeserializationCallback

Type Parameters

TKey
TValue

The CogSerializableDictionaryBase TKey, TValue type exposes the following members.

Constructors

	Name	Description
	CogSerializableDictionaryBase TKey, TValue	Constructs a new instance of the CogSerializableDictionaryBase class.
	CogSerializableDictionaryBase TKey, TValue (CogSerializableDictionaryBase TKey, TValue )	Constructs a copy of the supplied CogSerializableDictionaryBase. If the values are ref types that implement ICloneable, this will be a deep copy.
	CogSerializableDictionaryBase TKey, TValue (SerializationInfo, StreamingContext)	CogSerializableDictionaryBase serialization constructor.

Top

Methods

	Name	Description
	Add(KeyValuePair TKey, TValue )	Add the supplied entry to this dictionary.
	Add(TKey, TValue)	Add an entry to this dictionary with the supplied key and value.
	Clear	Remove all entries from this dictionary.
	Contains	Returns true if the key of the supplied item is found in this dictionary, otherwise returns false.
	ContainsKey	Returns true if the specified key is found in this dictionary, otherwise returns false.
	ContainsValue	Returns true if the specified value is found in this dictionary, otherwise returns false.
	CopyTo(Array, Int32)	Copy the key value pairs in this dictionary to the supplied array, starting to write at the supplied array index.
	CopyTo( KeyValuePair TKey, TValue , Int32)	Copy the key value pairs in this dictionary to the supplied array of key value pairs, starting to write at the supplied array index.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetAttributes	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetClassName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetComponentName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetConverter	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultEvent	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultProperty	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEditor	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEnumerator	Get the specialized enumerator for this dictionary.
	GetEvents	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetObjectData	Implements the GetObjectData method of the ISerializable interface. (Inherited from CogSerializableObjectBase.)
	GetProperties	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetProperties( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetPropertyOwner	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	OnChanged(Int64)	This method should be called internally whenever the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)
	OnChanged(CogChangedEventArgs)	This method may be called internally whenever a derived object's state may have changed and the derived object expresses this change via a derived CogChangedEventArgs class. (Inherited from CogSerializableChangedEventBase.)
	OnCleared	Raises the Cleared event.
	OnClearing	Raises the Clearing event.
	OnDeserialization	Runs when the entire object graph has been deserialized.
	OnInsertedItem	Raises the Inserted event.
	OnInsertingItem	Raises the Inserting event.
	OnRemovedItem	Raises the Removed event.
	OnRemovingItem	Raises the Removing event.
	OnReplacedItem	Raises the Replaced event.
	OnReplacingItem	Raises the Replacing event.
	Remove(KeyValuePair TKey, TValue )	Remove the specified entry from this dictionary. Returns true if the specified entry is successfully removed.
	Remove(TKey)	Remove the specified entry from this dictionary. Returns true if the specified entry is successfully removed.
	ResumeAndRaiseChangedEvent	Re-enables raising of the Changed event after SuspendChangedEvent has been called, and raises the Changed event if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent. (Inherited from CogSerializableChangedEventBase.)
	SuspendChangedEvent	Temporarily suspends the raising of the Changed event. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent. (Inherited from CogSerializableChangedEventBase.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)
	TryGetValue	If this dictionary contains the specified key, output the associated value. Return true if the key was found, otherwise return false.

Top

Fields

	Name	Description
	SfCount	State flag for the Count property.
	SfItem	State flag for the Item (indexer) property.
	SfNextSf	Next state flag to be used in derived classes.

Top

Properties

	Name	Description
	ChangedEventSuspended	If nonzero, indicates that the raising of the Changed event has been suspended. This value is incremented when SuspendChangedEvent is called and decremented when ResumeAndRaiseChangedEvent is called. (Inherited from CogSerializableChangedEventBase.)
	Count	Gets the number of key value pairs in this dictionary.
	Dictionary	Gets the generic IDictionary interface of this object.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	InnerDictionary	Gets the internal Dictionary containing the set of key value pairs.
	IsReadOnly	Get whether or not this dictionary is read only.
	Item	The indexer for this dictionary.
	Keys	Gets a collection of the keys in this dictionary.
	StateFlags	Returns the complete set of state flags supported on this object. The flags may be indexed by name as shown in the following C# code snippet: if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... } (Inherited from CogSerializableChangedEventBase.)
	Values	Gets a collection of the values in this dictionary.

Top

Events

	Name	Description
	Changed	This event is raised when one or more parts of the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)
	Cleared	Raised after the dictionary is cleared.
	Clearing	Raised before the dictionary is cleared.
	InsertedItem	Raised after an item is inserted.
	InsertingItem	Raised before an item is inserted.
	RemovedItem	Raised after an item is removed.
	RemovingItem	Raised before an item is removed.
	ReplacedItem	Raised before an item is replaced.
	ReplacingItem	Raised after an item is replaced.

Top

Remarks

This is largely a generic version of CogSerializableDictionaryBase which allows the user to specify the type of the key and the type of the associated value contained in the dictionary.