Struct RunLog

Struct Documentation

struct flamegpu::RunLog

A collection of LogFrame’s related to a single model run The data available depends on the LoggingConfig used at runtime

Public Functions

inline RunLog()

Constructs an empty RunLog

inline RunLog(const LogFrame &_exit, const std::list<LogFrame> &_step)

Constructs a RunLog from existing data frames

Parameters
  • _exit – Exit LogFrame

  • _step – Ordered list of step LogFrames

inline const LogFrame &getExitLog() const

Return the exit LogFrame

Returns

The logging information collected after completion of the model run

inline const std::list<LogFrame> &getStepLog() const

Return the ordered list of step LogFrames

See

getStepLogFrequency()

Note

If logging frequency was changed in the StepLoggingConfig, there may be less than 1 LogFrame per step.

Returns

The logging information collected after each model step

inline uint64_t getRandomSeed() const

Returns the random seed used for this run

inline unsigned int getStepLogFrequency() const

Returns the frequency that steps were logged

Note

This value is configured via StepLoggingConfig::setFrequency()

Friends

friend class CUDASimulation