---

             

---

uima::util::EnvironmentVariableQueryOnly Class Reference

List of all members.

---

Detailed Description

The class EnvironmentVariableQueryOnly is used to manage environment variables which can be queried only.

The value for this variable cannot be changed.

       foo(void)
       {
          EnvironmentVariableQueryOnly var("TMP");

          if(var.hasValue())
             cout << "TMP directory: " << var.getValue() << endl;
          else
             cout << "No TMP directory defined" << endl;
       }

Public Member Functions
bool	hasValue (void) const
	return TRUE if the environment variable has a value else FALSE
const char *	getValue (void) const
	return the value for the environment variable or NULL if it does not have a value
bool	hasValueEnabled (void) const
	return TRUE if the value for the environment variable is "ON" or "YES" or "TRUE" or "1"
Constructors
	EnvironmentVariableQueryOnly (const char *cpszVar)
	instantiate a new environment variable handler
	~EnvironmentVariableQueryOnly (void)

---

Constructor & Destructor Documentation

uima::util::EnvironmentVariableQueryOnly::EnvironmentVariableQueryOnly (  const char *  cpszVar  )  [inline]

instantiate a new environment variable handler

uima::util::EnvironmentVariableQueryOnly::~EnvironmentVariableQueryOnly (  void   )  [inline]

---

Member Function Documentation

bool uima::util::EnvironmentVariableQueryOnly::hasValue (  void   )  const [inline]

return TRUE if the environment variable has a value else FALSE

const char* uima::util::EnvironmentVariableQueryOnly::getValue (  void   )  const [inline]

return the value for the environment variable or NULL if it does not have a value

bool uima::util::EnvironmentVariableQueryOnly::hasValueEnabled (  void   )  const [inline]

return TRUE if the value for the environment variable is "ON" or "YES" or "TRUE" or "1"

---

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

• envvar.hpp

---