Click or drag to resize

DefinitionalObject Class

The base class for all definitional objects. A definitional object has a few characteristics:

Inheritance Hierarchy
SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    More...

Namespace:  AGI.Foundation.Infrastructure
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.1.418.0 (24.1.418.0)
Syntax
public abstract class DefinitionalObject : ICloneWithContext, 
	IFreezable, IEquatableDefinition, IEnumerateDependencies

The DefinitionalObject type exposes the following members.

Constructors
  NameDescription
Protected methodDefinitionalObject
Initializes a new instance.
Protected methodDefinitionalObject(DefinitionalObject, 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.
Top
Methods
  NameDescription
Public methodStatic memberAreSameDefinition(Boolean, Boolean)
Determines if two booleans have the same definition. This overload simply checks equality and is provided for convenience.
Public methodStatic memberAreSameDefinition(Double, Double)
Determines if two doubles have the same definition. This overload simply checks equality and is provided for convenience.
Public methodStatic memberAreSameDefinition(IEquatableDefinition, Object)
Determines if two objects have the same definition or are both .
Public methodStatic memberAreSameDefinition(Int32, Int32)
Determines if two integers have the same definition. This overload simply checks equality and is provided for convenience.
Public methodStatic memberAreSameDefinition(Object, Object)
Determines if two objects have the same definition or are both .
Protected methodCheckForSameDefinition
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).
Public methodClone
Clones this object using the specified context.
Public methodStatic memberCollectionItemsAreSameDefinitionT(T, T)
Determines if two collections contain items with the same definition and in the same order, or are both .
Public methodStatic memberCollectionItemsAreSameDefinitionT(IEnumerableT, IEnumerableT)
Determines if two collections contain items with the same definition and in the same order, or are both .
Public methodStatic memberCollectionItemsAreSameDefinitionT(TimeIntervalCollectionT, TimeIntervalCollectionT)
Determines if two interval collections contain items with the same definition and in the same order, or are both .
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.
Public methodStatic memberDictionaryItemsAreSameDefinitionTKey, TValue
Determines if two dictionaries contain items with the same definition, or are both .
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.
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.
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.
Public methodStatic memberGetCollectionHashCode(Double)
Computes a hash code from the items in an array. The hash code computed is order dependent, that is, another array with the same items in a different order will have a different hash code.
Public methodStatic memberGetCollectionHashCodeT(T)
Computes a hash code from the items in an array. The hash code computed is order dependent, that is, another array with the same items in a different order will have a different hash code.
Public methodStatic memberGetCollectionHashCodeT(IEnumerableT)
Computes a hash code from the items in an enumerable collection. The hash code computed is order dependent, that is, another collection with the same items in a different order will have a different hash code.
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
Public methodStatic memberGetDefinitionHashCode(Boolean)
Gets a hash code safely. This overload simply calls GetHashCode and is provided for convenience.
Public methodStatic memberGetDefinitionHashCode(Double)
Gets a hash code safely. This overload simply calls GetHashCode and is provided for convenience.
Public methodStatic memberGetDefinitionHashCode(IEquatableDefinition)
Gets a hash code safely. If the specified object is , a valid hash code is still returned.
Public methodStatic memberGetDefinitionHashCode(Int32)
Gets a hash code safely. This overload simply calls GetHashCode and is provided for convenience.
Public methodStatic memberGetDefinitionHashCodeT(T)
Gets a hash code safely. If the specified object is , a valid hash code is still returned.
Public methodStatic memberGetDictionaryHashCodeTKey, TValue
Computes a hash code from the items in a dictionary.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
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.
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.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also
Inheritance Hierarchy
SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.AccessAccessComputation
    AGI.Foundation.AccessAccessQuery
    AGI.Foundation.AircraftPropagationAccelerationPerformanceModel
    AGI.Foundation.AircraftPropagationClimbDescentPerformanceModel
    AGI.Foundation.AircraftPropagationCruisePerformanceModel
    AGI.Foundation.AircraftPropagationHorizontalBehavior
    AGI.Foundation.AircraftPropagationManeuver
    AGI.Foundation.AircraftPropagationPerformanceModels
    AGI.Foundation.AircraftPropagationSimpleFixedWingCoordinatedFlight
    AGI.Foundation.AircraftPropagationSimpleFixedWingForwardFlightAerodynamics
    AGI.Foundation.AircraftPropagationSimpleForwardFlightJetPropulsion
    AGI.Foundation.AircraftPropagationSimpleForwardFlightPropellerPropulsion
    AGI.Foundation.AircraftPropagationVerticalBehavior
    AGI.Foundation.CcsdsCcsdsOrbitEphemerisMessageSegment
    AGI.Foundation.CelestialAtmosphericRefractionModel
    AGI.Foundation.CelestialCentralBody
    AGI.Foundation.CelestialEquationOfEquinoxes
    AGI.Foundation.CelestialForceModel
    AGI.Foundation.CelestialIndividualPlateModel
    AGI.Foundation.CelestialJplDE
    AGI.Foundation.CelestialJplDEFile
    AGI.Foundation.CelestialLibrationModel
    AGI.Foundation.CelestialNutationModel
    AGI.Foundation.CelestialPlanetarySystemBarycenter
    AGI.Foundation.CelestialPrecessionModel
    AGI.Foundation.CelestialSolarSystemBarycenter
    AGI.Foundation.CelestialSolidTideModel
    AGI.Foundation.CelestialSphericalHarmonicGravitySecularVariations
    AGI.Foundation.CelestialTorqueModel
    AGI.Foundation.CelestialUSStandardAtmosphere1976
    AGI.Foundation.CelestialWindModel
    AGI.Foundation.Communications.AntennasBaseGainPattern
    AGI.Foundation.Communications.AntennasDirectionsProvider
    AGI.Foundation.Communications.AntennasPhasedArrayBeamformer
    AGI.Foundation.Communications.AntennasPhasedArrayElement
    AGI.Foundation.Communications.AntennasPhasedArrayElementFactor
    AGI.Foundation.Communications.AntennasStaticDirection
    AGI.Foundation.CommunicationsCommunicationSystem
    AGI.Foundation.CommunicationsPointScattererFrequencyBand
    AGI.Foundation.CommunicationsPointScattererInformation
    AGI.Foundation.CommunicationsPointScattererLinkPath
    AGI.Foundation.CommunicationsPolarization
    AGI.Foundation.CommunicationsPolarizationSource
    AGI.Foundation.CommunicationsScatteringCoefficient
    AGI.Foundation.CommunicationsSignalChannelIdentifier
    AGI.Foundation.CommunicationsSignalComputation
    AGI.Foundation.CommunicationsSignalIdentifier
    AGI.Foundation.Communications.SignalProcessingIntendedSignalStrategy
    AGI.Foundation.Communications.SignalProcessingSignalProcessor
    AGI.Foundation.Communications.SignalPropagationItuRP676AtmosphericModel
    AGI.Foundation.Communications.SignalPropagationItuRP838AtmosphericModel
    AGI.Foundation.Communications.SignalPropagationItuRP840AtmosphericModel
    AGI.Foundation.Communications.SignalPropagationSignalPropagationModel
    AGI.Foundation.Communications.SignalPropagationSignalPropagationModelChain
    AGI.Foundation.CoordinatesComplexMatrix
    AGI.Foundation.CoordinatesDynamicStateT
    AGI.Foundation.CoordinatesMatrix
    AGI.Foundation.CoordinatesNumericalPropagatorAdapterHelper
    AGI.Foundation.CoordinatesStateElementAdapterDefinition
    AGI.Foundation.CoverageAssetDefinition
    AGI.Foundation.CoverageBaseCoverageDefinition
    AGI.Foundation.CoverageCoverageDefinitionOnSingleObject
    AGI.Foundation.GeometryAxes
    AGI.Foundation.GeometryCommunicationLinkSignalDataT
    AGI.Foundation.GeometryDynamicCovariance3By3
    AGI.Foundation.GeometryDynamicDelaunayElements
    AGI.Foundation.GeometryDynamicEquinoctialElements
    AGI.Foundation.GeometryDynamicKozaiIzsakMeanElements
    AGI.Foundation.GeometryDynamicMatrix
    AGI.Foundation.GeometryDynamicModifiedKeplerianElements
    AGI.Foundation.GeometryInternationalTerrestrialReferenceFrameTransformer
    AGI.Foundation.GeometryLinkSubdivision
    AGI.Foundation.GeometryPoint
    AGI.Foundation.GeometryReferenceFrame
    AGI.Foundation.GeometryScalar
    AGI.Foundation.GeometryScalarDependentOnServiceProvider
    AGI.Foundation.Geometry.ShapesDynamicSensorFieldOfView
    AGI.Foundation.Geometry.ShapesSensorProjectionOptions
    AGI.Foundation.GeometryTwoDimensionalConvexHull
    AGI.Foundation.GeometryVector
    AGI.Foundation.GeometryVectorDependentOnServiceProvider
    AGI.Foundation.InfrastructureExtensibleObject
    AGI.Foundation.InfrastructureObjectExtension
    AGI.Foundation.InfrastructureValueDefinitionT
    AGI.Foundation.Navigation.AdvancedGpsSignalGenerator
    AGI.Foundation.Navigation.AdvancedNavigationReceiverAccessQuery
    AGI.Foundation.Navigation.AdvancedNavigationReceiverChannel
    AGI.Foundation.Navigation.AdvancedNavigationSignal
    AGI.Foundation.NavigationGpsReceiver
    AGI.Foundation.NavigationGpsReceiverNoiseModel
    AGI.Foundation.Navigation.ModelsGpsReceiverErrorModel
    AGI.Foundation.NumericalMethods.AdvancedInterpolationAlgorithm
    AGI.Foundation.NumericalMethods.AdvancedPartialDerivativesFixed
    AGI.Foundation.NumericalMethods.AdvancedPartialDerivativesSum
    AGI.Foundation.NumericalMethodsCostFunctionSettings
    AGI.Foundation.NumericalMethodsCovariance6By6TwoBodyBlender
    AGI.Foundation.NumericalMethodsDoubleFunctionSampling
    AGI.Foundation.NumericalMethodsDoubleMotionInterpolator
    AGI.Foundation.NumericalMethodsDurationFunctionSampling
    AGI.Foundation.NumericalMethodsInequalityConstraintSettings
    AGI.Foundation.NumericalMethodsJulianDateFunctionSampling
    AGI.Foundation.NumericalMethodsRotationalMotionInterpolator
    AGI.Foundation.NumericalMethodsSegmentPropagatorConstraint
    AGI.Foundation.NumericalMethodsSegmentPropagatorCostFunction
    AGI.Foundation.NumericalMethodsSegmentPropagatorInequalityConstraint
    AGI.Foundation.NumericalMethodsSegmentPropagatorVariable
    AGI.Foundation.NumericalMethodsSolverConstraintSettings
    AGI.Foundation.NumericalMethodsSolverVariableSettings
    AGI.Foundation.NumericalMethodsTranslationalMotionInterpolator
    AGI.Foundation.Platforms.AdvancedGraphicsParameterT
    AGI.Foundation.Propagators.AdvancedAuxiliaryStateElement
    AGI.Foundation.Propagators.AdvancedPropagationStateCorrector
    AGI.Foundation.Propagators.AdvancedPropagationStateElement
    AGI.Foundation.PropagatorsCartesianOnePointPropagator
    AGI.Foundation.PropagatorsLifetimeOrbitPropagator
    AGI.Foundation.PropagatorsNumericalPropagatorDefinition
    AGI.Foundation.PropagatorsStoppablePropagatorDefinition
    AGI.Foundation.PropagatorsTwoBodyStateTransitionMatrixPropagator
    AGI.Foundation.RadarRadarWaveformProcessor
    AGI.Foundation.RouteDesign.AdvancedConnectionConfigurationResult
    AGI.Foundation.RouteDesign.AdvancedParametricRouteSegment
    AGI.Foundation.RouteDesign.AdvancedProcedureConfigurationResult
    AGI.Foundation.RouteDesign.AdvancedProfileSegment
    AGI.Foundation.RouteDesign.AdvancedSurfaceSegment
    AGI.Foundation.RouteDesignDefaultConnectionBehavior
    AGI.Foundation.RouteDesignPropagatedRoute
    AGI.Foundation.RouteDesignRoutePropagator
    AGI.Foundation.RouteDesignRouteSegment
    AGI.Foundation.SegmentPropagationFollowSegmentBeginning
    AGI.Foundation.SegmentPropagationFollowSegmentEnding
    AGI.Foundation.SegmentPropagationImpulsiveManeuverInformation
    AGI.Foundation.SegmentPropagationSegmentDefinition
    AGI.Foundation.SegmentPropagationStateUpdaterDefinition
    AGI.Foundation.SegmentPropagationTargetedSegmentListOperator
    AGI.Foundation.SpiceJplSpkEphemerisProvider
    AGI.Foundation.SpiceJplSpkFile
    AGI.Foundation.StoppingConditionsStoppingCondition
    AGI.Foundation.StoppingConditionsStoppingConditionConstraint
    AGI.Foundation.TrackingEntityFilterTEntity
    AGI.Foundation.TrackingEntityFilterChainTEntity
    AGI.Foundation.TrackingEntityParameterTEntity