aGOAL.struct.cpp

Go to the documentation of this file.

struct aGOAL
    {
    public:
        aGOAL(int investor_id = 0) {this->investor = investor_id;}  
        
        int    goal_id;
    int    investor = 0;
    int    goal_type;     
    float  amount;        
    float  target_amount; 
        std::map<int, float> means_goal;        

    string description;
    string currency;
    int    priority;
    string from_date;
    string till_date;
    string frequency;
    float  realization_age;
    float  max_shortfall;
    
    float  alpha = 0.1;
    int    realization_monthNbr;
        std::map<int, float> saving_plan;
    int optimal_portf;
    float realized_shortfall;
        std::map<int, float> benchmark;
        std::string remarks;
    string color;
    string color_followup;
    bool success;
    string simulation_string = "";   
    float simulation_endvalue = 0;   
    string s_low  = ""; 
    string s_exp  = ""; 
    string s_high = ""; 
    string s_goal = ""; 


        friend ostream& operator<<(ostream& os, const aGOAL& the_goal);

/*  void save_this(string g_type, string descr, string curr, string priority,
               string f_date, string t_date, string f, string r_age,
               stirng amount, string m_shortfall);
*/

//        bool set_unallocated_goal();  --> moved to investment_problem
    void set_from_db();
    void set_to_pstmnt();
        bool save();
    bool add_to_db();
    void save_results();  

    bool set_goal_type       (string g_type);
    bool set_amount          (string amnt);  
    bool set_description     (string desc);
    bool set_currency        (string curr); 
    bool set_priority        (string imp);
    bool set_from_date       (string f_date);
    bool set_till_date       (string t_date);
    bool set_frequency       (string freq);
    bool set_realization_age (string real_age, float actual_age);
    bool set_max_shortfall   (string shortfall);
    int  show_graph_till_MNbr ();
    };
    
 
ostream& operator<<(ostream& os, const aGOAL& the_goal)
{
  if (the_goal.goal_type == goal_type_s2i["unallocated"])
  {
    os << "The goal <b><i>&quot;" << the_goal.description << "&quot;</i></b> is to show you the resources that are not used by your other goals.";
  }
  else if (the_goal.goal_type == goal_type_s2i["income from/to"])
  {
    cls_frequency the_freq;
    the_freq.set_freq(the_goal.frequency);
    string s = the_freq.get_freq_label();
    std::transform(s.begin(), s.end(), s.begin(), ::tolower);
    
    os << setiosflags(ios::fixed) << setprecision(2)
       << "The goal <b><i>&quot;" << the_goal.description << "&quot;</i></b> is to achieve"
       << " an income of " << curr_format(the_goal.amount, the_goal.currency)
       << " (" << s << ")"
       << " from " << date_format_dateStr(the_goal.from_date)
       << " to " << date_format_dateStr(the_goal.till_date) << ".<br>"
       << "This goal's relative priority is " << the_goal.priority;
  }
  else if (the_goal.goal_type == goal_type_s2i["rainy day savings"])
  {
    os << setiosflags(ios::fixed) << setprecision(2)
       << "This goal <b><i>&quot;" << the_goal.description << "&quot;</i></b> is to have a safety layer (\"rainy day savings\") always available."
       << "The amount that we try to keep available is " << curr_format(the_goal.amount, the_goal.currency)
       << ".<br>This goal's relative priority is " << the_goal.priority;
  }    
  else if (the_goal.goal_type == goal_type_s2i["amount asap"])
  {
    os << setiosflags(ios::fixed) << setprecision(2)
       << "This goal <b><i>&quot;" << the_goal.description << "&quot;</i></b> is to obtain the sum of " << curr_format(the_goal.amount, the_goal.currency)
       << " asap.<br>This goal's relative priority is " << the_goal.priority;
  }    
  else
  {
    os << setiosflags(ios::fixed) << setprecision(2)
       << "The goal <b><i>&quot;" << the_goal.description << "&quot;</i></b> is to achieve"
       << " an amount of " << curr_format(the_goal.amount, the_goal.currency)
       << " at the age of " << setprecision(0) << the_goal.realization_age << ".<br>" <<setprecision(2)
       << "This goal's relative priority is " << the_goal.priority
       << " and we accept a maximum shortfall of " <<  curr_format(the_goal.max_shortfall, the_goal.currency) << ".";
  }
  return os;
}

