resourcemgmt/hwresourcesmgr/power/inc/HWRMPower.h
branchRCL_3
changeset 60 ccb4f6b3db21
parent 0 4e1aa6a622a0
child 61 8cb079868133
child 70 653a8b91b95e
--- a/resourcemgmt/hwresourcesmgr/power/inc/HWRMPower.h	Thu Aug 19 11:09:10 2010 +0300
+++ b/resourcemgmt/hwresourcesmgr/power/inc/HWRMPower.h	Tue Aug 31 16:29:05 2010 +0300
@@ -62,9 +62,20 @@
 * User::WaitForRequest(status);
 * User::LeaveIfError(status.Int());
 * 
-* // Start receiving periodical voltage measurements.
+* // Start receiving periodical power measurements.
+* //
+* // Note: There is a maximum reporting period defined for each product through the
+* //       CenRep Key KPowerMaxReportingPeriod defined in HWRMPowerDomainCRKeys.h.
+* //       The reporting will stop after this maximum reporting period by default.
+* //       The application can configure this dynamically.
+* //       Setting maximum report period to zero results in infinite notifications.
+* //
 * TRequestStatus& statusStart;
-* TIntervalMultiple intervalMultiple = EThreeTimesBaseTimeInterval;
+* TInt intervalMultiple = 3; // Three times the base time interval.
+* //
+* // Note: The base time interval is different for each product.
+* //       GetBaseTimeIntervalL API returns this value.
+* //
 * power->StartAverageVoltageReporting(statusStart, intervalMultiple);
 *  
 * User::WaitForRequest(statusStart);