makVrv::DtEnvironmentVariables Class Reference

Public Member Functions
	DtEnvironmentVariables (DtDe &de)
virtual bool	isDefined (DtEnvironmentVariableEnumeration enumValue)
virtual bool	getValue (DtEnvironmentVariableEnumeration enumValue, std::string &value)
virtual void	initializeCachedEnvironmentVariables ()

Protected Member Functions
virtual void	initializeCachedEnvironmentVariable (DtEnvironmentVariableEnumeration, const std::string &)

Protected Attributes
std::map < DtEnvironmentVariableEnumeration, std::string >	myCachedEnvironmentVariableValues
std::shared_timed_mutex	myMutex

Constructor & Destructor Documentation

makVrv::DtEnvironmentVariables::DtEnvironmentVariables

(

DtDe &

de

)

Member Function Documentation

virtual bool makVrv::DtEnvironmentVariables::isDefined ( DtEnvironmentVariableEnumeration  enumValue )

virtual

Returns a boolean indicating whether the environment variable corresponding to the provided enumeration value is defined.

virtual bool makVrv::DtEnvironmentVariables::getValue ( DtEnvironmentVariableEnumeration  enumValue, std::string &  value  )

virtual

Returns the string value of the environment variable corresponding to the provided enumeration value.

virtual void makVrv::DtEnvironmentVariables::initializeCachedEnvironmentVariables ( )

virtual

This is called when the the DtDe is created and populates the myCachedEnvironmentVariableValues map. Environment variables needed at runtime should be looked up here and is made available through the isDefined and getValue APIs.

virtual void makVrv::DtEnvironmentVariables::initializeCachedEnvironmentVariable ( DtEnvironmentVariableEnumeration  , const std::string &    )

protectedvirtual

Member Data Documentation

std::map<DtEnvironmentVariableEnumeration, std::string> makVrv::DtEnvironmentVariables::myCachedEnvironmentVariableValues

protected

std::shared_timed_mutex makVrv::DtEnvironmentVariables::myMutex

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvUtil/DtEnvironmentVariables.h