FinanceSim 0.1.0
Financial Simulation Library
Loading...
Searching...
No Matches
financesim::ExpenseEvent Class Reference

Event emitted when an expense occurs. More...

#include <event.hpp>

Inheritance diagram for financesim::ExpenseEvent:
[legend]
Collaboration diagram for financesim::ExpenseEvent:
[legend]

Public Member Functions

 ExpenseEvent (SimTime timestamp, std::string source_id, double amount, std::string category, std::string target_account="")
 
const char * type_name () const override
 Returns the type name of this event (for debugging/logging)
 
double amount () const
 
const std::string & category () const
 
const std::string & target_account () const
 
- Public Member Functions inherited from financesim::Event
virtual ~Event ()=default
 
SimTime timestamp () const
 Time at which this event was generated.
 
const std::string & source_id () const
 Source model ID that generated this event.
 

Private Attributes

double amount_
 
std::string category_
 
std::string target_account_
 

Additional Inherited Members

- Protected Member Functions inherited from financesim::Event
 Event (SimTime timestamp, std::string source_id)
 

Detailed Description

Event emitted when an expense occurs.

Definition at line 62 of file event.hpp.

Constructor & Destructor Documentation

◆ ExpenseEvent()

financesim::ExpenseEvent::ExpenseEvent ( SimTime  timestamp,
std::string  source_id,
double  amount,
std::string  category,
std::string  target_account = "" 
)
inline

Definition at line 64 of file event.hpp.

Member Function Documentation

◆ amount()

double financesim::ExpenseEvent::amount ( ) const
inline

Definition at line 74 of file event.hpp.

References amount_.

Referenced by PYBIND11_MODULE().

Here is the caller graph for this function:

◆ category()

const std::string & financesim::ExpenseEvent::category ( ) const
inline

Definition at line 75 of file event.hpp.

References category_.

Referenced by PYBIND11_MODULE().

Here is the caller graph for this function:

◆ target_account()

const std::string & financesim::ExpenseEvent::target_account ( ) const
inline

Definition at line 76 of file event.hpp.

References target_account_.

Referenced by PYBIND11_MODULE().

Here is the caller graph for this function:

◆ type_name()

const char * financesim::ExpenseEvent::type_name ( ) const
inlineoverridevirtual

Returns the type name of this event (for debugging/logging)

Implements financesim::Event.

Definition at line 72 of file event.hpp.

Member Data Documentation

◆ amount_

double financesim::ExpenseEvent::amount_
private

Definition at line 79 of file event.hpp.

Referenced by amount().

◆ category_

std::string financesim::ExpenseEvent::category_
private

Definition at line 80 of file event.hpp.

Referenced by category().

◆ target_account_

std::string financesim::ExpenseEvent::target_account_
private

Definition at line 81 of file event.hpp.

Referenced by target_account().


The documentation for this class was generated from the following file: