AGI AgAsHpopPlugin 6 Send comments on this topic.
AccelName Method (IAgAsHpopPluginResultPostEval)
See Also 
Type
Acceleration type (i.e., a constituent of the force model)
Windows








Description

A translation of the enumerated type into a string.

Syntax

[Visual Basic .NET]
Public Function AccelName( _
   ByVal Type As AgEAccelType _
) As String

[C#]
public string AccelName(
AgEAccelType Type
);

[Managed C++]
public: String __gc ^ AccelName(
AgEAccelType Type
);

[Unmanaged C++]
public: HRESULT AccelName(
AgEAccelType Type,
BSTR * ReturnValue
);

[VBScript]
'Function object.AccelName(...)  returns type String
' Type is type AgEAccelType (an integer)
result = object.AccelName(Type)

[Perl]
$return_value = $objectReference->AccelName(# $return_value is of type string
$Type# type AgEAccelType (scalar integer)
);

Parameters

Type
Member Value Description
eTotalAccel 0 Total accleration.
eTwoBodyAccel 1 Two body contribution.
eGravityAccel 2 Contribution of the total gravity field.
ePerturbedGravityAccel 3 Contribution of the total gravity field minus the two body contribution.
eSolidTidesAccel 4 Contribution of solid tides. Will be zero if the force model is not set to consider this effect.
eOceanTidesAccel 5 Contribution of ocean tides. Will be zero if the force model is not set to consider this effect.
eDragAccel 6 Contribution of atmospheric drag. Will be zero if the force model is not set to consider this effect.
eSRPAccel 7 Contribution of solar radiation pressure. Will be zero if the force model is not set to consider this effect.
eThirdBodyAccel 8 Contribution of all third bodies. Will be zero if the force model is not considering any third body forces.
eGenRelativityAccel 9 Contribution of general relativity effects. Will be zero if the force model is not set to consider this effect.
eAddedAccel 10 Contribution of any additional acceleration, say by a plugin.
eAlbedoAccel 11 Contribution of albedo (reflected solar radiation pressure).
eThermalRadiationPressureAccel 12 Contribution of thermal radiation pressure.
Acceleration type (i.e., a constituent of the force model)

Return Type

Returns the name from the enumeration value

Remarks

Useful when creating string messages

See Also

© 2017 Analytical Graphics, Inc. All Rights Reserved.

ODTK 6.5