prg_profile_data_entry_get_bt()

Abstract

Obtains a single data entry from a profile (by index), subject to a time constraint.

Syntax

prg_profile_data_entry_get_bt (profile_handle, start_time, options, n, entry_ptr)
Argument Type Description
profile_handle PrgT_Profile_Handle Handle to the profile from which to get the data entry.
start_time PrgT_Date Start time for considering data entries.
options int Data options (see options Argument in Details).
n unsigned int Index of the requested data entry.
entry_ptr PrgT_Profile_Data_Entry * Memory to hold the requested data entry.

Return Type

PrgT_Compcode

PrgC_Compcode_Failure if any argument is invalid or a data entry cannot be obtained; PrgC_Compcode_Success otherwise.

prg_profile_funcs.h

Details

This function obtains the nth data entry that meets a specified time constraint, where 0 <= n <= (number of entries – 1). If start_time is PRGC_DATE_VALUE_UNDEFINED, all data entries in the profile are considered. Otherwise, the function considers only data entries with a time (x value) equal to or greater than start_time.

By default, only defined data (y) values are returned. If the y value of the requested data entry is undefined, the function returns the last known defined y value (if one exists) or 0.0 (if not).

options Argument

options must be PRGC_PROFILE_DATA_OPT_NONE or an OR'ed combination of one or more of the following:

  • PRGC_PROFILE_DATA_OPT_TIME_ABS—The time is returned converted to a real-time date value, expressed as the number of seconds since January 1, 1970. (The default x value is a relative time.)
  • PRGC_PROFILE_DATA_OPT_INCLUDE_UNDEFINED—The function returns the y value of the requested data entry, whether or not that value is defined.

Note: To get the functionality of the deprecated function prg_profile_data_entry_get(), call this function with start_time set to PRGC_DATE_VALUE_UNDEFINED and options set to PRGC_PROFILE_DATA_OPT_NONE.

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com