#include <StringHelper.h>

Static Public Member Functions
static kt_bool	FromString (const String &rStringValue, kt_bool &rValue)

static kt_bool	FromString (const String &rStringValue, kt_int16s &rValue)

static kt_bool	FromString (const String &rStringValue, kt_int16u &rValue)

static kt_bool	FromString (const String &rStringValue, kt_int32s &rValue)

static kt_bool	FromString (const String &rStringValue, kt_int32u &rValue)

static kt_bool	FromString (const String &rStringValue, kt_int64s &rValue)

static kt_bool	FromString (const String &rStringValue, kt_int64u &rValue)

static kt_bool	FromString (const String &rStringValue, kt_float &rValue)

static kt_bool	FromString (const String &rStringValue, kt_double &rValue)

static kt_bool	FromString (const String &rStringValue, String &rValue)

template<typename T >
static kt_bool	FromString (const String &rStringValue, Size2< T > &rValue)

template<typename T >
static kt_bool	FromString (const String &rStringValue, Vector2< T > &rValue)

template<typename T >
static kt_bool	FromString (const String &rStringValue, Vector3< T > &rValue)

template<typename T >
static kt_bool	FromString (const String &rStringValue, Vector4< T > &rValue)

static kt_bool	FromString (const String &rStringValue, Quaternion &rValue)

static kt_bool	FromString (const String &rStringValue, Color &rValue)

static kt_bool	FromString (const String &rStringValue, Pose2 &rValue)

static kt_bool	FromString (const String &rStringValue, Pose3 &rValue)

static kt_bool	IsLetter (char ch)

static String	Replace (const String &rSource, const String &rFind, const String &rReplace)

static String	ToLowerCase (const String &rValue)

static String	ToString (const char *value)

static String	ToString (kt_bool value)

static String	ToString (kt_int16s value)

static String	ToString (kt_int16u value)

static String	ToString (kt_int32s value)

static String	ToString (kt_int32u value)

static String	ToString (kt_int64s value)

static String	ToString (kt_int64u value)

static String	ToString (kt_float value)

static String	ToString (kt_double value)

static String	ToString (kt_float value, kt_int32u precision)

static String	ToString (kt_double value, kt_int32u precision)

static String	ToString (const String &rValue)

template<typename T >
static String	ToString (const Size2< T > &rValue)

template<typename T >
static String	ToString (const Vector2< T > &rValue)

template<typename T >
static String	ToString (const Vector3< T > &rValue)

template<typename T >
static String	ToString (const Vector4< T > &rValue)

static String	ToString (const Quaternion &rValue)

static String	ToString (const Color &rValue)

static String	ToString (const Pose2 &rValue)

static String	ToString (const Pose3 &rValue)

static String	ToUpperCase (const String &rValue)

static String	Trim (const String &rValue)

Detailed Description

Class to convert to and from Karto strings

Definition at line 54 of file StringHelper.h.

Member Function Documentation

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		kt_bool &	rValue
	)

static

Converts the given string to a boolean

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 188 of file StringHelper.cpp.

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		kt_int16s &	rValue
	)

static

Converts the given string to a 16-bit signed integer

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 200 of file StringHelper.cpp.

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		kt_int16u &	rValue
	)

static

Converts the given string to a 16-bit unsigned integer

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 213 of file StringHelper.cpp.

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		kt_int32s &	rValue
	)

static

Converts the given string to a 32-bit signed integer

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 226 of file StringHelper.cpp.

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		kt_int32u &	rValue
	)

static

Converts the given string to a 32-bit unsigned integer

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 239 of file StringHelper.cpp.

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		kt_int64s &	rValue
	)

static

Converts the given string to a 64-bit signed integer

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 252 of file StringHelper.cpp.

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		kt_int64u &	rValue
	)

static

Converts the given string to a 64-bit unsigned integer

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 265 of file StringHelper.cpp.

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		kt_float &	rValue
	)

static

Converts the given string to a float

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 278 of file StringHelper.cpp.

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		kt_double &	rValue
	)

static

Converts the given string to a double

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 291 of file StringHelper.cpp.

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		String &	rValue
	)

static

Converts the given String to a String

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 304 of file StringHelper.cpp.

template<typename T >

static kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		Size2< T > &	rValue
	)

inlinestatic

Converts the given String to a Size2<T>

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 301 of file StringHelper.h.

template<typename T >

static kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		Vector2< T > &	rValue
	)

inlinestatic

Converts the given String to a Vector2<T>

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 334 of file StringHelper.h.

template<typename T >

static kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		Vector3< T > &	rValue
	)

inlinestatic

Converts the given String to a Vector3<T>

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 367 of file StringHelper.h.

template<typename T >

static kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		Vector4< T > &	rValue
	)

inlinestatic

Converts the given String to a Vector4<T>

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 416 of file StringHelper.h.

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		Quaternion &	rValue
	)

static

Converts the given String to a Quaternion

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 311 of file StringHelper.cpp.

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		Color &	rValue
	)

static

Converts the given String to a Color

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 340 of file StringHelper.cpp.

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		Pose2 &	rValue
	)

static

Converts the given String to a Pose2

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 369 of file StringHelper.cpp.

kt_bool karto::StringHelper::FromString	(	const String &	rStringValue,
		Pose3 &	rValue
	)

static

Converts the given String to a Pose3

