CYCLUS
Loading...
Searching...
No Matches
cyclus::DbInit Class Reference

Detailed Description

DbInit provides an interface for agents to record data to the output db that automatically injects the agent's id and current timestep alongside all recorded data.

The prefix 'AgentState' + [spec] (e.g. MyReactor) is also added to the datum title

Definition at line 14 of file db_init.h.

#include <db_init.h>

Public Member Functions

 DbInit (Agent *m)
 
 DbInit (Agent *m, bool dummy)
 
DatumNewDatum (std::string title)
 

Constructor & Destructor Documentation

◆ DbInit() [1/2]

cyclus::DbInit::DbInit ( Agent * m)

Definition at line 8 of file db_init.cc.

◆ DbInit() [2/2]

cyclus::DbInit::DbInit ( Agent * m,
bool dummy )

Using this constructor prevents the [spec] from being injected into the title.

Definition at line 10 of file db_init.cc.

Member Function Documentation

◆ NewDatum()

Datum * cyclus::DbInit::NewDatum ( std::string title)

Returns a new datum to be used exactly as the Context::NewDatum method.

Users must not add fields to the datum that are automatically injected: 'SimId', 'AgentId', and 'SimTime'.

Definition at line 12 of file db_init.cc.


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