Construct version 5.4.3
An agent based modeling framework
Output_Messages Struct Reference

Outputs the contents of the message queue to a json file. More...

Inheritance diagram for Output_Messages:
Collaboration diagram for Output_Messages:

Public Member Functions

 ~Output_Messages (void)
 
void process (unsigned int t) override
 Called after each model has executed. More...
 
 Output_Messages (const dynet::ParameterMap &params, Construct &construct)
 Constructor for the "mesages" type output. More...
 
- Public Member Functions inherited from Output
 Output (const dynet::ParameterMap &params, Construct &construct)
 Sets up the output to only record during certain timeperiods. Allows the usage of should_process.
 
 Output ()
 Creates an output that does not depend on time. Output::should_process should not be called when using this constructor.
 
bool should_process (int t)
 Given the current time index, returns true if the current time period is flagged to be processed.
 
virtual ~Output ()
 Virtual Deconstructor. More...
 
virtual std::vector< int > get_output_timeperiods (const dynet::ParameterMap &params, Construct &construct)
 Creates a vector of indexes that indicate in which timeperiod output should be processed. The parameter "timeperiods" in params controls this value. "all" will fill the entire the array with -1 followed by all timeperiods. "last" will set it to only contain the last time index. "initial" will set it to only contain -1. If it is none of these, the param is tokenized with a comma delimiter and converts the tokens to integers. Returned vector should always be ordered.
 
virtual void process (unsigned int t)=0
 Called after each model has executed. More...
 

Public Attributes

InteractionMessageQueuequeue
 
std::ofstream _output_file
 

Detailed Description

Outputs the contents of the message queue to a json file.

Constructor & Destructor Documentation

◆ ~Output_Messages()

Output_Messages::~Output_Messages ( void  )
inline

summary>

◆ Output_Messages()

Output_Messages::Output_Messages ( const dynet::ParameterMap params,
Construct construct 
)
inline

Constructor for the "mesages" type output.

Exception Safety

If the parameters "output file" is not in the ParameterMap, a dynet::could_not_find_parameter is thrown. If the "output file" parameter does not have extension ".json", a dynet::wrong_file_extension is thrown. If this file can not be opened for writing, a dynet::could_not_open_file is thrown.

Here is the call graph for this function:

Member Function Documentation

◆ process()

void Output_Messages::process ( unsigned int  t)
inlineoverridevirtual

Called after each model has executed.

Parameters
tThe current time period.

Implements Output.

Here is the call graph for this function:

Member Data Documentation

◆ queue

InteractionMessageQueue* Output_Messages::queue

summary>