makVrv::DtOsgOptionsTranslator Class Reference

The osg options translator provides utility functions for encoding values into and decoding values out of the osgDB::ReaderWriter::Options options string. More...

List of all members.

Static Public Member Functions
static void	addOption (std::string &output, const std::string &opt)
	Add an option to an option string.
static bool	findOption (const std::string &output, const std::string &opt)
	Search for an option and return if it is found.
static bool	findAndRemoveOption (std::string &optionsToModify, const std::string &opt)
	Search for an option and remove it if it is found.
static void	removeOption (std::string &optionsToModify, const std::string &optionStr)
	Remove An option from an options string.
static void	addOptionValuePair (std::string &output, const std::string &opt, const std::string &value, bool allowMultiple=false)
	Add an option value pair formated name=value to an option string Optionally allow for multiple instances of the option.
static void	addOptionValuePair (std::string &output, const std::string &opt, double value, bool allowMultiple=false)
	Add an option value pair formated name=value to an option string where the value is double floating point number.
static void	addOptionValuePair (std::string &output, const std::string &opt, int value, bool allowMultiple=false)
	Add an option value pair formated name=value to an option string where the value is an signed integer.
static bool	findOptionValuePair (const std::string &output, const std::string &option, std::string &value)
	Find an option and (if found) get the value.
static bool	removeOptionValuePair (std::string &optionsToModify, const std::string &opt, bool removeAllInstances=true)
	Remove an option value pair formated name=value from an option string Optionally removes all instances,.
static void	findAllOptions (const std::string &output, std::multimap< std::string, std::string > &optionStore)
	Find all options in an option string and store them in a multimap.

---

Detailed Description

The osg options translator provides utility functions for encoding values into and decoding values out of the osgDB::ReaderWriter::Options options string.

---

Member Function Documentation

static void makVrv::DtOsgOptionsTranslator::addOption	(	std::string &	output,
		const std::string &	opt
	)		[static]

Add an option to an option string.

This option will only appear once in the string.

static bool makVrv::DtOsgOptionsTranslator::findOption	(	const std::string &	output,
		const std::string &	opt
	)		[static]

Search for an option and return if it is found.

static bool makVrv::DtOsgOptionsTranslator::findAndRemoveOption	(	std::string &	optionsToModify,
		const std::string &	opt
	)		[static]

Search for an option and remove it if it is found.

Returns:

true if the option was found and removed.

static void makVrv::DtOsgOptionsTranslator::removeOption	(	std::string &	optionsToModify,
		const std::string &	optionStr
	)		[static]

Remove An option from an options string.

static void makVrv::DtOsgOptionsTranslator::addOptionValuePair	(	std::string &	output,
		const std::string &	opt,
		const std::string &	value,
		bool	allowMultiple = false
	)		[static]

Add an option value pair formated name=value to an option string Optionally allow for multiple instances of the option.

static void makVrv::DtOsgOptionsTranslator::addOptionValuePair	(	std::string &	output,
		const std::string &	opt,
		double	value,
		bool	allowMultiple = false
	)		[static]

Add an option value pair formated name=value to an option string where the value is double floating point number.

Optionally allow for multiple instances of the option.

static void makVrv::DtOsgOptionsTranslator::addOptionValuePair	(	std::string &	output,
		const std::string &	opt,
		int	value,
		bool	allowMultiple = false
	)		[static]

Add an option value pair formated name=value to an option string where the value is an signed integer.

Optionally allow for multiple instances of the option.

static bool makVrv::DtOsgOptionsTranslator::findOptionValuePair	(	const std::string &	output,
		const std::string &	option,
		std::string &	value
	)		[static]

Find an option and (if found) get the value.

static bool makVrv::DtOsgOptionsTranslator::removeOptionValuePair	(	std::string &	optionsToModify,
		const std::string &	opt,
		bool	removeAllInstances = true
	)		[static]

Remove an option value pair formated name=value from an option string Optionally removes all instances,.

Returns:

true if an option value pair was removed.

static void makVrv::DtOsgOptionsTranslator::findAllOptions	(	const std::string &	output,
		std::multimap< std::string, std::string > &	optionStore
	)		[static]

Find all options in an option string and store them in a multimap.

---

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

• include/vrvOsg/DtOsgOptionsTranslator.h