Stock_event Struct Reference

The data structure of an event that will be applied to the stocks. More...

#include "events.h"

Collaboration diagram for Stock_event:

Public Member Functions
bool	operator== (const Stock_event &other) const
	Overload the == operator to compare two Stock_event.

Public Attributes
unsigned int	category
unsigned int	duration
	Number of rounds the event will last.
unsigned int	event_id
	The id of the event.
std::map< stock_modifiers, double >	modifiers
	Stores the stock_modifiers that the event applies.
std::vector< unsigned int >	mutually_exclusive_events
	A list of event_ids that this event is mutually exclusive with.
unsigned int	probability_permille
	0 to 1000, so 114 means 11.4%
std::string	text
	The text that will be displayed to the player.
event_type	type_of_event
	The type of event: Apply to all stocks, in one category or randomly?

Friends
std::ostream &	operator<< (std::ostream &outputstream, const Stock_event &event)
	Serialize the event as std::ostream object.
std::istream &	operator>> (std::istream &inputstream, Stock_event &event)
	Deserialize the event from a std::istream object.

Detailed Description

The data structure of an event that will be applied to the stocks.

Note

For more information about how to write your own events, visit the documentation of the events.h file.

Definition at line 104 of file events.h.

Member Function Documentation

operator==()

bool Stock_event::operator== ( const Stock_event & other ) const

inline

Overload the == operator to compare two Stock_event.

Definition at line 135 of file events.h.

                                                         {
            return event_id == other.event_id && text == other.text &&
                   probability_permille == other.probability_permille &&
                   type_of_event == other.type_of_event && category == other.category &&
                   modifiers == other.modifiers;
        }

References category, event_id, modifiers, probability_permille, text, and type_of_event.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & outputstream, const Stock_event & event )

friend

Serialize the event as std::ostream object.

Parameters

outputstream	The std::ostream object to write the data.
event	The event object to get the data from.

Returns

A std:ostream object contains all the data of the event.

// Create a event object by calling the constructor
Stock_event event;
// Print the data of the event.
std::cout << event << std::endl;

Definition at line 154 of file events.h.

                                                                  {
            outputstream << event.event_id << " ";
            for (unsigned int i = 0; i < event.mutually_exclusive_events.size(); i++) {
                outputstream << event.mutually_exclusive_events[i] << " ";
            }
            outputstream << ";" << event.text << ";" << event.duration << " "
                         << event.probability_permille << " " << event.type_of_event
                         << " " << event.category << " ";
            for (const auto & modifier : event.modifiers) {
                outputstream << modifier.second << " ";
            }
            return outputstream;
        }

operator>>

std::istream & operator>> ( std::istream & inputstream, Stock_event & event )

friend

Deserialize the event from a std::istream object.

Parameters

inputstream	The std::istream object to read the data.
event	The event object to store the data.

Returns

A std:istream object contains all the data of the event.

Definition at line 175 of file events.h.

                                                           {
            // fix the bug that mutually_exclusive_events is not read correctly
            inputstream >> event.event_id;
            std::string _mutually_exclusive_events;
            std::getline(inputstream, _mutually_exclusive_events, ';');
            std::istringstream mutually_exclusive_events_stream(
                _mutually_exclusive_events);
            unsigned int temp_id;
            while (mutually_exclusive_events_stream >> temp_id) {
                event.mutually_exclusive_events.emplace_back(temp_id);
            }
            std::getline(inputstream, event.text, ';');
            unsigned int temp_type;
            inputstream >> event.duration >> event.probability_permille >> temp_type >>
                event.category;
            event.type_of_event = static_cast<event_type>(temp_type);
            inputstream >> event.modifiers[standard_deviation] >>
                event.modifiers[mean] >> event.modifiers[lower_limit] >>
                event.modifiers[upper_limit];
            return inputstream;
        }

Member Data Documentation

category

unsigned int Stock_event::category

Definition at line 129 of file events.h.

Referenced by operator==(), and Stock::setup_STOCK_SPLIT_EVENT().

duration

unsigned int Stock_event::duration

Number of rounds the event will last.

If the event has duration <= 0 then it will be removed.

Definition at line 120 of file events.h.

event_id

unsigned int Stock_event::event_id

The id of the event.

This is still required for checking, despite the fact that we are using a vector.

Definition at line 110 of file events.h.

Referenced by Stock::can_add_event(), and operator==().

modifiers

std::map<stock_modifiers, double> Stock_event::modifiers

Stores the stock_modifiers that the event applies.

Definition at line 132 of file events.h.

Referenced by operator==().

mutually_exclusive_events

std::vector<unsigned int> Stock_event::mutually_exclusive_events

A list of event_ids that this event is mutually exclusive with.

Definition at line 113 of file events.h.

probability_permille

unsigned int Stock_event::probability_permille

0 to 1000, so 114 means 11.4%

Definition at line 123 of file events.h.

Referenced by operator==().

text

std::string Stock_event::text

The text that will be displayed to the player.

Definition at line 116 of file events.h.

Referenced by new_events_next_round(), operator==(), and Stock::setup_STOCK_SPLIT_EVENT().

type_of_event

event_type Stock_event::type_of_event

The type of event: Apply to all stocks, in one category or randomly?

Definition at line 127 of file events.h.

Referenced by operator==().

---

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

• include/events.h