Class AgentLoggingConfig

• Defined in File AgentLoggingConfig.h

Class Documentation

class AgentLoggingConfig

Interface to the data structure for controlling how a specific agent-state’s data is logged

Public Functions

inline void logCount()

Log the number of agents in this specific agent state

template<typename T>
void logMean(const std::string &variable_name)

Mark the mean of the named agent variable to be logged

Parameters:

variable_name – Name of the agent variable to have it’s mean logged

Template Parameters:

T – The type of the named variable

Throws:

• exception::InvalidAgentVar – If the agent var was not found inside the specified agent

• exception::InvalidArgument – If the agent var’s mean has already been marked for logging

template<typename T>
void logStandardDev(const std::string &variable_name)

Mark the standard deviation of the named agent variable to be logged

Parameters:

variable_name – Name of the agent variable to have it’s standard deviation logged

Template Parameters:

T – The type of the named variable

Throws:

• exception::InvalidAgentVar – If the agent var was not found inside the specified agent

• exception::InvalidArgument – If the agent var’s standard deviation has already been marked for logging

template<typename T>
void logMin(const std::string &variable_name)

Mark the min of the named agent variable to be logged

Parameters:

variable_name – Name of the agent variable to have it’s min logged

Template Parameters:

T – The type of the named variable

Throws:

• exception::InvalidAgentVar – If the agent var was not found inside the specified agent

• exception::InvalidArgument – If the agent var’s min has already been marked for logging

template<typename T>
void logMax(const std::string &variable_name)

Mark the max of the named agent variable to be logged

Parameters:

variable_name – Name of the agent variable to have it’s max logged

Template Parameters:

T – The type of the named variable

Throws:

• exception::InvalidAgentVar – If the agent var was not found inside the specified agent

• exception::InvalidArgument – If the agent var’s max has already been marked for logging

template<typename T>
void logSum(const std::string &variable_name)

Mark the sum of the named agent variable to be logged

Parameters:

variable_name – Name of the agent variable to have it’s sum logged

Template Parameters:

T – The type of the named variable

Throws:

• exception::InvalidAgentVar – If the agent var was not found inside the specified agent

• exception::InvalidArgument – If the agent var’s sum has already been marked for logging