Click or drag to resize

IntendedSignalByDataType Class

An IntendedSignalStrategy which identifies intended signals using the presence of a specified type of data.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Communications.SignalProcessing
Assembly:  AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax
public class IntendedSignalByDataType : IntendedSignalStrategy

The IntendedSignalByDataType type exposes the following members.

Constructors
  NameDescription
Public methodIntendedSignalByDataType
Initializes a new instance.
Public methodIntendedSignalByDataType(Type)
Initializes a new instance with the specified signal data type.
Protected methodIntendedSignalByDataType(IntendedSignalByDataType, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertySignalDataType
Gets or sets the signal data type used to identify the desired signals.
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from IntendedSignalStrategy.)
Protected methodCheckForSameDefinition(IntendedSignalByDataType)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Protected methodCheckForSameDefinition(IntendedSignalStrategy)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides IntendedSignalStrategyCheckForSameDefinition(IntendedSignalStrategy).)
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CheckForSameDefinition(DefinitionalObject) method.
(Overrides IntendedSignalStrategyComputeCurrentDefinitionHashCode.)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.
(Inherited from DefinitionalObject.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
(Inherited from DefinitionalObject.)
Public methodGetAllIntendedSignalsEvaluator
Get an evaluator which produces a signal collection SignalCollection from the given ISignalSource by looking for identifying object.
(Overrides IntendedSignalStrategyGetAllIntendedSignalsEvaluator(EvaluatorGroup, SignalPropagationGraph, ISignalSource).)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetIntendedSignalEvaluator
Get an evaluator which produces a single Signal as the intended signal from the given ISignalSource.
(Inherited from IntendedSignalStrategy.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUnintendedSignalEvaluator
Get an evaluator which produces a collection of Signals from the given ISignalSource by determining the intended signal and removing it from the collection.
(Inherited from IntendedSignalStrategy.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
This strategy is useful for identifying signals by the type of data they carry. To use this strategy, define a type of data the signal will carry. Add an instance of this type to the signal using one of the appropriate constructors, or the AddData(Object) method on the Signal. You can also add data to a signal through the constructors and methods on ComplexDigitalTransmitter or DigitalDataSource.
See Also