Finance class Reference Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members

Finance Class Reference

#include <Ofinance.h>

List of all members.

Public Methods

float get_research_overhead_rate ()

void calc_max_hires ()

void init ()

void deinit ()

int write_file (File *filePtr)

int read_file (File *filePtr)

void init_data_pre_enroll ()

All LHS variables of the assignment statments below refer to cells in the first and second tables in the excel file ResAlloc.ex (file_ex) run before enroll_res.init_data() and enroll_main() since it requires, inflation rate, tuition_rate.

void init_data ()

void post_init_data ()

void process_budget ()

should be "init_budget"

bool pre_optimization_stage_3 (bool init=false)

bool optimize_policy_1 (bool init=false)

This function is for stage 1 optimization of financial policies. See file ResAlloc.Equation for details.

bool optimize_policy_2 ()

This function is for stage 2 optimization of financial policies. See file ResAlloc.Equation for details.

bool optimize_policy_3 ()

void correct_surplus_deficit ()

void next_day ()

void next_month ()

void new_fiscal_year_report ()

void disp_report_main (int refreshFlag, int dispReport=1, char *reportTitle=NULL)

void report_detect (int detectReport=1)

void report_deinit ()

void new_fiscal_year ()

void new_fiscal_year_report (int refreshFlag)

void new_fiscal_year_report_detect ()

void report_paint_button (int refreshFlag)

void update_projected_arrays_post_optimization ()

FinancePolicy * get_policy_var (bool isRevenue, char index)

bool update_projected_arrays_pre_optimization ()

void calc_projected_total_n_percent (int reCalc=0)

void calc_total_last_year ()

called once from init_data()

void change_budget (char changeType, bool isRevenue, char index, float percentChange, char showMsg=1)

void calc_budget_report ()

Player's "Year-End Financial Report".

void set_policy_target (bool isRevenue, char index)

void budget_calc_total ()

void budget_calc_percent ()

void budget_calc_change ()

Calculate Budget to Last Year Actual change percentage.

void calc_asset_total ()

double get_available_funds ()

double calc_total_faculty_salary ()

Static Public Methods

double calc_change (double dest, double base)

Public Attributes

char fiscal_year_start_month

char fiscal_year_end_month

int report_financial_recno

RevenueItem revenue_array [REVENUE_ITEM_COUNT]

ExpenseItem expense_array [EXPENSE_ITEM_COUNT]

RevenueItem total_revenue

ExpenseItem total_operating_expense

ExpenseItem total_expense

RevenueItem budget_revenue_array [REVENUE_ITEM_COUNT]

ExpenseItem budget_expense_array [EXPENSE_ITEM_COUNT]

RevenueItem budget_total_revenue

ExpenseItem budget_total_operating_expense

ExpenseItem budget_total_expense

RevenueItemChange projected_revenue_array [REVENUE_ITEM_COUNT]

ExpenseItemChange projected_expense_array [EXPENSE_ITEM_COUNT]

RevenueItemChange projected_total_revenue

ExpenseItemChange projected_total_operating_expense

ExpenseItemChange projected_total_expense

YearReport this_year

YearReport next_year

YearReport last_year

YearReport budget_year

Stage1Revenue stage1_revenue [STAGE1_REVENUE_ITEM_COUNT]

Stage1Expense stage1_expense [STAGE1_EXPENSE_ITEM_COUNT]

Stage2Expense stage2_expense [STAGE2_EXPENSE_POLICY_COUNT]

int tradU_target_student_intake

int nontradU_target_student_intake

int master_target_student_intake

int dl_target_student_intake

double smoothed_endowment_value

int tuition_rate

HistoryData inflation_rate_hist

double base_short_term_debt_interest

double base_long_term_debt_interest

double state_appropriation_last2

double inflation_rate

double short_term_debt_interest

double long_term_debt_interest

double debt_fraction_repaid_annually

double family_income_growth

double construction_cost_growth

double endowment_return

double sponsored_research_growth

double gifts_growth

double athletics_revenue_growth

double bank_debt_interest

double other_expense_growth

double other_income_growth

int building_life_for_calc_depreciation

double prior_dept_fac_exp

float state_appropriation_real_growth

double last_month_SR_D

double last_month_SR_ID

char month_left

double total_faculty_salary

int projected_total_research_expense_this_year

float academic_support_ratio

double research_expense_fac_ratio

double research_expense_staff_ratio

StudentPolicy student_policy_array [STUDENT_POLICY_COUNT]

FinancePolicy revenue_policy_array [REVENUE_POLICY_COUNT]

