WsfSystemLog Class Reference

#include <WsfSystemLog.hpp>

Public Member Functions
	WsfSystemLog ()
	~WsfSystemLog ()
bool	LoggingActive ()
bool	ProcessInput (UtInput &aInput)
bool	OpenLogFile (const std::string &aFileName)
void	WriteLogEntry (const std::string &aLogEntry)
void	WriteOutputLogEntry (const std::string &aOutputFileType, const std::string &aOutputFilePath)

Static Public Member Functions
static void	DisableDefaultLogFile ()
	Does not create a log file by default. Must be called prior to WsfApplication creation.

Detailed Description

A class for maintaining a log of system-related information. This is typically used to maintain an audit trail of files that were used in the simulation.

Constructor & Destructor Documentation

WsfSystemLog()

WsfSystemLog::WsfSystemLog

(

)

~WsfSystemLog()

WsfSystemLog::~WsfSystemLog

(

)

Member Function Documentation

DisableDefaultLogFile()

void WsfSystemLog::DisableDefaultLogFile ( )

static

Does not create a log file by default. Must be called prior to WsfApplication creation.

LoggingActive()

bool WsfSystemLog::LoggingActive

(

)

Returns 'true' if logging is active (i.e.: The log file is open). This can be used by callers to avoid (the potentially expensive) formatting a log file message when no logging is being performed.

Referenced by WriteLogEntry().

OpenLogFile()

bool WsfSystemLog::OpenLogFile

(

const std::string &

aFileName

)

Referenced by ProcessInput().

ProcessInput()

bool WsfSystemLog::ProcessInput

(

UtInput &

aInput

)

References wsf::version::GetString(), OpenLogFile(), and WriteLogEntry().

WriteLogEntry()

void WsfSystemLog::WriteLogEntry

(

const std::string &

aLogEntry

)

References LoggingActive().

Referenced by wsf::TerrainInterface::AddBathymetry(), wsf::TerrainInterface::AddDtedDirectory(), wsf::TerrainInterface::AddGeotiffDirectory(), wsf::TerrainInterface::AddRawDtedDirectory(), WsfScenario::FileOpenCallback(), WsfSOSM_Interface::FileReferenced(), wsf::TerrainInterface::LoadCME_File(), WsfTSPI_Mover::OpenFile(), WsfAirToAirLaunchComputer::ProcessInput(), WsfBallisticMissileLaunchComputer::ProcessInput(), WsfSOSM_Interface::ProcessInput(), ProcessInput(), WsfALARM_AntennaPattern::ALARM_Data::ReadPattern(), WsfVariableBase::ResolveReference(), WsfStandardApplication::RunEventLoop(), wsf::TerrainInterface::SetFloatGridDirectory(), wsf::TerrainInterface::SetFloatGridFile(), and WriteOutputLogEntry().

WriteOutputLogEntry()

void WsfSystemLog::WriteOutputLogEntry	(	const std::string &	aOutputFileType,
		const std::string &	aOutputFilePath )

References WriteLogEntry().

Referenced by WsfEventPipeInterface::AddedToSimulation(), and wsf::event::output::SimulationExtension::OpenFile().

---

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

• WsfSystemLog.hpp
• WsfSystemLog.cpp