PlatformLocationPoint Class

A Point that can be used to refer to the current LocationPoint of a Platform, whatever it is at the time that this point is evaluated. All method and properties on this class simply pass the call to the platform's current LocationPoint.

Inheritance Hierarchy

SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.GeometryPoint
      AGI.Foundation.PlatformsPlatformLocationPoint

Namespace: AGI.Foundation.Platforms
Assembly: AGI.Foundation.Platforms (in AGI.Foundation.Platforms.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public class PlatformLocationPoint : Point

Public Class PlatformLocationPoint
	Inherits Point

public ref class PlatformLocationPoint : public Point

type PlatformLocationPoint =  
    class
        inherit Point
    end

The PlatformLocationPoint type exposes the following members.

Constructors

	Name	Description
	PlatformLocationPoint(Platform)	Creates a new instance of this class with the specified parameters
	PlatformLocationPoint(PlatformLocationPoint, CopyContext)	Initializes a new instance as a copy of an existing instance.

Top

Properties

	Name	Description
	IsFrozen	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.)
	Platform	Gets or sets the Platform whose LocationPoint will receive all method calls.

Top

Methods

	Name	Description
	CheckForSameDefinition(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 Point.)
	CheckForSameDefinition(PlatformLocationPoint)	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).
	CheckForSameDefinition(Point)	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 PointCheckForSameDefinition(Point).)
	Clone	Clones this object using the specified context. (Overrides DefinitionalObjectClone(CopyContext).)
	ComputeCurrentDefinitionHashCode	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 PointComputeCurrentDefinitionHashCode.)
	CreateVectorAcceleration	Constructs a vector which represents the second derivative of this point's position. (Inherited from Point.)
	CreateVectorDerivative	Constructs a vector which represents the requested order of the derivative of this point's position. (Inherited from Point.)
	CreateVectorVelocity	Constructs a vector which represents the derivative of this point's position. (Inherited from Point.)
	EnumerateDependencies	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).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Freeze	Freezes this object. Further attempts to modify it will result in an ObjectFrozenException. (Inherited from DefinitionalObject.)
	FreezeAggregatedObjects	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.)
	GetDefinitionHashCode	Gets a hash code representing the definition of this object. (Inherited from DefinitionalObject.)
	GetEvaluator	Gets an evaluator that can be used to find the motion of this point in its parent reference frame at a given date. Consider using the methods of GeometryTransformer instead of calling this method directly. See GetEvaluator(EvaluatorGroup) for more details. (Inherited from Point.)
	GetEvaluator(EvaluatorGroup)	Gets an evaluator that can be used to find the motion of this point in its parent reference frame at a given date. Consider using the methods of GeometryTransformer instead of calling this method directly. (Overrides PointGetEvaluator(EvaluatorGroup).)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetScalarElement(CartesianElement, ReferenceFrame)	Returns a Scalar representing the X, Y, Z, or Magnitude of this point. (Inherited from Point.)
	GetScalarElement(CartesianElement, ReferenceFrame, Int32)	Returns a Scalar representing the X, Y, Z, or Magnitude, or any derivative of those elements of this point. (Inherited from Point.)
	GetService	Gets the service object of the specified type. (Inherited from Point.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsSameDefinition	Determines if this object has the same definition as another object. (Inherited from DefinitionalObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ThrowIfFrozen	Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object. (Inherited from DefinitionalObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This class is helpful when you have other classes that depend on a platform's LocationPoint and you want to be able to change the platform's point without updating the references in the other classes. Consider a platform configured like this:

Examples

Copy

var earth = CentralBodiesFacet.GetFromContext().Earth;
Platform platform = new Platform();
platform.LocationPoint = new PointCartographic(earth, Cartographic.Zero);
platform.OrientationAxes = new AxesNorthEastDown(earth, platform.LocationPoint);

If you later assign the LocationPoint property with a new Point instance, you must also remember to update the axes referred to by the OrientationAxes property to refer to the new Point instance. Now, consider a platform configured like this:

Examples

Copy

var earth = CentralBodiesFacet.GetFromContext().Earth;
Platform platform = new Platform();
platform.LocationPoint = new PointCartographic(earth, Cartographic.Zero);
PlatformLocationPoint point = new PlatformLocationPoint(platform);
platform.OrientationAxes = new AxesNorthEastDown(earth, point);

In this case, you can change the LocationPoint property at will without worrying about the OrientationAxes at all.

Reference

AGI.Foundation.Platforms Namespace