GitReportModule Class Reference

Module for reporting Git version information at simulation start. More...

#include "GitReportModule.h"

Inheritance diagram for GitReportModule:

Collaboration diagram for GitReportModule:

Public Member Functions
	GitReportModule (const String &name="GitReport")
	Constructor.
virtual Status	init (const Properties &conf, const Properties &props, const Properties &globdat) override
	Initialize the module.
virtual Status	run (const Properties &globdat) override
	Run Git reporting.
virtual void	shutdown (const Properties &globdat) override
	Shutdown the module.

Static Public Member Functions
static Ref< Module >	makeNew (const String &name, const Properties &conf, const Properties &props, const Properties &globdat)
	Factory method for creating new GitReportModule instances.
static void	declare ()
	Register GitReportModule type with ModuleFactory.

Static Public Attributes
Property identifiers
static const char *	TYPE_NAME = "GitReport"
	Module type name.

Protected Member Functions
virtual	~GitReportModule ()
	Protected destructor.

Detailed Description

Prints Git hash and repository status to log files for reproducibility tracking. Requires GIT_HASH to be defined during compilation.

Constructor & Destructor Documentation

GitReportModule()

GitReportModule::GitReportModule ( const String &  name = "GitReport" )

explicit

Parameters

name	Module name

~GitReportModule()

GitReportModule::~GitReportModule ( )

protectedvirtual

Member Function Documentation

declare()

void GitReportModule::declare ( )

static

init()

Module::Status GitReportModule::init ( const Properties &  conf, const Properties &  props, const Properties &  globdat  )

overridevirtual

Parameters

conf	Actually used configuration properties (output)
props	User-specified module properties
globdat	Global data container

Returns

Module status

makeNew()

Ref< Module > GitReportModule::makeNew ( const String &  name, const Properties &  conf, const Properties &  props, const Properties &  globdat  )

static

Parameters

name	Module name
conf	Actually used configuration properties (output)
props	User-specified module properties
globdat	Global data container

Returns

Reference to new GitReportModule instance

run()

Module::Status GitReportModule::run ( const Properties &  globdat )

overridevirtual

Parameters

globdat

Global data container

Returns

Module status

shutdown()

void GitReportModule::shutdown ( const Properties &  globdat )

overridevirtual

Parameters

globdat

Global data container

Member Data Documentation

TYPE_NAME

const char * GitReportModule::TYPE_NAME = "GitReport"

static