AuxPort::StringPair Class Reference

This class allows you to create string pair objects. More...

#include <AuxStringPair.h>

Inheritance diagram for AuxPort::StringPair:

Public Member Functions
	StringPair ()=default
	Creates an empty StringPair object.
	StringPair (const StringPair &stringPair)=default
	Creates a StringPair object initialized with the Passed StringPair Object.
	StringPair (const std::string &key, const std::string &value)
	Creates a StringPair object initialized with a std::string key-value pair.
	StringPair (const String &key, const String &value)
	Creates a StringPair object initialized with a std::string key-value pair.
	StringPair (const char *key, const char *value)
	Creates a StringPair object initialized with a char* key-value pair.
	~StringPair ()=default
	Safely Deallocates data members when object goes out of scope.
AuxPort::String	key () const
	Returns reference to the internal key.
AuxPort::String	value () const
	Returns reference to the internal value.
void	setKey (const AuxPort::String &key)
	Updates the Key.
void	setValue (const AuxPort::String &value)
	Updates the Value.
void	Log () override
	Logs the StringPair object.

Friends
std::ostream &	operator<< (std::ostream &out, const StringPair &sPair)
	Overloads ostream << operator to allow printing of StringPair object directly.

Additional Inherited Members
Protected Member Functions inherited from AuxPort::ILog
void	setColour (const ColourType &colourType)
	This function allows you to set text colour for the text to be printed onto the console.

Detailed Description

This class allows you to create string pair objects.

For Example

AuxPort::StringPair pair("key","value"); 

Definition at line 54 of file AuxStringPair.h.

Constructor & Destructor Documentation

StringPair() [1/3]

AuxPort::StringPair::StringPair	(	const std::string &	key,
		const std::string &	value )

Creates a StringPair object initialized with a std::string key-value pair.

Definition at line 40 of file AuxStringPair.cpp.

StringPair() [2/3]

AuxPort::StringPair::StringPair	(	const String &	key,
		const String &	value )

Creates a StringPair object initialized with a std::string key-value pair.

Definition at line 46 of file AuxStringPair.cpp.

StringPair() [3/3]

AuxPort::StringPair::StringPair	(	const char *	key,
		const char *	value )

Creates a StringPair object initialized with a char* key-value pair.

Definition at line 53 of file AuxStringPair.cpp.

Member Function Documentation

key()

AuxPort::String AuxPort::StringPair::key

(

)

const

Returns reference to the internal key.

Definition at line 66 of file AuxStringPair.cpp.

Log()

void AuxPort::StringPair::Log ( )

overridevirtual

Logs the StringPair object.

Reimplemented from AuxPort::ILog.

Definition at line 92 of file AuxStringPair.cpp.

setKey()

void AuxPort::StringPair::setKey

(

const AuxPort::String &

key

)

Updates the Key.

Definition at line 76 of file AuxStringPair.cpp.

setValue()

void AuxPort::StringPair::setValue

(

const AuxPort::String &

value

)

Updates the Value.

Definition at line 81 of file AuxStringPair.cpp.

value()

AuxPort::String AuxPort::StringPair::value

(

)

const

Returns reference to the internal value.

Definition at line 71 of file AuxStringPair.cpp.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & out, const StringPair & sPair )

friend

Overloads ostream << operator to allow printing of StringPair object directly.

Definition at line 86 of file AuxStringPair.cpp.

---

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

• C:/ROOT/AuxPort/AuxPort_Master/master/AuxPort/Core/String/AuxStringPair.h
• C:/ROOT/AuxPort/AuxPort_Master/master/AuxPort/Core/String/AuxStringPair.cpp