ArStringInfoGroup Class Reference

This class takes callbacks from different classes that want this string information and then lets you just add the information here instead of to each individual class. More...

#include <ArStringInfoGroup.h>

Public Member Functions
void	addAddStringCallback (ArFunctor3< const char *, ArTypes::UByte2, ArFunctor2< char *, ArTypes::UByte2 > *> *functor, ArListPos::Pos position=ArListPos::LAST)
	This is the function to add a callback to be called by addString.
bool	addString (const char *name, ArTypes::UByte2 maxLen, ArFunctor2< char *, ArTypes::UByte2 > *functor)
	Adds a string to the list in the raw format. More...
bool	addStringBool (const char *name, ArTypes::UByte2 maxLen, ArRetFunctor< bool > *functor, const char *format="%s")
	Adds a bool to the list in the helped way.
bool	addStringDouble (const char *name, ArTypes::UByte2 maxLen, ArRetFunctor< double > *functor, const char *format="%g")
	Adds a double to the list in the helped way.
bool	addStringInt (const char *name, ArTypes::UByte2 maxLen, ArRetFunctor< int > *functor, const char *format="%d")
	Adds an int to the list in the helped way.
bool	addStringLong (const char *name, ArTypes::UByte2 maxLen, ArRetFunctor< long > *functor, const char *format="%ld")
	Adds an int to the list in the helped way.
bool	addStringString (const char *name, ArTypes::UByte2 maxLen, ArRetFunctor< const char *> *functor, const char *format="%s")
	Adds a string to the list in the helped way.
bool	addStringUnsignedLong (const char *name, ArTypes::UByte2 maxLen, ArRetFunctor< unsigned long > *functor, const char *format="%lu")
	Adds an int to the list in the helped way.
	ArStringInfoGroup ()
	Constructor.
virtual	~ArStringInfoGroup ()
	Destructor.

Protected Attributes
std::set< std::string, ArStrCaseCmpOp >	myAddedStrings
std::list< ArFunctor3< const char *, ArTypes::UByte2, ArFunctor2< char *, ArTypes::UByte2 > * > * >	myAddStringCBList
ArMutex	myDataMutex

Detailed Description

This class takes callbacks from different classes that want this string information and then lets you just add the information here instead of to each individual class.

Member Function Documentation

addString()

bool ArStringInfoGroup::addString	(	const char *	name,
		ArTypes::UByte2	maxLength,
		ArFunctor2< char *, ArTypes::UByte2 > *	functor
	)

Adds a string to the list in the raw format.

Note

It is recommended that you avoid characters in a string name or value which may have special meaning in contexts like ArConfig files, such as '#', ';', tabs and newlines.

---

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

• ArStringInfoGroup.h
• ArStringInfoGroup.cpp