bool aGOAL::set_goal_type(string g_type)
{
  int g_type_id = atoi(g_type.c_str());
  unordered_map<int, string>::const_iterator got = goal_type_i2s.find(g_type_id);
  if (got == goal_type_i2s.end())
  {
    error_message = error_message + "<li>the goal_type is not one of the supported types</li>";
    return false;
  }
  else
  {
    this->goal_type = g_type_id;
    return true;
  }
}

bool aGOAL::set_amount(string amnt)
{
  this->amount = atof(amnt.c_str());  // returns 0.0 if no valid number is found
  return true;
}

bool aGOAL::set_currency(string curr)
{
  cls_currency o_curr;
  if (o_curr.set_curr(curr))
  {
    this->currency = curr;
    return true;
  }
  else
  {
    error_message = error_message + "<li>error occured saving the currency --- not a valid currency</li>";
    return false;
  }
}

bool aGOAL::set_description(string desc)
{
  if (desc == "")
  {
    this->description = "Please change this text with your own goal-description!";
  }
  else
  {
    this-> description = desc;
  }
  return true;
}


bool aGOAL::set_priority(string imp)
{
  this->priority = atoi(imp.c_str());
  return true;
}

bool aGOAL::set_realization_age(string real_age, float actual_age)
{
  float the_age;
  the_age = atof(real_age.c_str());
  if ((the_age < actual_age) || (the_age > (MAX_AGE + 0.0)))
  {
    error_message = error_message + "<li>the realization_age of the goal should be a number between your actual age and " + to_string(MAX_AGE + 0) + "(provided: realization age = " + real_age + "; compared to actual age = " + to_string(actual_age) + ".</li>";
    return false;
  }
  else
  {
    this->realization_age = the_age;
//NOT    this->from_date = tm2DateStr(get_tm((the_age - actual_age) * 12));
//NOT    this->till_date = this->from_date;
//NOT override!    this->frequency = "O";
    return true;
  }
}

bool aGOAL::set_frequency(string freq)
{
   cls_frequency o_freq;
   if (o_freq.set_freq(freq))
   {
     this->frequency = freq;
     return true;
   }
   else
   {
    error_message = error_message + "<li>error saving the frequency information</li>";
    return false;
   }
}

bool aGOAL::set_from_date(string f_date)
{
  if (is_valid_dateStr(f_date))
  {
    from_date = f_date;
    return true;
  }
  else
  {
    error_message = error_message + "<li>from_date is not a valid date</li>";
    return false;
  }
}

bool aGOAL::set_till_date(string t_date)
{
  struct tm tm_from_date, tm_till_date;
  dateStr2tm(this->from_date, &tm_from_date);
  dateStr2tm(t_date, &tm_till_date);
  if (is_valid_dateStr(t_date))
  {
    if (difftime(mktime(&tm_till_date),mktime(&tm_from_date)) >= 0)
    {
      till_date = t_date;
      return true;
    }
    else
    {
      error_message = error_message + "<li>the till_date must be after the from_date (it cannot precede the from_date)</li>";
      return false;
    }

  }
  else
  {
    error_message = error_message + "<li>till_date is not a valid date</li>";
    return false;
  }
}

bool aGOAL::set_max_shortfall(string shortfall)
{
  float the_sf = atof(shortfall.c_str());
  if ((this->goal_type != goal_type_s2i["income from/to"]) && (the_sf > this->amount))
  {
    std_message = std_message + "<li>are you sure that the shortfall can be higher than the target amount (note: this is saved, but you might want to reconsider)</li>";
  }
  this->max_shortfall = the_sf;
  return true;
}


