AGI AgAsHpopPlugin 6 Send comments on this topic.
ForceModelName Method (IAgAsHpopPluginResultEval)
See Also 
Type
Force model 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 ForceModelName( _
   ByVal Type As AgEForceModelType _
) As String

[C#]
public string ForceModelName(
AgEForceModelType Type
);

[Managed C++]
public: String __gc ^ ForceModelName(
AgEForceModelType Type
);

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

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

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

Parameters

Type
Member Value Description
eGravityModel 0 Gravity.
eSolidTidesModel 1 Solid tides.
eOceanTidesModel 2 Ocean Tides.
eDragModel 3 Atmospheric drag.
eSRPModel 4 Solar radiation pressure.
eThirdBodyModel 5 Third bodies.
eGenRelativityModel 6 General relativity effects.
eAlbedoModel 7 Albedo (solar radiation reflected from central body).
eThermalRadiationPressureModel 8 Thermal radiation pressure from central body.
eDensityModel 9 Atmospheric Density.
Force model 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