AGI AgAsHpopPlugin 11 Send comments on this topic.
IAgAsHpopPluginResult Interface

Description

Several functions defined in IAgAsHpopPlugin pass this component as the lone argument.  This component contains functions that allow the plugin component to access inputs and set outputs.

Public Methods

Public Method AtmFlux Flux values used by density models, evaluated at the requested time. No time lags are incorporated.
Public Method AtmFlux_Array Flux values used by density models, evaluated at the requested time, returned as an array representing F10.7, AvgF10.7, Ap, DailyAp, Kp, DailyKp. No time lags are incorporated.
Public Method AtmFluxLags The lag times (in secs), relative to the current epoch, at which the density flux values are evaluated.
Public Method AtmFluxLags_Array The lag times (in secs), relative to the current epoch, at which the density flux values are evaluated, returned as an array of F10.7 lag, geo flux lag.
Public Method CurrentAtmFlux Flux values used by the density model, evaluated at the current time.
Public Method CurrentAtmFlux_Array Flux values used by the density model, evaluated at the current time, returned as an array representing F10.7, AvgF10.7, Ap, DailyAp, Kp, DailyKp.
Public Method Date DEPRECATED. Use DateElementsinstead. Current epoch in requested time scale expressed in date format.
Public Method Date_Array DEPRECATED. Use DateElements_Array instead. Current epoch in requested time scale expressed in date format returned as an array representing year [yyyy], dayOfYear, month [0-11], hour [0-23], minute [0-59], seconds. Useful for scripting clients.
Public Method DateElements Current epoch in requested time scale expressed in date format. Year [yyyy], DayOfYear [1-366], Month [1-12], DayOfMonth [1-31], Hour [0-23], Minute [0-59], Seconds [0-60].
Public Method DateElements_Array Current epoch in requested time scale expressed in date format returned as the array: Year [yyyy], DayOfYear [1-366], Month [1-12], DayOfMonth [1-31], Hour [0-23], Minute [0-59], Seconds [0-60]. Useful for scripting clients.
Public Method DateString Current epoch expressed using the date format abbreviation specified.
Public Method DayCount Current epoch in requested time scale expressed in day count format.
Public Method DayCount_Array Current epoch in requested time scale expressed in day count format returned as an array representing wholeDays, secsIntoDay. Useful for scripting clients.
Public Method ForceModelName A translation of the enumerated type into a string.
Public Method IndicateEvent Marks an event to the propagator.
Public Method IsForceModelOn Indicates whether a particular force model contributor is being considered.
Public Method LatLonAlt Current detic latitude (radians), detic longitude (radians), and altitude (meters).
Public Method LatLonAlt_Array Current detic latitude (radians), detic longitude (radians), and altitude(meters) returned as an array representing lat, lon, alt. Useful for scripting clients.
Public Method PosVel Current position (meters) and velocity (meters/second) in the requested frame.
Public Method PosVel_Array Current position (meters) and velocity (meters/second) in the requested frame returned as an array representing x, y, z, vx, vy, vz. Useful for scripting clients.
Public Method RefEpoch DEPRECATED. Use RefEpochElements instead. Reference epoch expressed in day count and date formats.
Public Method RefEpoch_Array DEPRECATED. Use RefEpochElements_Array instead. Reference epoch expressed in day count and date formats returned as an array representing wholeDays, secsIntoDay, year [yyyy], dayOfYear, month [0-11], hour [0-23], minute [0-59], seconds. Useful for scripting clients.
Public Method RefEpochElements Reference epoch expressed in requested time scale in day count and date formats. WholeDays, SecsIntoDay, Year [yyyy], DayOfYear [1-366], Month [1-12], DayOfMonth [1-31], Hour [0-23], Minute [0-59], Seconds [0-60].
Public Method RefEpochElements_Array Reference epoch expressed in requested time scale in day count and date formats as the array: WholeDays, SecsIntoDay, Year [yyyy], DayOfYear [1-366], Month [1-12], DayOfMonth [1-31], Hour [0-23], Minute [0-59], Seconds [0-60]. Useful for scripting clients.
Public Method RefEpochString Reference epoch expressed using the date format abbreviation specified.
Public Method SetMaxStep Sets the maximum step size in seconds for the propagator.
Public Method StopPropagation Stops propagation. For fatal errors.
Public Method SunPosition Position of the sun in meters wrt the current satellite position, in the requested frame, computed in the requested manner.
Public Method SunPosition_Array Position of the sun in meters wrt the current satellite position, in the requested frame, computed in the requested manner, returned as an array representing x, y, z. Useful for scripting clients.
Public Method Trace Set this interface to trace the next numCalls by outputting a message to the message viewer.
Public Method TransformVector Transforms a vector from the input frame to the output frame.
Public Method TransformVector_Array Transforms a vector from the input frame to the output frame (in internal units) returned as an array representing x, y, z. Useful for scripting clients.

Public Properties

Public Property Altitude Current altitude in meters.
Public Property CbName Name of the central body used as reference frame origin.
Public Property Cd Drag Coefficient. Can only be set if Drag is on.
Public Property Cr SRP Coefficient. Can only be set if SRP is on.
Public Property DragArea Drag Area in meters^2. Can only be set if Drag is on.
Public Property DryMass Dry Mass in kilograms.
Public Property FuelMass Fuel Mass in kilograms.
Public Property LightSpeed Speed of light in meters/second.
Public Property Mass Mass in kilograms. Deprecated. Use TotalMass, FuelMass, or DryMass instead.
Public Property Mu Gravitational constant in meters^3/second^2.
Public Property RadPressureArea Radiation pressure area in meters^2, used by albedo and thermal radiation pressure. Can only be set if albedo or thermal radiation pressure is on.
Public Property RadPressureCoefficient Radiation pressure coefficient, used by albedo and thermal radiation pressure. Can only be set if albedo or thermal radiation pressure is on.
Public Property SolarFlux Current solar flux in watts/meter^2. Available only if SRP is on.
Public Property SRPArea SRP Area in meters^2. Can only be set if SRP is on.
Public Property TimeSinceRefEpoch Current epoch expressed in seconds since reference epoch.
Public Property TotalMass Total Mass in kilograms.

CoClasses that Implement IAgAsHpopPluginResult

© 2016 Analytical Graphics, Inc. All Rights Reserved.

STK Programming Interface 11.0.1