Parameters

rStringValue	string representation of value
rValue	value to set from string

Returns: true if conversion was success, false otherwise

Definition at line 395 of file StringHelper.cpp.

kt_bool karto::StringHelper::IsLetter ( char ch )

static

Checks if given character is a letter

Parameters

ch character

Returns: true if given character is a letter

Definition at line 471 of file StringHelper.cpp.

String karto::StringHelper::Replace	(	const String &	rSource,
		const String &	rFind,
		const String &	rReplace
	)

static

Replace all instances of string pattern in source string with replacement pattern

Parameters

rSource	source string
rFind	string pattern
rReplace	replacement pattern

Returns: replaced string

Definition at line 452 of file StringHelper.cpp.

String karto::StringHelper::ToLowerCase ( const String & rValue )

static

Returns a lowercase version of the given string

Parameters

rValue string

Returns: lowercase version of the given string

Definition at line 476 of file StringHelper.cpp.

String karto::StringHelper::ToString ( const char * value )

static

Converts the given C-string to a string

Parameters

value value to be converted

Returns: string representation of the C-string

Definition at line 32 of file StringHelper.cpp.

String karto::StringHelper::ToString ( kt_bool value )

static

Converts the given boolean to a string

Parameters

value value to be converted

Returns: string representation of the boolean

Definition at line 37 of file StringHelper.cpp.

String karto::StringHelper::ToString ( kt_int16s value )

static

Converts the given 16-bit signed integer to a string

Parameters

value value to be converted

Returns: string representation of the 16-bit signed integer

Definition at line 63 of file StringHelper.cpp.

String karto::StringHelper::ToString ( kt_int16u value )

static

Converts the given 16-bit unsigned integer to a string

Parameters

value value to be converted

Returns: string representation of the 16-bit unsigned integer

Definition at line 55 of file StringHelper.cpp.

String karto::StringHelper::ToString ( kt_int32s value )

static

Converts the given 32-bit signed integer to a string

Parameters

value value to be converted

Returns: string representation of the 32-bit signed integer

Definition at line 82 of file StringHelper.cpp.

String karto::StringHelper::ToString ( kt_int32u value )

static

Converts the given 32-bit unsigned integer to a string

Parameters

value value to be converted

Returns: string representation of the 32-bit unsigned integer

Definition at line 71 of file StringHelper.cpp.

String karto::StringHelper::ToString ( kt_int64s value )

static

Converts the given 64-bit signed integer to a string

Parameters

value value to be converted

Returns: string representation of the 64-bit signed integer

Definition at line 101 of file StringHelper.cpp.

String karto::StringHelper::ToString ( kt_int64u value )

static

Converts the given 64-bit unsigned integer to a string

Parameters

value value to be converted

Returns: string representation of the 64-bit unsigned integer

Definition at line 93 of file StringHelper.cpp.

String karto::StringHelper::ToString ( kt_float value )

static

Converts the given float to a string

Parameters

value value to be converted

Returns: string representation of the float

Definition at line 119 of file StringHelper.cpp.

String karto::StringHelper::ToString ( kt_double value )

static

Converts the given double to a string

Parameters

value value to be converted

Returns: string representation of the double

Definition at line 130 of file StringHelper.cpp.

String karto::StringHelper::ToString	(	kt_float	value,
		kt_int32u	precision
	)

static

Converts the given float to a string with the given precision

Parameters

value	value to be converted
precision	precision

Returns: string representation of the float

Definition at line 141 of file StringHelper.cpp.

String karto::StringHelper::ToString	(	kt_double	value,
		kt_int32u	precision
	)

static

Converts the given double to a string with the given precision

Parameters

value	value to be converted
precision	precision

Returns: string representation of the double

Definition at line 152 of file StringHelper.cpp.

karto::String karto::StringHelper::ToString ( const String & rValue )

static

Copies the string argument

Parameters

rValue string value

Returns: copy of the string argument

Definition at line 163 of file StringHelper.cpp.

karto::String karto::StringHelper::ToString ( const Quaternion & rValue )

static

Converts the given quaternion to a string

Parameters

rValue value to be converted

Returns: string representation of the quaternion

Definition at line 168 of file StringHelper.cpp.

karto::String karto::StringHelper::ToString ( const Color & rValue )

static

Converts the given color to a string

Parameters

rValue value to be converted

Returns: string representation of the color

Definition at line 173 of file StringHelper.cpp.

karto::String karto::StringHelper::ToString ( const Pose2 & rValue )

static

Converts the given pose to a string

Parameters

rValue value to be converted

Returns: string representation of the pose

Definition at line 178 of file StringHelper.cpp.

karto::String karto::StringHelper::ToString ( const Pose3 & rValue )

static

Converts the given pose to a string

Parameters

rValue value to be converted

Returns: string representation of the pose

Definition at line 183 of file StringHelper.cpp.

String karto::StringHelper::ToUpperCase ( const String & rValue )

static

Returns a uppercase version of the given string

Parameters

rValue string

Returns: uppercase version of the given string

Definition at line 486 of file StringHelper.cpp.

String karto::StringHelper::Trim ( const String & rValue )

static

Returns a trimmed version of the given string

Parameters

rValue string

Returns: trimmed version of the given string

Definition at line 430 of file StringHelper.cpp.

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

Static Public Member Functions

Detailed Description

Member Function Documentation