[lmi-commits] [5321] Improve documentation, adumbrating some planned changes

[Greg Chicares]

Revision: 5321
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=5321
Author:   chicares
Date:     2011-12-01 13:02:30 +0000 (Thu, 01 Dec 2011)
Log Message:
-----------
Improve documentation, adumbrating some planned changes

Modified Paths:
--------------
    lmi/trunk/ihs_basicval.cpp

Modified: lmi/trunk/ihs_basicval.cpp
===================================================================
--- lmi/trunk/ihs_basicval.cpp  2011-12-01 03:52:14 UTC (rev 5320)
+++ lmi/trunk/ihs_basicval.cpp  2011-12-01 13:02:30 UTC (rev 5321)
@@ -663,6 +663,14 @@
 }
 
 //============================================================================
+// [This comment block will soon be expunged. This function is called
+// only by FindSpecAmt::operator(), but that GPT calculation could
+// just as well call GetModalTgtPrem() directly. No product design
+// currently supported has a target premium that varies by dbopt,
+// so at most a "SOMEDAY" marker is warranted. The caching of
+// InitialTargetPremium is unreliable if this function isn't first
+// called with an a_year of zero; it's meaningless anyway, because
+// the function happens to be called only with an a_year of zero.]
 // Needed for guideline premium.
 // TODO ?? a_dbopt is ignored for now, but some product designs will need it.
 double BasicValues::GetTgtPrem
@@ -672,6 +680,7 @@
     ,mcenum_mode  a_mode
     ) const
 {
+LMI_ASSERT(0 == a_year); // As noted above.
     if(Database_->Query(DB_TgtPremFixedAtIssue))
         {
         if(0 == a_year)