FinancePolicy expense_policy_array [EXPENSE_POLICY_COUNT]

FinancePolicy cost_rise_policy_array [COST_RISE_POLICY_COUNT]

HiringPolicy hiring_policy_array [MAX_DEPARTMENT]

int max_hires

int total_hires

float cost_limit

char current_report_mode

int report_type

int report_year

int report_opt

char report_is_expanded

double surplus_deficit_history [HISTORY_MONTH_COUNT]

double operating_sub_surplus_history [HISTORY_MONTH_COUNT]

double sponsored_research_history [HISTORY_MONTH_COUNT]

float sl1_sel_history [HISTORY_YEAR_COUNT]

double net_tuition_history [HISTORY_MONTH_COUNT]

Detailed Description

Class which implements the financial model described in Tech Doc 2.2, section 3. Assets, endowments, loans, budgets, expenses, and revenue are all represented here and methods for calculating, projecting, and reporting are provided.

Definition at line 324 of file Ofinance.h.

Member Function Documentation

void Finance::budget_calc_change ( )

Calculate Budget to Last Year Actual change percentage.

Definition at line 4001 of file Ofinance.cpp.
References RevenueItemChange::change_budget_year, RevenueItem::direct, RevenueItem::indirect, REVENUE_ITEM_COUNT, and RevenueItem::total.

void Finance::budget_calc_percent ( )

Definition at line 4117 of file Ofinance.cpp.
References AC_NET_TUITION_INCOME, and REVENUE_ITEM_COUNT.

void Finance::budget_calc_total ( )

Definition at line 4054 of file Ofinance.cpp.
References AC_NET_TUITION_INCOME, AC_SPONSORED_RESEARCH_REVENUE, and REVENUE_ITEM_COUNT.

void Finance::calc_asset_total ( )

Definition at line 1881 of file Ofin_day.cpp.
References AC_ASSET_TOTAL, and ASSET_ITEM_COUNT.

void Finance::calc_budget_report ( )

Player's "Year-End Financial Report".

Definition at line 3563 of file Ofinance.cpp.
References AC_ENDOWMENT, AC_ENDOWMENT_SPENDING, AC_FINANCIAL_AID, AC_GIFTS, AC_GROSS_TUITION_INCOME, AC_INTERCOLLEGIATE_ATHLETICS, AC_INTEREST_EARNED_OR_PAID, AC_NET_TUITION_INCOME, AC_OTHER_OPERATING_INCOME, AC_SPONSORED_RESEARCH_REVENUE, AC_STATE_APPROPRIATION, PL_INDIRECT_COST_RATE, PL_TUITION_RATE_GROWTH, S1_DIRECT_SPONSORED_RESEARCH, S1_ENDOWMENT_SPENDING, S1_FINANCIAL_AID, S1_GIFTS, S1_GROSS_TUITION_INCOME, S1_INTERCOLLEGIATE_ATHLETICS, S1_OTHER_OPERATING_INCOME, and S1_STATE_APPROPRIATION.

double Finance::calc_change ( double dest,

double base

) [static]

## chea 170899 for column "change" in reports
Definition at line 134 of file Ofin_day.cpp.

void Finance::calc_max_hires ( )

calc_max_hires depend on real staff salary growth in oop1 && Faculty expense in oop2
Definition at line 73 of file Ofin_s3.cpp.
References AC_ACADEMIC_DEPARTMENTS, and PL_FACULTY_SALARY_INCREASES.

void Finance::calc_projected_total_n_percent ( int reCalc = 0 )

[int] reCalc - if this is 1, then it is a re-calculation as oppsite to the first calculation. (default:0)
Definition at line 1514 of file Ofin_day.cpp.
References AC_NET_TUITION_INCOME, and REVENUE_ITEM_COUNT.

double Finance::calc_total_faculty_salary ( )

Definition at line 508 of file Ofin_day.cpp.
Referenced by init_data().

void Finance::calc_total_last_year ( )

called once from init_data()

Definition at line 1818 of file Ofinance.cpp.
References AC_FINANCIAL_AID, AC_GROSS_TUITION_INCOME, AC_NET_TUITION_INCOME, AC_SPONSORED_RESEARCH_REVENUE, and REVENUE_ITEM_COUNT.
Referenced by init_data(), and new_fiscal_year().

void Finance::change_budget ( char changeType,

bool isRevenue,

char index,

float percentChange,

char showMsg = 1

)