bool aGOAL::add_to_db()
{
  if (this->investor == 0)
  {
    error_message = error_message + "<li>Failed to add_to_db, because investor id not set</li>.";
    return false;
  }
  string s;
  s = "INSERT INTO " + oConfig.tbl_prefix + "_goals (investor, goal_type, description, need_level, realization_age, from_date, ";
  s = s + "till_date, frequency, amount, currency, max_shortfall, priority) VALUES (?,?,?,?,?,?,?,?,?,?,?,?);";

  try
  {
    db.pstmt = db.con->prepareStatement(s);
    db.pstmt->setInt   ( 1,investor);
    db.pstmt->setInt   ( 2,this->goal_type);
    db.pstmt->setString( 3,this->description);
    db.pstmt->setInt   ( 4,1);
    db.pstmt->setDouble( 5,this->realization_age);
    db.pstmt->setString( 6,this->from_date);
    db.pstmt->setString( 7,this->till_date);
    db.pstmt->setString( 8,this->frequency);
    db.pstmt->setDouble( 9,this->amount);
    db.pstmt->setString(10,this->currency);
    db.pstmt->setDouble(11,this->max_shortfall);
    db.pstmt->setInt   (12,this->priority);
    db.pstmt->execute();
  }

 catch (sql::SQLException &e)
 {
   #ifdef DEBUG
    debug_info =  debug_info + "# ERR: SQLException in " + __FILE__ + "(" + __FUNCTION__
                  + ") on line " + to_string(__LINE__) + "<br># ERR: " + e.what() 
          + " (MySQL error code: " + to_string(e.getErrorCode())
                  + ", SQLState: " + e.getSQLState() + " )<br>";
   #endif
    error_message = error_message + "<li>Sorry, I failed to add the goal <b>&quot;" + this->description + "&quot;</b> to the database. Please, retry!</li>";
    return false;
 }
 return true; // if we're still here, then no exception was thrown and the INSERT INTO was successful.
}

bool aGOAL::save()
{
  string s;
  s = "UPDATE " + oConfig.tbl_prefix + "_goals SET , goal_type = ?, description = ?, need_level = ?, realization_age = ?, from_date = ?, ";
  s = s + "till_date = ?, frequency = ?, amount = ?, currency = ?, max_shortfall = ?, priority = ?";
  s = s + " WHERE investor_id = " + to_string(this->investor) + ";";

  try
  {
    db.pstmt = db.con->prepareStatement(s);
    set_to_pstmnt();
  }

 catch (sql::SQLException &e)
 {
   #ifdef DEBUG
    debug_info =  debug_info + "# ERR: SQLException in " + __FILE__ + "(" + __FUNCTION__
                  + ") on line " + to_string(__LINE__) + "<br># ERR: " + e.what() 
          + " (MySQL error code: " + to_string(e.getErrorCode())
                  + ", SQLState: " + e.getSQLState() + " )<br>";
   #endif
    error_message = error_message + "<li>Sorry, I failed to save the goal <b>&quot;" + this->description + "&quot;</b> the remains unchanged!</li>";
    return false;
 }
 return true; // if we're still here, then no exception was thrown and the INSERT INTO was successful.

}



void aGOAL::set_from_db()
{
  this->goal_id         = db.res->getInt("goal_id");
  this->investor        = db.res->getInt("investor");
  this->amount          = db.res->getDouble("amount"); 
  this->goal_type       = db.res->getInt("goal_type");   
  this->description     = db.res->getString("description");
  this->realization_age = atof(db.res->getString("realization_age").c_str());
  this->currency        = db.res->getString("currency");
  this->priority        = db.res->getInt("priority");
  this->from_date       = db.res->getString("from_date");
  this->till_date       = db.res->getString("till_date");
  this->frequency       = db.res->getString("frequency");
  this->max_shortfall   = atof(db.res->getString("max_shortfall").c_str());
// not loaded:
//  need_level       INT(10) REFERENCES " + oConfig.tbl_prefix + "_need_levels(need_level_id) ON DELETE RESTRICT,
  
}

void aGOAL::set_to_pstmnt()
{
    db.pstmt->setInt   ( 1,investor);
    db.pstmt->setInt   ( 2,this->goal_type);
    db.pstmt->setString( 3,this->description);
    db.pstmt->setInt   ( 4,1);                     // need level not used right now
    db.pstmt->setDouble( 5,this->realization_age);
    db.pstmt->setString( 6,this->from_date);
    db.pstmt->setString( 7,this->till_date);
    db.pstmt->setString( 8,this->frequency);
    db.pstmt->setDouble( 9,this->amount);
    db.pstmt->setString(10,this->currency);
    db.pstmt->setDouble(11,this->max_shortfall);
    db.pstmt->setInt   (12,this->priority);
    db.pstmt->execute();
}