Click or drag to resize

CommunicationLinkCollection Class

A collection of communication links, primarily used by the CommunicationSystem. While transceivers, transponders and links are not technically transmitter or receivers themselves; they can be passed directly to any of the methods in this class and it will retrieve the necessary link end for the desired roll.
Inheritance Hierarchy
SystemObject
  System.Collections.ObjectModelCollectionExtensibleObject
    AGI.Foundation.InfrastructureDefinitionalObjectCollectionExtensibleObject
      AGI.Foundation.InfrastructureExtensibleObjectCollection
        AGI.Foundation.CommunicationsCommunicationLinkCollection

Namespace:  AGI.Foundation.Communications
Assembly:  AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax
public class CommunicationLinkCollection : ExtensibleObjectCollection

The CommunicationLinkCollection type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyCount (Inherited from CollectionExtensibleObject.)
Public propertyDefaultAccessConstraints
Gets the default access constraints list. The DefaultAccessConstraints collection contains a CentralBodyObstructionConstraint, using the Earth as a central body by default. The CentralBodyObstruction constraint causes the wireless link to be unavailable when the signal's path intersects the Earth's ellipsoid.
Public propertyDefaultInertialFrame
Gets or sets the default inertial frame in which the light path is modeled for new LinkSpeedOfLight instances created by the collection.
Public propertyDefaultPropagationModels
Gets the default propagation models list.
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 DefinitionalObjectCollectionT.)
Public propertyItem
Gets or sets the element at the specified index.
(Inherited from CollectionExtensibleObject.)
Protected propertyItems (Inherited from CollectionExtensibleObject.)
Top
Methods
  NameDescription
Public methodAdd(T) (Inherited from CollectionExtensibleObject.)
Public methodAdd(IServiceProvider, IServiceProvider)
Creates a new link from the provided transmitter and receiver and adds it to the collection. If a link in the collection already exists for the specified transmitter and receiver pair, no new link is created and the existing link is returned instead.
Public methodAdd(IServiceProvider, IServiceProvider, AtmosphericRefractionModel)
Creates a new link from the provided transmitter and receiver and adds it to the collection. If a link in the collection already exists for the specified transmitter and receiver pair, no new link is created and the existing link is returned instead.
Public methodAdd(String, IServiceProvider, IServiceProvider)
Creates a new link from the provided name, transmitter, and receiver and adds it to the collection. If a link in the collection already exists for the specified transmitter and receiver pair, no new link is created and the existing link is returned instead.
Public methodAdd(String, IServiceProvider, IServiceProvider, AtmosphericRefractionModel)
Creates a new link from the provided name, transmitter, and receiver and adds it to the collection. If a link in the collection already exists for the specified transmitter and receiver pair, no new link is created and the existing link is returned instead.
Public methodAddChain(IEnumerableIServiceProvider)
Adds multiple links to the collection at once, assuming that each item in the list either receives or transmits from the previous item. Usually, this contains a transmitter and receiver with zero or more transceivers or transponders in between.
Public methodAddChain(IServiceProvider)
Adds multiple links to the collection at once, assuming that each item in the list either receives or transmits from the previous item. Usually, this contains a transmitter and receiver with zero or more transceivers or transponders in between.
Public methodAddRange (Inherited from DefinitionalObjectCollectionT.)
Protected methodCheckForSameDefinition(CommunicationLinkCollection)
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(DefinitionalObjectCollectionExtensibleObject)
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 ExtensibleObjectCollection.)
Protected methodCheckForSameDefinition(ExtensibleObjectCollection)
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 ExtensibleObjectCollectionCheckForSameDefinition(ExtensibleObjectCollection).)
Public methodClear (Inherited from CollectionExtensibleObject.)
Protected methodClearItems (Inherited from DefinitionalObjectCollectionT.)
Public methodClone
Clones this object using the specified context.
(Overrides ExtensibleObjectCollectionClone(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(DefinitionalObjectCollectionT) method.
(Overrides ExtensibleObjectCollectionComputeCurrentDefinitionHashCode.)
Public methodContains (Inherited from CollectionExtensibleObject.)
Public methodCopyTo (Inherited from CollectionExtensibleObject.)
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 DefinitionalObjectCollectionTEnumerateDependencies(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 methodFind(IServiceProvider)
Finds all links in the collection that contains the provided link end in either the transmitter or receiver role.
Public methodFind(String)
Finds a link in the collection by name.
Public methodFind(IServiceProvider, LinkRole)
Finds all links in the collection that contain the provided link end in the specified role.
Public methodFind(IServiceProvider, IServiceProvider)
Finds all links with the specified transmitter and receiver pair.
Public methodFindFirst(IServiceProvider)
Finds the first link in the collection that contains the provided link end in either the transmitter or receiver role.
Public methodFindFirst(String)
Finds the first instance of the named link.
Public methodFindFirst(IServiceProvider, LinkRole)
Finds the first link in the collection that contains the provided link end in the specified role.
Public methodFindFirst(IServiceProvider, IServiceProvider)
Finds the first link with the specified transmitter and receiver pair.
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObjectCollectionT.)
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.
(Overrides DefinitionalObjectCollectionTFreezeAggregatedObjects.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObjectCollectionT.)
Public methodGetEnumerator (Inherited from CollectionExtensibleObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf (Inherited from CollectionExtensibleObject.)
Public methodInsert (Inherited from CollectionExtensibleObject.)
Protected methodInsertItem (Inherited from DefinitionalObjectCollectionT.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObjectCollectionT.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemove (Inherited from CollectionExtensibleObject.)
Public methodRemoveAt (Inherited from CollectionExtensibleObject.)
Protected methodRemoveItem (Inherited from DefinitionalObjectCollectionT.)
Protected methodSetItem
Replaces the element at the specified index.
(Inherited from DefinitionalObjectCollectionT.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObjectCollectionT.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also