Click or drag to resize

OpticalTransmitter Class

A communications transmitter defined by an optical antenna and list of signal processors.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Communications
Assembly:  AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax
public class OpticalTransmitter : Platform, 
	IIdentifiableTransmitterService

The OpticalTransmitter type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAdditionalSignalData
Gets the additional data included on the signal.
Public propertyAntennaGainPattern
Gets or sets the OpticalGainPattern which represents the transmitter's optics.
Public propertyChildren
Gets the collection containing the children of this Platform.
(Inherited from Platform.)
Public propertyDataRate
Gets or sets the rate, in bits per second, at which the data is modulated on the carrier.
Public propertyExtensions
Gets the collection of extensions attached to this object.
(Inherited from ExtensibleObject.)
Public propertyGenerationTimes
Gets a collection of the TimeIntervals when the transmitter is broadcasting.
Public propertyIdentifier
Gets the identifier for this transmitter's signals.
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 propertyLocationPoint
Gets or sets the time-varying location of this platform.
(Inherited from Platform.)
Public propertyModulation
Gets or sets the DigitalModulation.
Public propertyName
Gets or sets the name of the platform.
(Inherited from Platform.)
Public propertyOrientationAxes
Gets or sets the time-varying orientation of this platform.
(Inherited from Platform.)
Public propertyParent
Gets the parent platform of this platform.
(Inherited from Platform.)
Public propertyPolarizationSource
Gets or sets the polarization source.
Public propertyPower
Gets or sets the power, in watts, the transmitter's amplifier uses to transmit the signal.
Public propertyReferenceFrame
Gets the reference frame of this platform formed by the combination of the platform's location and orientation.
(Inherited from Platform.)
Public propertyWavelength
Gets or sets the wavelength, in meters, that the signal is transmitted on.
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 ExtensibleObject.)
Protected methodCheckForSameDefinition(ExtensibleObject)
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 Platform.)
Protected methodCheckForSameDefinition(OpticalTransmitter)
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(Platform)
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 PlatformCheckForSameDefinition(Platform).)
Public methodClone
Clones this object using the specified context.
(Overrides PlatformClone(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 PlatformComputeCurrentDefinitionHashCode.)
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 PlatformEnumerateDependencies(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 Platform.)
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 methodGetService
Gets the service object of the specified type.
(Inherited from Platform.)
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