Click or drag to resize

CommunicationSystem Class

Models a communications system involving multiple transmitters, receivers, transponders, and transceivers. The system can report a LinkBudget for any of the links, and can produce a SignalPropagationGraph for more detailed analysis.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Communications
Assembly:  AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 19.2.399.0 (19.2.399.0)
Syntax
public class CommunicationSystem : DefinitionalObject

The CommunicationSystem type exposes the following members.

Constructors
  NameDescription
Public methodCommunicationSystem
Initializes a new instance.
Protected methodCommunicationSystem(CommunicationSystem, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
Public propertyDefaultReferenceVector
Gets or sets the default reference vector used by ConfigureAntennaTargeting when automatically orienting links. It is passed as the reference vector to AxesTargetingLink. The default value is the Earth's inertial Z-Axis.
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 propertyLinks
Gets the links defined in this system.
Public propertyReceiveFromAll
Gets the collection of receiving service providers that will receive signals from all other transmitters in the system.
Public propertyTransmitToAll
Gets the collection of transmitting service providers that will broadcast to all receivers in the system.
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(CommunicationSystem)
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(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).
(Overrides DefinitionalObjectCheckForSameDefinition(DefinitionalObject).)
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 DefinitionalObjectComputeCurrentDefinitionHashCode.)
Public methodConfigureAntennaTargeting
Attempts to configure the OrientationAxes of each transmitter and receiver in the Links collection. If the OrientationAxes property is already defined on a given antenna, it will be overwritten. If an optimal orientation cannot be determined for a given antenna, the orientation is left unchanged.
Public methodCreatePropagationGraph
Creates a SignalPropagationGraph based on the links in the system.
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.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
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 methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetDetailedLinkBudgetEvaluator(IServiceProvider, IntendedSignalStrategy)
Gets an evaluator for link budget data for the given link and intended signal strategy. This evaluator includes propagation loss broken into its constituent models.
Public methodGetDetailedLinkBudgetEvaluator(IServiceProvider, IntendedSignalStrategy, EvaluatorGroup)
Gets an evaluator for link budget data for the given link and intended signal strategy. This evaluator includes propagation loss broken into its constituent models.
Public methodStatic memberGetDetailedLinkBudgetEvaluator(IServiceProvider, SignalPropagationGraph, IntendedSignalStrategy)
Gets an evaluator for link budget data for a given link, graph, and intended signal strategy. This evaluator includes propagation loss broken into its constituent models.
Public methodStatic memberGetDetailedLinkBudgetEvaluator(IServiceProvider, SignalPropagationGraph, IntendedSignalStrategy, EvaluatorGroup)
Gets an evaluator for link budget data for a given link, graph, and intended signal strategy. This evaluator includes propagation loss broken into its constituent models.
Public methodGetDetailedLinkBudgetScalars(IServiceProvider, IntendedSignalStrategy)
Creates a set of LinkBudgetScalars for a given link and intended signal strategy. These scalars include propagation loss broken into its constituent models.
Public methodStatic memberGetDetailedLinkBudgetScalars(IServiceProvider, SignalPropagationGraph, IntendedSignalStrategy)
Creates a set of LinkBudgetScalars for a given link, graph, and intended signal strategy. These scalars include propagation loss broken into its constituent models.
Public methodStatic memberGetDetailedLinkBudgetScalars(IServiceProvider, SignalPropagationGraph, IntendedSignalStrategy, String)
Creates a set of LinkBudgetScalars for a given link, graph, and intended signal strategy. These scalars include propagation loss broken into its constituent models.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLinkBudgetEvaluator(IServiceProvider, IntendedSignalStrategy)
Gets an evaluator for link budget data for the given link and intended signal strategy.
Public methodGetLinkBudgetEvaluator(IServiceProvider, IntendedSignalStrategy, EvaluatorGroup)
Gets an evaluator for link budget data for the given link, using the specified IntendedSignalStrategy, in a given EvaluatorGroup.
Public methodStatic memberGetLinkBudgetEvaluator(IServiceProvider, SignalPropagationGraph, IntendedSignalStrategy)
Gets an evaluator for link budget data for a given link, graph, and intended signal strategy.
Public methodStatic memberGetLinkBudgetEvaluator(IServiceProvider, SignalPropagationGraph, IntendedSignalStrategy, EvaluatorGroup)
Gets an evaluator for link budget data for a given link, graph, and intended signal strategy.
Public methodGetLinkBudgetScalars(IServiceProvider, IntendedSignalStrategy)
Creates a set of LinkBudgetScalars for a given link and intended signal strategy.
Public methodStatic memberGetLinkBudgetScalars(IServiceProvider, SignalPropagationGraph, IntendedSignalStrategy)
Creates a set of LinkBudgetScalars for a given link, graph, and intended signal strategy.
Public methodStatic memberGetLinkBudgetScalars(IServiceProvider, SignalPropagationGraph, IntendedSignalStrategy, String)
Creates a set of LinkBudgetScalars for a given link, graph, and intended signal strategy.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
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
See Also