called by interface directly example call: change_budget(CONSIDER_NEXT_YEAR, false, AC_ATHLETICS, 10.0f)
<changeType> : type of change = CONSIDER_NEXT_YEAR, ANNOUNCE_NEXT_YEAR, IMPLEMENT_NOW <isRevenue> : is revenue item or expense <index> : index for budget_*_array but not *_policy_array <percentChange> : range from [-100,100] [char] showMsg : whether display message or not (default:1)
Definition at line 1944 of file Ofin_day.cpp.
References ANNOUNCE_NEXT_YEAR, CONSIDER_NEXT_YEAR, P_CONSIDER, P_IMPLEMENT, and P_PROMISE.

void Finance::correct_surplus_deficit ( )

Definition at line 3863 of file Ofinance.cpp.
References AC_ACADEMIC_DEPARTMENTS, AC_FINANCIAL_AID, AC_GROSS_TUITION_INCOME, AC_NET_TUITION_INCOME, AC_STATE_APPROPRIATION, fabs, and PL_SURPLUS_DEFICIT.

void Finance::deinit ( )

Definition at line 1286 of file Ofinance.cpp.

void Finance::disp_report_main ( int refreshFlag,

int dispButton = 1,

char * reportTitle = NULL

)

Display Financial Report
<int> refreshFlag = INFO_REPAINT or INFO_UPDATE [int] dispButton = whether should display buttons or not (0 when called from finance.new_fiscal_year_report()) (default: 1) [char*] reportTitle = report title (Report title)
Definition at line 104 of file ofin_rep.cpp.
References BG_PIC_ID, INFO_REPAINT, REPORT_X1, REPORT_X2, REPORT_Y1, REPORT_Y2, and ZOOM_Y1.

double Finance::get_available_funds ( )

Definition at line 178 of file Ofin_day.cpp.
References AC_BUILDINGS, AC_CAPITAL_RESERVE, AC_ENDOWMENT, AC_LIABILITY_TOTAL, AC_OPERATING_RESERVE, YearReport::asset_array, YearReport::liability_array, and this_year.

FinancePolicy * Finance::get_policy_var ( bool isRevenue,

char index

)

Definition at line 1901 of file Ofin_day.cpp.
References AC_ENDOWMENT_SPENDING, AC_GROSS_TUITION_INCOME, err_here, PL_ENDOWMENT_SPENDING_RATE, and PL_TUITION_RATE_GROWTH.

float Finance::get_research_overhead_rate ( )

Definition at line 4137 of file Ofinance.cpp.
References PL_INDIRECT_COST_RATE.
Referenced by init_data().

void Finance::init ( )

Definition at line 1071 of file Ofinance.cpp.
References FA_HISTORY_YEAR, OPT_MID_WEIGHT, PL_ENDOWMENT_SPENDING_RATE, PL_FINANCIAL_AID, PL_INDIRECT_COST_RATE, PL_TUITION_RATE_GROWTH, PSCH_SD, and REVENUE_POLICY_COUNT.

void Finance::init_data_pre_enroll ( )

All LHS variables of the assignment statments below refer to cells in the first and second tables in the excel file ResAlloc.ex (file_ex) run before enroll_res.init_data() and enroll_main() since it requires, inflation rate, tuition_rate.

Definition at line 1300 of file Ofinance.cpp.

void Finance::new_fiscal_year ( )

Definition at line 60 of file Ofin_new.cpp.
References AC_ENDOWMENT, AC_ENDOWMENT_SPENDING, AC_SPONSORED_RESEARCH_EXPENSE, AC_SPONSORED_RESEARCH_REVENUE, AC_STATE_APPROPRIATION, YearReport::asset_array, calc_total_last_year(), RevenueItemChange::change_budget_year, RevenueItemChange::change_last_year, RevenueItem::direct, expense_array, ExpenseItem::faculty, Department::faculty_array, RevenueItem::indirect, RevenueItemChange::last_month, MODE_YEAR_END_REPORT, optimize_policy_1(), optimize_policy_2(), optimize_policy_3(), ExpenseItem::other, pre_optimization_stage_3(), projected_revenue_array, research_expense_fac_ratio, research_expense_staff_ratio, revenue_array, DynArray::size(), ExpenseItem::staff, RevenueItemChange::this_year, this_year, ExpenseItem::total, RevenueItem::total, and update_projected_arrays_pre_optimization().

void Finance::new_fiscal_year_report ( int refreshFlag )

Definition at line 182 of file Ofin_new.cpp.
References DEFAULT_SPEED, MODE_EVALUATION_LETTER, MODE_YEAR_END_REPORT, REPORT_TYPE_BALANCE, REPORT_TYPE_REVENUE, and REPORT_YEAR_PREV.

