OW_NAMESPACE::ConfigFile Namespace Reference

Classes
struct	ItemData
Typedefs
typedef Array< ItemData >	ItemDataArray
typedef SortedVectorMap< String, ItemDataArray >	ConfigMap
typedef Array< ItemData >	ItemDataArray
typedef SortedVectorMap< String, ItemDataArray >	ConfigMap
Enumerations
enum	EOverwritePreviousFlag { E_PRESERVE_PREVIOUS, E_OVERWRITE_PREVIOUS }
Functions
void	loadConfigFile (const String &filename, ConfigMap &rval)
	Loads a config file and stores the options in rval.
String	getConfigItem (const ConfigMap &configItems, const String &itemName, const String &defRetVal=String())
	Retrieve itemName item from configItems.
StringArray	getMultiConfigItem (const ConfigMap &configItems, const String &itemName, const StringArray &defRetVal=StringArray(), const char *tokenizeSeparator=0)
	Retrieve itemName values from configItems.
void	setConfigItem (ConfigMap &configItems, const String &itemName, const String &value, EOverwritePreviousFlag overwritePrevious=E_OVERWRITE_PREVIOUS)
	Sets itemName to value in configItems.

---

Typedef Documentation

typedef SortedVectorMap<String, ItemDataArray> OW_NAMESPACE::ConfigFile::ConfigMap

Definition at line 62 of file OW_ConfigFile.hpp.

typedef SortedVectorMap<String, ItemDataArray> OW_NAMESPACE::ConfigFile::ConfigMap

Definition at line 82 of file OW_CommonFwd.hpp.

typedef Array<ItemData> OW_NAMESPACE::ConfigFile::ItemDataArray

Definition at line 60 of file OW_ConfigFile.hpp.

typedef Array<ItemData> OW_NAMESPACE::ConfigFile::ItemDataArray

Definition at line 80 of file OW_CommonFwd.hpp.

---

Enumeration Type Documentation

enum OW_NAMESPACE::ConfigFile::EOverwritePreviousFlag

Enumerator: E_PRESERVE_PREVIOUS  E_OVERWRITE_PREVIOUS  Definition at line 84 of file OW_ConfigFile.hpp.

---

Function Documentation

String OW_NAMESPACE::ConfigFile::getConfigItem (  const ConfigMap &  configItems, const String &  itemName, const String &  defRetVal = String() )

Retrieve itemName item from configItems. If it's not present, defRetVal will be returned. If the item has multiple values, only the last value will be returned. Definition at line 96 of file OW_ConfigFile.cpp. References OW_NAMESPACE::SortedVectorMap< Key, T, Compare >::end(), OW_NAMESPACE::SortedVectorMap< Key, T, Compare >::find(), and i. Referenced by OW_NAMESPACE::ProviderAgentProviderEnvironment::getConfigItem(), OW_NAMESPACE::ProviderAgentEnvironment::getConfigItem(), OW_NAMESPACE::EmbeddedCIMOMEnvironment::getConfigItem(), and OW_NAMESPACE::CIMOMEnvironment::getConfigItem().

StringArray OW_NAMESPACE::ConfigFile::getMultiConfigItem (  const ConfigMap &  configItems, const String &  itemName, const StringArray &  defRetVal = StringArray(), const char *  tokenizeSeparator = 0 )

Retrieve itemName values from configItems. If it's not present, defRetVal will be returned. Parameters: tokenizeSeparator  If non-null, then each item will be tokenized using the specified separator chars and returned as separate items. Definition at line 111 of file OW_ConfigFile.cpp. References OW_NAMESPACE::Array< T >::end(), OW_NAMESPACE::SortedVectorMap< Key, T, Compare >::end(), OW_NAMESPACE::SortedVectorMap< Key, T, Compare >::find(), i, OW_NAMESPACE::Array< T >::insert(), and OW_NAMESPACE::Array< T >::push_back(). Referenced by OW_NAMESPACE::EmbeddedCIMOMEnvironment::_loadConfigItemsFromFile(), OW_NAMESPACE::CIMOMEnvironment::_loadConfigItemsFromFile(), OW_NAMESPACE::ProviderAgentProviderEnvironment::getMultiConfigItem(), OW_NAMESPACE::ProviderAgentEnvironment::getMultiConfigItem(), OW_NAMESPACE::EmbeddedCIMOMEnvironment::getMultiConfigItem(), and OW_NAMESPACE::CIMOMEnvironment::getMultiConfigItem().

void OW_NAMESPACE::ConfigFile::loadConfigFile (  const String &  filename, ConfigMap &  rval )

Loads a config file and stores the options in rval. Items which already exist in rval will not be overwritten. Exceptions: ConfigException  if the file doesn't exist or is malformed Definition at line 49 of file OW_ConfigFile.cpp. References OW_NAMESPACE::String::c_str(), OW_NAMESPACE::String::empty(), OW_NAMESPACE::String::getLine(), OW_NAMESPACE::String::indexOf(), OW_NAMESPACE::String::length(), OW_NAMESPACE::String::npos, OW_THROW, OW_NAMESPACE::String::substring(), and OW_NAMESPACE::String::trim(). Referenced by OW_NAMESPACE::EmbeddedCIMOMEnvironment::_loadConfigItemsFromFile(), and OW_NAMESPACE::CIMOMEnvironment::_loadConfigItemsFromFile().

void OW_NAMESPACE::ConfigFile::setConfigItem (  ConfigMap &  configItems, const String &  itemName, const String &  value, EOverwritePreviousFlag  overwritePrevious = E_OVERWRITE_PREVIOUS )

Sets itemName to value in configItems. Parameters: overwritePrevious  E_PRESERVE_PREVIOUS - If itemName already exists in configItems, will not be changed. E_OVERWRITE_PREVIOUS - If itemName already exists, it's value will be set to value. Definition at line 140 of file OW_ConfigFile.cpp. References OW_NAMESPACE::SortedVectorMap< Key, T, Compare >::end(), and OW_NAMESPACE::SortedVectorMap< Key, T, Compare >::find(). Referenced by OW_NAMESPACE::ProviderAgentEnvironment::setConfigItem(), OW_NAMESPACE::EmbeddedCIMOMEnvironment::setConfigItem(), and OW_NAMESPACE::CIMOMEnvironment::setConfigItem().

---