void Finance::new_fiscal_year_report ( )

void Finance::new_fiscal_year_report_detect ( )

Definition at line 315 of file Ofin_new.cpp.
References MODE_EVALUATION_LETTER, MODE_YEAR_END_REPORT, REPORT_TYPE_BALANCE, REPORT_TYPE_REVENUE, REPORT_YEAR_PREV, and REPORT_YEAR_THIS.

void Finance::next_day ( )

Definition at line 194 of file Ofin_day.cpp.
References AC_OTHER_OPERATING_INCOME.

void Finance::next_month ( )

bool Finance::optimize_policy_1 ( bool init = false )

This function is for stage 1 optimization of financial policies. See file ResAlloc.Equation for details.

Definition at line 2335 of file Ofinance.cpp.
References OPT_HIGH_WEIGHT, OPT_LOW_WEIGHT, and REVENUE_POLICY_COUNT.
Referenced by new_fiscal_year().

bool Finance::optimize_policy_2 ( )

This function is for stage 2 optimization of financial policies. See file ResAlloc.Equation for details.

Definition at line 3144 of file Ofinance.cpp.
References COST_RISE_POLICY_COUNT.
Referenced by new_fiscal_year().

bool Finance::optimize_policy_3 ( )

Definition at line 395 of file Ofin_s3.cpp.
Referenced by new_fiscal_year().

void Finance::post_init_data ( )

Definition at line 1775 of file Ofinance.cpp.
References next_year, and this_year.

bool Finance::pre_optimization_stage_3 ( bool init = false )

called after departure and just before optimization interface
Definition at line 192 of file Ofin_s3.cpp.
References PL_FACULTY_FTE, and PL_FACULTY_SALARY_INCREASES.
Referenced by new_fiscal_year().

void Finance::process_budget ( )

should be "init_budget"

Definition at line 2096 of file Ofinance.cpp.
References PL_FACULTY_SALARY_INCREASES, and SCN_RAISE_SALARY.

int Finance::read_file ( File * filePtr )

Definition at line 315 of file OGFILE3.CPP.
References File::file_read().

void Finance::report_deinit ( )

Definition at line 210 of file ofin_rep.cpp.
References VBrowse98::deinit(), Button::deinit(), and ButtonGroup::deinit_buttons().

void Finance::report_detect ( int detectButton = 1 )

[int] detectButton = whether should display buttons or not (0 when called from finance.new_fiscal_year_report()) (default: 1)
Definition at line 244 of file ofin_rep.cpp.
References ButtonGroup::button_pressed, Button::detect(), ButtonGroup::detect(), export_fin_rep_case9(), File::file_close(), File::file_create(), NULL, REPORT_TYPE_BALANCE, REPORT_TYPE_DETAIL_REN, REPORT_TYPE_OPTIMIZATION, and REPORT_TYPE_REVENUE.

void Finance::report_paint_button ( int refreshFlag )

Definition at line 361 of file ofin_rep.cpp.
References BUTTON_HEIGHT, BUTTON_WIDTH, BUTTON_Y1, Button::create_text(), INFO_REPAINT, Button::paint(), ButtonGroup::paint(), report_opt, REPORT_OPT_REVENUE, report_type, REPORT_TYPE_BALANCE, REPORT_TYPE_DETAIL_REN, REPORT_TYPE_OPTIMIZATION, REPORT_TYPE_REVENUE, REPORT_X1, REPORT_X2, report_year, and String::str_buf.

void Finance::set_policy_target ( bool isRevenue,

char index

)

Definition at line 170 of file Ofinance.cpp.
References EXPENSE_POLICY_COUNT, FinancePolicy::lower_bound, REVENUE_POLICY_COUNT, and FinancePolicy::upper_bound.

void Finance::update_projected_arrays_post_optimization ( )

update projected_revenue_array *after* optimization; refer to email req13d_if_finance.txt and req13_if_finance.txt
Definition at line 854 of file Ofin_day.cpp.
References REVENUE_ITEM_COUNT.

bool Finance::update_projected_arrays_pre_optimization ( )

called before optimization interface is shown
Definition at line 750 of file Ofin_day.cpp.
References AC_BUILDINGS, AC_OPERATING_RESERVE, and MODE_BANKRUPTCY.
Referenced by new_fiscal_year().

int Finance::write_file ( File * filePtr )

Definition at line 311 of file OGFILE3.CPP.
References File::file_write().

Member Data Documentation

float Finance::academic_support_ratio

Definition at line 437 of file Ofinance.h.

double Finance::athletics_revenue_growth

Definition at line 419 of file Ofinance.h.

double Finance::bank_debt_interest

Definition at line 420 of file Ofinance.h.

double Finance::base_long_term_debt_interest

Definition at line 399 of file Ofinance.h.
Referenced by init_data().

double Finance::base_short_term_debt_interest

Definition at line 398 of file Ofinance.h.
Referenced by init_data().

ExpenseItem Finance::budget_expense_array[EXPENSE_ITEM_COUNT]

Definition at line 352 of file Ofinance.h.
Referenced by init_data().

RevenueItem Finance::budget_revenue_array[REVENUE_ITEM_COUNT]

Definition at line 351 of file Ofinance.h.
Referenced by init_data().

ExpenseItem Finance::budget_total_expense

Definition at line 356 of file Ofinance.h.
Referenced by init_data().

ExpenseItem Finance::budget_total_operating_expense

Definition at line 355 of file Ofinance.h.

RevenueItem Finance::budget_total_revenue

Definition at line 354 of file Ofinance.h.
Referenced by init_data().

YearReport Finance::budget_year

Definition at line 371 of file Ofinance.h.

int Finance::building_life_for_calc_depreciation

Definition at line 423 of file Ofinance.h.

double Finance::construction_cost_growth

Definition at line 412 of file Ofinance.h.

float Finance::cost_limit

Definition at line 459 of file Ofinance.h.

FinancePolicy Finance::cost_rise_policy_array[COST_RISE_POLICY_COUNT]

Definition at line 452 of file Ofinance.h.

char Finance::current_report_mode

Definition at line 464 of file Ofinance.h.

double Finance::debt_fraction_repaid_annually

Definition at line 410 of file Ofinance.h.

int Finance::dl_target_student_intake

Definition at line 386 of file Ofinance.h.

double Finance::endowment_return

Definition at line 416 of file Ofinance.h.

ExpenseItem Finance::expense_array[EXPENSE_ITEM_COUNT]

Definition at line 335 of file Ofinance.h.
Referenced by init_data(), and new_fiscal_year().

FinancePolicy Finance::expense_policy_array[EXPENSE_POLICY_COUNT]

Definition at line 451 of file Ofinance.h.
Referenced by init_data().

double Finance::family_income_growth

Definition at line 411 of file Ofinance.h.

char Finance::fiscal_year_end_month

Definition at line 328 of file Ofinance.h.

char Finance::fiscal_year_start_month

Definition at line 327 of file Ofinance.h.
Referenced by init_data().

double Finance::gifts_growth

Definition at line 418 of file Ofinance.h.

HiringPolicy Finance::hiring_policy_array[MAX_DEPARTMENT]

Definition at line 455 of file Ofinance.h.
Referenced by init_data().

double Finance::inflation_rate

Definition at line 407 of file Ofinance.h.
Referenced by init_data().

HistoryData Finance::inflation_rate_hist

Definition at line 397 of file Ofinance.h.

double Finance::last_month_SR_D

Definition at line 429 of file Ofinance.h.

double Finance::last_month_SR_ID

Definition at line 430 of file Ofinance.h.

YearReport Finance::last_year

Definition at line 371 of file Ofinance.h.
Referenced by init_data().

double Finance::long_term_debt_interest

Definition at line 409 of file Ofinance.h.

int Finance::master_target_student_intake

Definition at line 385 of file Ofinance.h.

int Finance::max_hires

Definition at line 457 of file Ofinance.h.

char Finance::month_left

Definition at line 433 of file Ofinance.h.
Referenced by init_data().

double Finance::net_tuition_history[HISTORY_MONTH_COUNT]

Definition at line 586 of file Ofinance.h.

YearReport Finance::next_year

Definition at line 371 of file Ofinance.h.
Referenced by post_init_data().

int Finance::nontradU_target_student_intake

Definition at line 384 of file Ofinance.h.

double Finance::operating_sub_surplus_history[HISTORY_MONTH_COUNT]

Definition at line 581 of file Ofinance.h.

double Finance::other_expense_growth

Definition at line 421 of file Ofinance.h.

double Finance::other_income_growth

Definition at line 422 of file Ofinance.h.

double Finance::prior_dept_fac_exp

Definition at line 425 of file Ofinance.h.

ExpenseItemChange Finance::projected_expense_array[EXPENSE_ITEM_COUNT]

Definition at line 361 of file Ofinance.h.
Referenced by init_data().

RevenueItemChange Finance::projected_revenue_array[REVENUE_ITEM_COUNT]

Definition at line 360 of file Ofinance.h.
Referenced by init_data(), and