Eight-bit string (ISO/IEC-8859-1 or UTF-8 string) More...

#include <String.h>

Inheritance diagram for pcl::IsoString:

Public Types
using	allocator = string_base::allocator

using	block_allocator = string_base::block_allocator

using	c_string = string_base::c_string

using	c_ustring = ustring_base::c_string

using	char_traits = string_base::char_traits

using	char_type = string_base::char_type

using	const_c_string = string_base::const_c_string

using	const_c_ustring = ustring_base::const_c_string

using	const_item_type = string_base::const_item_type

using	const_iterator = string_base::const_iterator

using	const_reverse_iterator = string_base::const_reverse_iterator

using	const_uchar_iterator = ustring_base::const_iterator

using	container_type = string_base::container_type

using	item_type = string_base::item_type

using	iterator = string_base::iterator

using	reverse_iterator = string_base::reverse_iterator

using	string_base = GenericString< char, IsoCharTraits, PCL_STRING_ALLOCATOR >

using	uchar_iterator = ustring_base::iterator

using	uchar_traits = ustring_base::char_traits

using	uchar_type = ustring_base::char_type

using	ustring_base = GenericString< char16_type, CharTraits, PCL_STRING_ALLOCATOR >

Public Types inherited from pcl::GenericString< char, IsoCharTraits, PCL_STRING_ALLOCATOR >
using	allocator = pcl::Allocator< char, PCL_STRING_ALLOCATOR >

using	block_allocator = PCL_STRING_ALLOCATOR

using	c_string = char *

using	char_traits = IsoCharTraits

using	char_type = char

using	const_c_string = const char *

using	const_item_type = typename container_type::const_item_type

using	const_iterator = const char *

using	const_reverse_iterator = ReverseRandomAccessIterator< const_iterator, const char >

using	container_type = DirectContainer< char >

using	item_type = typename container_type::item_type

using	iterator = char *

using	reverse_iterator = ReverseRandomAccessIterator< iterator, char >

Public Types inherited from pcl::DirectContainer< char >
using	const_item_type = const char

using	item_type = char

Public Member Functions
	IsoString ()=default

	IsoString (bool x)

	IsoString (char_type c, size_type n=1)

	IsoString (Complex< double > &x)

	IsoString (Complex< float > &x)

	IsoString (Complex< long double > &x)

	IsoString (const ByteArray &B)

	IsoString (const IsoString &)=default

	IsoString (const string_base &s)

	IsoString (const ustring_base &s)

	IsoString (const_c_string t)

	IsoString (const_c_string t, size_type i, size_type n)

	IsoString (const_c_ustring t)

	IsoString (const_c_ustring t, size_type i, size_type n)

	IsoString (const_iterator i, const_iterator j)

	IsoString (double x)

	IsoString (float x)

	IsoString (int x)

	IsoString (IsoString &&)=default

	IsoString (long double x)

	IsoString (long long x)

	IsoString (long x)

	IsoString (short x)

	IsoString (std::initializer_list< char_type > l)

	IsoString (string_base &&s)

	IsoString (unsigned int x)

	IsoString (unsigned long long x)

	IsoString (unsigned long x)

	IsoString (unsigned short x)

IsoString &	AppendFormat (const_c_string fmt,...)

int	AppendVFormat (const_c_string fmt, va_list paramList)

IsoString	DecodedHTMLSpecialChars () const

IsoString	EncodedHTMLSpecialChars () const

IsoString &	Format (const_c_string fmt,...)

ByteArray	FromBase64 () const

ByteArray	FromBase64URL () const

ByteArray	FromHex () const

ByteArray	FromURLEncoded () const

ustring_base	MBSToWCS () const

IsoString &	operator= (char_type c)

IsoString &	operator= (const IsoString &s)

IsoString &	operator= (const string_base &s)

IsoString &	operator= (const ustring_base &s)

IsoString &	operator= (const_c_string t)

IsoString &	operator= (const_c_ustring t)

IsoString &	operator= (IsoString &&s)

IsoString &	operator= (string_base &&s)

void	ParseISO8601DateTime (int &year, int &month, int &day, double &dayf, double &tz) const

Array< double >	ParseListOfDouble (char separator=',', size_type maxCount=~size_type(0)) const

GenericVector< double >	ParseListOfDoubleAsVector (char separator=',', int maxCount=int_max) const

Array< float >	ParseListOfFloat (char separator=',', size_type maxCount=~size_type(0)) const

GenericVector< float >	ParseListOfFloatAsVector (char separator=',', int maxCount=int_max) const

void	ParseSexagesimal (int &sign, int &s1, int &s2, double &s3, const Array< char_type > &separators) const

void	ParseSexagesimal (int &sign, int &s1, int &s2, double &s3, const IsoString &separator=':') const

double	SexagesimalToDouble (const Array< char_type > &separators) const

double	SexagesimalToDouble (const IsoString &separator=':') const

bool	ToBool () const

ByteArray	ToByteArray () const

template<class C >
IsoString &	ToColonSeparated (const C &c)

template<class C >
IsoString &	ToCommaSeparated (const C &c)

IsoString &	ToDecodedHTMLSpecialChars ()

double	ToDouble () const

IsoString &	ToEncodedHTMLSpecialChars ()

float	ToFloat () const

template<class C >
IsoString &	ToHyphenated (const C &c)

long	ToInt () const

long	ToInt (int base) const

long long	ToInt64 () const

long long	ToInt64 (int base) const

template<class C >
IsoString &	ToNewLineSeparated (const C &c)

template<class C >
IsoString &	ToNullSeparated (const C &c)

template<class C >
IsoString &	ToSeparated (const C &c, char_type separator)

template<class C , class AF >
IsoString &	ToSeparated (const C &c, char_type separator, AF append)

template<class C >
IsoString &	ToSeparated (const C &c, const IsoString &separator)

template<class C , class AF >
IsoString &	ToSeparated (const C &c, const IsoString &separator, AF append)

template<class C >
IsoString &	ToSeparated (const C &c, const_c_string separator)

template<class C , class AF >
IsoString &	ToSeparated (const C &c, const_c_string separator, AF append)

template<class C >
IsoString &	ToSpaceSeparated (const C &c)

ustring_base	ToString () const

template<class C >
IsoString &	ToTabSeparated (const C &c)

unsigned long	ToUInt () const

unsigned long	ToUInt (int base) const

unsigned long long	ToUInt64 () const

unsigned long long	ToUInt64 (int base) const

IsoString &	ToURLDecoded ()

IsoString &	ToURLEncoded ()

bool	TryParseISO8601DateTime (int &year, int &month, int &day, double &dayf, double &tz) const noexcept

bool	TryParseSexagesimal (int &sign, int &s1, int &s2, double &s3, const Array< char_type > &separators) const noexcept

bool	TryParseSexagesimal (int &sign, int &s1, int &s2, double &s3, const IsoString &separator=':') const noexcept

bool	TrySexagesimalToDouble (double &value, const Array< char_type > &separators) const noexcept

bool	TrySexagesimalToDouble (double &value, const IsoString &separator=':') const noexcept

bool	TryToBool (bool &value) const noexcept

bool	TryToDouble (double &value) const noexcept

bool	TryToFloat (float &value) const noexcept

bool	TryToInt (int &value) const noexcept

bool	TryToInt (int &value, int base) const noexcept

bool	TryToInt64 (long long &value) const noexcept

bool	TryToInt64 (long long &value, int base) const noexcept

bool	TryToUInt (unsigned &value) const noexcept

bool	TryToUInt (unsigned &value, int base) const noexcept

bool	TryToUInt64 (unsigned long long &value) const noexcept

bool	TryToUInt64 (unsigned long long &value, int base) const noexcept

IsoString	URLDecoded () const

IsoString	URLEncoded () const

ustring_base	UTF8ToUTF16 (size_type i=0, size_type n=maxPos) const

int	VFormat (const_c_string fmt, va_list paramList)

Public Member Functions inherited from pcl::GenericString< char, IsoCharTraits, PCL_STRING_ALLOCATOR >
	GenericString ()

	GenericString (char_type c, size_type n=1)

	GenericString (const GenericString &s)

	GenericString (const_c_string t)

	GenericString (const_c_string t, size_type i, size_type n)

	GenericString (const_iterator i, const_iterator j)

	GenericString (GenericString &&s)

	GenericString (std::initializer_list< char_type > l)

	~GenericString ()

void	Add (char_type c, size_type n=1)

void	Add (const GenericString< char, R1, A1 > &s)

void	Add (const_c_string t)

void	Add (const_c_string t, size_type n)

void	Add (const_iterator i, const_iterator j)

const allocator &	Allocator () const noexcept

void	Append (char_type c, size_type n=1)

void	Append (const GenericString< char, R1, A1 > &s)

void	Append (const_c_string t)

void	Append (const_c_string t, size_type n)

void	Append (const_iterator i, const_iterator j)

void	Assign (char_type c, size_type n=1)

void	Assign (const GenericString &s)

void	Assign (const GenericString &s, size_type i, size_type n)

void	Assign (const_c_string t)

void	Assign (const_c_string t, size_type i, size_type n)

void	Assign (const_iterator i, const_iterator j)

void	Assign (std::initializer_list< char_type > l)

iterator	At (size_type i)

const_iterator	At (size_type i) const noexcept

size_type	Available () const noexcept

iterator	Begin ()

iterator	begin ()

const_iterator	Begin () const noexcept

const_iterator	begin () const noexcept

size_type	Break (C &list, char_type c, bool trim=false, size_type i=0) const

size_type	Break (C &list, const Array< S > &ca, bool trim=false, size_type i=0) const

size_type	Break (C &list, const GenericString< char, R1, A1 > &s, bool trim=false, size_type i=0) const

size_type	Break (C &list, const_c_string s, bool trim=false, size_type i=0) const

size_type	BreakIC (C &list, char_type c, bool trim=false, size_type i=0) const

size_type	BreakIC (C &list, const GenericString< char, R1, A1 > &s, bool trim=false, size_type i=0) const

size_type	BreakIC (C &list, const_c_string s, bool trim=false, size_type i=0) const

void	c_copy (iterator dst, size_type maxCharsToCopy, size_type i=0) const noexcept

const_c_string	c_str () const noexcept

size_type	Capacity () const noexcept

GenericString	CaseFolded () const

GenericString	CenterJustified (size_type width, char_type fill=R::Blank()) const

void	Clear ()

int	Compare (char_type c, bool caseSensitive=true, bool localeAware=true) const noexcept

int	Compare (const GenericString< char, R1, A1 > &s, bool caseSensitive=true, bool localeAware=true) const noexcept

int	Compare (const_c_string t, bool caseSensitive=true, bool localeAware=true) const noexcept

int	CompareCodePoints (char_type c, bool caseSensitive=true) const noexcept

int	CompareCodePoints (const GenericString< char, R1, A1 > &s, bool caseSensitive=true) const noexcept

int	CompareCodePoints (const_c_string t, bool caseSensitive=true) const noexcept

int	CompareIC (char_type c, bool localeAware=true) const noexcept

int	CompareIC (const GenericString< char, R1, A1 > &s, bool localeAware=true) const noexcept

int	CompareIC (const_c_string t, bool localeAware=true) const noexcept

bool	Contains (char_type c) const noexcept

bool	Contains (const GenericString< char, R1, A1 > &s) const noexcept

bool	Contains (const_c_string t) const noexcept

bool	ContainsIC (char_type c) const noexcept

bool	ContainsIC (const GenericString< char, R1, A1 > &s) const noexcept

bool	ContainsIC (const_c_string t) const noexcept

void	Delete (size_type i, size_type n=1)

void	DeleteChar (char_type c, size_type i=0)

void	DeleteCharIC (char_type c, size_type i=0)

void	DeleteLeft (size_type i)

void	DeleteRight (size_type i)

void	DeleteString (const GenericString< char, R1, A1 > &s, size_type i=0)

void	DeleteString (const_c_string t, size_type i=0)

void	DeleteStringIC (const GenericString< char, R1, A1 > &s, size_type i=0)

void	DeleteStringIC (const_c_string t, size_type i=0)

GenericString	DoubleQuoted () const

GenericString	Enclosed (char_type c) const

iterator	End ()

iterator	end ()

const_iterator	End () const noexcept

const_iterator	end () const noexcept

bool	EndsWith (char_type c) const noexcept

bool	EndsWith (const GenericString< char, R1, A1 > &s) const noexcept

bool	EndsWith (const_c_string t) const noexcept

bool	EndsWithIC (char_type c) const noexcept

bool	EndsWithIC (const GenericString< char, R1, A1 > &s) const noexcept

bool	EndsWithIC (const_c_string t) const noexcept

void	EnsureDoubleQuoted ()

void	EnsureEnclosed (char_type c)

void	EnsureSingleQuoted ()

void	EnsureUnique ()

void	Fill (char_type c)

void	Fill (char_type c, size_type i, size_type n=maxPos)

size_type	Find (char_type c, size_type i=0) const noexcept

size_type	Find (const GenericString< char, R1, A1 > &s, size_type i=0) const noexcept

size_type	Find (const_c_string t, size_type i=0) const noexcept

size_type	FindFirst (char_type c, size_type i=0) const noexcept

size_type	FindFirst (const GenericString< char, R1, A1 > &s, size_type i=0) const noexcept

size_type	FindFirst (const_c_string t, size_type i=0) const noexcept

size_type	FindFirstIC (char_type c, size_type i=0) const noexcept

size_type	FindFirstIC (const GenericString< char, R1, A1 > &s, size_type i=0) const noexcept

size_type	FindFirstIC (const_c_string t, size_type i=0) const noexcept

size_type	FindIC (char_type c, size_type i=0) const noexcept

size_type	FindIC (const GenericString< char, R1, A1 > &s, size_type i=0) const noexcept

size_type	FindIC (const_c_string t, size_type i=0) const noexcept

size_type	FindLast (char_type c, size_type r=maxPos) const noexcept

size_type	FindLast (const GenericString< char, R1, A1 > &s, size_type r=maxPos) const noexcept

size_type	FindLast (const_c_string t, size_type r=maxPos) const noexcept

size_type	FindLastIC (char_type c, size_type r=maxPos) const noexcept

size_type	FindLastIC (const GenericString< char, R1, A1 > &s, size_type r=maxPos) const noexcept

size_type	FindLastIC (const_c_string t, size_type r=maxPos) const noexcept

char_type	FirstChar () const noexcept

uint64	Hash (uint64 seed=0) const noexcept

uint32	Hash32 (uint32 seed=0) const noexcept

uint64	Hash64 (uint64 seed=0) const noexcept

bool	HasWildcards () const noexcept

size_type	IndexAt (const_iterator i) const noexcept

void	Insert (size_type i, char_type c, size_type n=1)

void	Insert (size_type i, const GenericString< char, R1, A1 > &s)

void	Insert (size_type i, const_c_string t)

void	Insert (size_type i, const_c_string t, size_type n)

void	Insert (size_type i, const_iterator p, const_iterator q)

bool	IsAliasOf (const GenericString &s) const noexcept

bool	IsEmpty () const noexcept

bool	IsNumeral () const noexcept

bool	IsSymbol () const noexcept

bool	IsUnique () const noexcept

bool	IsValid () const noexcept

bool	IsValidIdentifier () const noexcept

bool	IsValidIdentifier (distance_type &pos) const noexcept

void	JustifyCenter (size_type width, char_type fill=R::Blank())

void	JustifyLeft (size_type width, char_type fill=R::Blank())

void	JustifyRight (size_type width, char_type fill=R::Blank())

char_type	LastChar () const noexcept

GenericString	Left (size_type n) const

GenericString	LeftJustified (size_type width, char_type fill=R::Blank()) const

size_type	Length () const noexcept

size_type	LowerBound () const noexcept

GenericString	Lowercase () const

char_type &	operator* ()

char_type	operator* () const noexcept

GenericString &	operator+= (char_type c)

GenericString &	operator+= (const GenericString< char, R1, A1 > &s)

GenericString &	operator+= (const_c_string t)

GenericString &	operator-= (char_type c)

GenericString &	operator-= (const GenericString< char, R1, A1 > &s)

GenericString &	operator-= (const_c_string t)

GenericString &	operator= (char_type c)

GenericString &	operator= (const GenericString &s)

GenericString &	operator= (const_c_string t)

GenericString &	operator= (GenericString &&s)

char_type &	operator[] (size_type i)

char_type	operator[] (size_type i) const noexcept

GenericString	Prefix (size_type i) const

void	Prepend (char_type c, size_type n=1)

void	Prepend (const GenericString< char, R1, A1 > &s)

void	Prepend (const_c_string t)

void	Prepend (const_c_string t, size_type n)

void	Prepend (const_iterator i, const_iterator j)

c_string	Release ()

void	Replace (size_type i, size_type n, char_type c, size_type nc=1)

void	Replace (size_type i, size_type n, const GenericString< char, R1, A1 > &s)

void	Replace (size_type i, size_type n, const_c_string t)

void	ReplaceChar (char_type c1, char_type c2, size_type i=0, size_type n=maxPos)

void	ReplaceCharIC (char_type c1, char_type c2, size_type i=0, size_type n=maxPos)

void	ReplaceString (const GenericString< char, R1, A1 > &s1, const GenericString< char, R2, A2 > &s2, size_type i=0)

void	ReplaceString (const_c_string t1, const_c_string t2, size_type i=0)

void	ReplaceStringIC (const GenericString< char, R1, A1 > &s1, const GenericString< char, R2, A2 > &s2, size_type i=0)

void	ReplaceStringIC (const_c_string t1, const_c_string t2, size_type i=0)

void	Reserve (size_type n)

GenericString	ResizedToNullTerminated () const

void	ResizeToNullTerminated ()

void	Reverse ()

reverse_iterator	ReverseBegin ()

const_reverse_iterator	ReverseBegin () const noexcept

GenericString	Reversed () const

reverse_iterator	ReverseEnd ()

const_reverse_iterator	ReverseEnd () const noexcept

GenericString	Right (size_type n) const

GenericString	RightJustified (size_type width, char_type fill=R::Blank()) const

void	SecureFill (char c='\0') noexcept

void	SetAllocator (const allocator &a)

void	SetLength (size_type n)

GenericString	SetToLength (size_type n) const

GenericString	SingleQuoted () const

size_type	Size () const noexcept

void	Sort ()

void	Sort (BP p)

GenericString	Sorted () const

GenericString	Sorted (BP p) const

void	Squeeze ()

GenericString	Squeezed () const

bool	StartsWith (char_type c) const noexcept

bool	StartsWith (const GenericString< char, R1, A1 > &s) const noexcept

bool	StartsWith (const_c_string t) const noexcept

bool	StartsWithIC (char_type c) const noexcept

bool	StartsWithIC (const GenericString< char, R1, A1 > &s) const noexcept

bool	StartsWithIC (const_c_string t) const noexcept

GenericString	Substring (size_type i, size_type n=maxPos) const

GenericString	Suffix (size_type i) const

void	Swap (GenericString &s) noexcept

void	ToCaseFolded ()

void	ToLowercase ()

void	ToUppercase ()

void	Transfer (GenericString &&s)

void	Transfer (GenericString &s)

void	Trim ()

void	TrimLeft ()

GenericString	Trimmed () const

GenericString	TrimmedLeft () const

GenericString	TrimmedRight () const

void	TrimRight ()

void	Unquote ()

GenericString	Unquoted () const

size_type	UpperBound () const noexcept

GenericString	Uppercase () const

bool	WildMatch (const GenericString< char, R1, A1 > &pattern, bool caseSensitive=true) const noexcept

bool	WildMatch (const_c_string pattern, bool caseSensitive=true) const noexcept

bool	WildMatchIC (const GenericString< char, R1, A1 > &pattern) const noexcept

bool	WildMatchIC (const_c_string pattern) const noexcept

Static Public Member Functions
static IsoString	CurrentLocalISO8601DateTime (const ISO8601ConversionOptions &options=ISO8601ConversionOptions())

static IsoString	CurrentUTCISO8601DateTime (const ISO8601ConversionOptions &options=ISO8601ConversionOptions())

template<class C >
static ByteArray	FromURLEncoded (const C &c)

static ByteArray	FromURLEncoded (const void *data, size_type length)

static IsoString	Random (size_type n, RandomizationOptions options=RandomizationOption::Default)

template<class C >
static IsoString	ToBase64 (const C &c)

static IsoString	ToBase64 (const void *data, size_type length)

template<class C >
static IsoString	ToBase64URL (const C &c)

static IsoString	ToBase64URL (const void *data, size_type length)

template<class C >
static IsoString	ToHex (const C &c)

static IsoString	ToHex (const void *data, size_type length)

static IsoString	ToISO8601DateTime (int year, int month, int day, double dayf, double tz=0, const ISO8601ConversionOptions &options=ISO8601ConversionOptions())

static IsoString	ToSexagesimal (double d, const SexagesimalConversionOptions &options=SexagesimalConversionOptions())

static IsoString	ToSexagesimal (int sign, double s1, double s2, double s3, const SexagesimalConversionOptions &options=SexagesimalConversionOptions())

template<class C >
static IsoString	ToURLDecoded (const C &c)

static IsoString	ToURLDecoded (const void *data, size_type length)

template<class C >
static IsoString	ToURLEncoded (const C &c)

static IsoString	ToURLEncoded (const void *data, size_type length)

static IsoString	UUID ()

Static Public Member Functions inherited from pcl::GenericString< char, IsoCharTraits, PCL_STRING_ALLOCATOR >
static size_type	BytesPerChar () noexcept

static size_type	DeleteFreeList ()

Additional Inherited Members
Static Public Attributes inherited from pcl::GenericString< char, IsoCharTraits, PCL_STRING_ALLOCATOR >
static const size_type	maxPos

static const size_type	notFound

Detailed Description

IsoString derives from a template instantiation of GenericString for the char type. On the PixInsight platform, IsoString represents a dynamic ISO/IEC-8859-1 string, an 8-bit Unicode Transformation Format (UTF-8) string, or even a sequence of ASCII (or Latin-1) characters, depending on the context and type of transformations applied.

See also: String

Definition at line 5442 of file String.h.

Member Typedef Documentation

◆ allocator

using pcl::IsoString::allocator = string_base::allocator

The allocator class used by this template instantiation.

Definition at line 5484 of file String.h.

◆ block_allocator

using pcl::IsoString::block_allocator = string_base::block_allocator

The block allocator used by this template instantiation.

Definition at line 5479 of file String.h.

◆ c_string

using pcl::IsoString::c_string = string_base::c_string

Null-terminated sequence of 8-bit characters.

Definition at line 5489 of file String.h.

◆ c_ustring

using pcl::IsoString::c_ustring = ustring_base::c_string

Null-terminated sequence of UTF-16 characters.

Definition at line 5536 of file String.h.

◆ char_traits

using pcl::IsoString::char_traits = string_base::char_traits

The character traits class used by this template instantiation.

Definition at line 5474 of file String.h.

◆ char_type

using pcl::IsoString::char_type = string_base::char_type

Represents a character pertaining to an IsoString object.

Definition at line 5469 of file String.h.

◆ const_c_string

using pcl::IsoString::const_c_string = string_base::const_c_string

Immutable null-terminated sequence of 8-bit characters.

Definition at line 5494 of file String.h.

◆ const_c_ustring

using pcl::IsoString::const_c_ustring = ustring_base::const_c_string

Immutable null-terminated sequence of UTF-16 characters.

Definition at line 5541 of file String.h.

◆ const_item_type

using pcl::IsoString::const_item_type = string_base::const_item_type

The type of contained immutable objects.

Definition at line 5464 of file String.h.

◆ const_iterator

using pcl::IsoString::const_iterator = string_base::const_iterator

Immutable IsoString iterator.

Definition at line 5504 of file String.h.

◆ const_reverse_iterator

using pcl::IsoString::const_reverse_iterator = string_base::const_reverse_iterator

Immutable reverse IsoString iterator.

Definition at line 5514 of file String.h.

◆ const_uchar_iterator

using pcl::IsoString::const_uchar_iterator = ustring_base::const_iterator

Immutable Unicode (UTF-16) string iterator.

Definition at line 5551 of file String.h.

◆ container_type

using pcl::IsoString::container_type = string_base::container_type

The container type of this string.

Definition at line 5454 of file String.h.

◆ item_type

using pcl::IsoString::item_type = string_base::item_type

The type of contained objects.

Definition at line 5459 of file String.h.

◆ iterator

using pcl::IsoString::iterator = string_base::iterator

IsoString iterator.

Definition at line 5499 of file String.h.

◆ reverse_iterator

using pcl::IsoString::reverse_iterator = string_base::reverse_iterator

Reverse IsoString iterator.

Definition at line 5509 of file String.h.

◆ string_base

using pcl::IsoString::string_base = GenericString<char, IsoCharTraits, PCL_STRING_ALLOCATOR>

Base class of IsoString.

Definition at line 5449 of file String.h.

◆ uchar_iterator

using pcl::IsoString::uchar_iterator = ustring_base::iterator

Unicode (UTF-16) string iterator.

Definition at line 5546 of file String.h.

◆ uchar_traits

using pcl::IsoString::uchar_traits = ustring_base::char_traits

Unicode (UTF-16) character traits class.

Definition at line 5531 of file String.h.

◆ uchar_type

using pcl::IsoString::uchar_type = ustring_base::char_type

Represents a Unicode (UTF-16) character.

Definition at line 5526 of file String.h.

◆ ustring_base

using pcl::IsoString::ustring_base = GenericString<char16_type, CharTraits, PCL_STRING_ALLOCATOR>

Represents a Unicode (UTF-16) string.

Note: This type must be defined as the same template instantiation used for the String class.

Definition at line 5521 of file String.h.

Constructor & Destructor Documentation

◆ IsoString() [1/29]

pcl::IsoString::IsoString ( )

default

Constructs an empty IsoString object.

◆ IsoString() [2/29]

pcl::IsoString::IsoString ( const string_base & s )

inline

Constructs an IsoString object as a shallow copy of the specified string_base string s (copy constructor from the base class).

Definition at line 5564 of file String.h.

◆ IsoString() [3/29]

pcl::IsoString::IsoString ( const IsoString & )

default

Copy constructor.

◆ IsoString() [4/29]

pcl::IsoString::IsoString ( string_base && s )

inline

Constructs an IsoString object by transferring data from the specified string_base string s (move constructor from the base class).

Definition at line 5578 of file String.h.

◆ IsoString() [5/29]

pcl::IsoString::IsoString ( IsoString && )

default

Move constructor.

◆ IsoString() [6/29]

pcl::IsoString::IsoString ( const ustring_base & s )

inlineexplicit

Constructs an IsoString as a copy of the specified Unicode string s, transformed to ISO/IEC-8859-1. Characters in the Unicode string that cannot be converted to ISO/IEC-8859-1 (that is, code points greater than 0x100) will have undefined values in the 8-bit string. Undefined values are represented with question mark characters (?).

Definition at line 5596 of file String.h.

◆ IsoString() [7/29]

pcl::IsoString::IsoString ( const_c_string t )

inline

Constructs an IsoString as a copy of a null-terminated string t.

Definition at line 5604 of file String.h.

◆ IsoString() [8/29]

pcl::IsoString::IsoString	(	const_c_string	t,
		size_type	i,
		size_type	n
	)

inline

Constructs an IsoString with the n first characters of the null-terminated string t, starting from its i-th character.

Definition at line 5613 of file String.h.

◆ IsoString() [9/29]

pcl::IsoString::IsoString	(	char_type	c,
		size_type	n = `1`
	)

inline

Constructs an IsoString with n copies of a character c.

Definition at line 5621 of file String.h.

◆ IsoString() [10/29]

pcl::IsoString::IsoString	(	const_iterator	i,
		const_iterator	j
	)

inline

Constructs an IsoString with a copy of the character sequence defined by the range [i,j).

Definition at line 5630 of file String.h.

◆ IsoString() [11/29]

pcl::IsoString::IsoString ( std::initializer_list< char_type > l )

inline

Constructs an IsoString with a copy of the character sequence stored in the specified initializer list l.

This constructor is equivalent to:

IsoString( l.begin(), l.end() )

pcl::IsoString::IsoString

IsoString()=default

Definition at line 5643 of file String.h.

◆ IsoString() [12/29]

pcl::IsoString::IsoString ( const_c_ustring t )

inlineexplicit

Constructs an IsoString as a copy of the null-terminated Unicode (UTF-16) string t, transformed to ISO/IEC-8859-1.

If the specified Unicode string t contains characters that cannot be converted to ISO/IEC-8859-1 characters, the corresponding characters in this string will have undefined values. For conversions from UTF-16 to UTF-8, see String::ToUTF8() and String::UTF16ToUTF8().

Definition at line 5658 of file String.h.

◆ IsoString() [13/29]

pcl::IsoString::IsoString	(	const_c_ustring	t,
		size_type	i,
		size_type	n
	)

inline

Constructs an IsoString with the n first characters of the null-terminated Unicode (UTF-16) string t, starting from its i-th character, transformed to ISO/IEC-8859-1.

If the specified Unicode string t contains characters that cannot be converted to ISO/IEC-8859-1 characters, the corresponding characters in this string will have undefined values. For conversions from UTF-16 to UTF-8, see String::ToUTF8() and String::UTF16ToUTF8().

Definition at line 12343 of file String.h.

References pcl::GenericString< char, IsoCharTraits, PCL_STRING_ALLOCATOR >::end(), pcl::CharTraits::Length(), and pcl::Min().

◆ IsoString() [14/29]

pcl::IsoString::IsoString ( const ByteArray & B )

inlineexplicit

Constructs an IsoString with a copy of the bytes stored in the specified ByteArray object.

Source unsigned 8-bit integers will be reinterpreted as signed 8-bit characters.

Definition at line 5683 of file String.h.

◆ IsoString() [15/29]

pcl::IsoString::IsoString ( bool x )

inlineexplicit

Constructs an IsoString as a literal representation of a bool value.

Definition at line 5692 of file String.h.

◆ IsoString() [16/29]

pcl::IsoString::IsoString ( short x )

inlineexplicit

Constructs an IsoString as a literal representation of a signed short value.

Definition at line 5702 of file String.h.

◆ IsoString() [17/29]

pcl::IsoString::IsoString ( unsigned short x )

inlineexplicit

Constructs an IsoString as a literal representation of an unsigned short value.

Definition at line 5712 of file String.h.

◆ IsoString() [18/29]

pcl::IsoString::IsoString ( int x )

inlineexplicit

Constructs an IsoString as a literal representation of a signed int value.

Definition at line 5722 of file String.h.

◆ IsoString() [19/29]

pcl::IsoString::IsoString ( unsigned int x )

inlineexplicit

Constructs an IsoString as a literal representation of an unsigned int value.

Definition at line 5732 of file String.h.

◆ IsoString() [20/29]

pcl::IsoString::IsoString ( long x )

inlineexplicit

Constructs an IsoString as a literal representation of a signed long value.

Definition at line 5742 of file String.h.

◆ IsoString() [21/29]

pcl::IsoString::IsoString ( unsigned long x )

inlineexplicit

Constructs an IsoString as a literal representation of an unsigned long value.

Definition at line 5752 of file String.h.

◆ IsoString() [22/29]

pcl::IsoString::IsoString ( long long x )

inlineexplicit

Constructs an IsoString as a literal representation of a signed long long value.

Definition at line 5762 of file String.h.

◆ IsoString() [23/29]

pcl::IsoString::IsoString ( unsigned long long x )

inlineexplicit

Constructs an IsoString as a literal representation of an unsigned long long value.

Definition at line 5772 of file String.h.

◆ IsoString() [24/29]

pcl::IsoString::IsoString ( float x )

inlineexplicit

Constructs an IsoString as a literal representation of a float value.

Definition at line 5782 of file String.h.

◆ IsoString() [25/29]

pcl::IsoString::IsoString ( double x )

inlineexplicit

Constructs an IsoString as a literal representation of a double value.

Definition at line 5792 of file String.h.

◆ IsoString() [26/29]

pcl::IsoString::IsoString ( long double x )

inlineexplicit

Constructs an IsoString as a literal representation of a long double value.

Definition at line 5802 of file String.h.

◆ IsoString() [27/29]

pcl::IsoString::IsoString ( Complex< float > & x )

inlineexplicit

Constructs an IsoString as a literal representation of an fcomplex value.

Definition at line 5818 of file String.h.

References pcl::Complex< T >::Imag(), and pcl::Complex< T >::Real().

◆ IsoString() [28/29]

pcl::IsoString::IsoString ( Complex< double > & x )

inlineexplicit

Constructs an IsoString as a literal representation of a dcomplex value.

Definition at line 5828 of file String.h.

References pcl::Complex< T >::Imag(), and pcl::Complex< T >::Real().

◆ IsoString() [29/29]

pcl::IsoString::IsoString ( Complex< long double > & x )

inlineexplicit

Constructs an IsoString as a literal representation of an lcomplex value.

Definition at line 5838 of file String.h.

References pcl::Complex< T >::Imag(), and pcl::Complex< T >::Real().

Member Function Documentation

◆ AppendFormat()

IsoString& pcl::IsoString::AppendFormat	(	const_c_string	fmt,
			...
	)

inline

Appends a formatted representation of a variable-length set of values to the current contents of this string. Returns a reference to this string.

The fmt null-terminated string is a standard printf format string. It follows the same rules as its counterpart parameter in the standard printf( const char* fmt, ... ) C runtime function.

The required space to store the resulting formatted output is calculated and allocated transparently.

Definition at line 6625 of file String.h.

◆ AppendVFormat()

int pcl::IsoString::AppendVFormat	(	const_c_string	fmt,
		va_list	paramList
	)

Appends a formatted representation of a variable-length set of values, specified as a va_list standard parameter list, to the current contents of this string. Returns the number of characters appended.

The fmt null-terminated string is a standard printf format string. It follows the same rules as its counterpart parameter in the standard printf( const char* fmt, ... ) C runtime function.

The required space to store the resulting formatted output is calculated and allocated transparently.

◆ CurrentLocalISO8601DateTime()

static IsoString pcl::IsoString::CurrentLocalISO8601DateTime ( const ISO8601ConversionOptions & options = ISO8601ConversionOptions() )

static

Returns an ASCII representation of the current local date and time in ISO 8601 extended format.

Parameters

options Optional settings to control the representation of date and time in ISO 8601 format.

See also: CurrentUTCISO8601DateTime(), ToISO8601DateTime(), ISO8601ConversionOptions

◆ CurrentUTCISO8601DateTime()

static IsoString pcl::IsoString::CurrentUTCISO8601DateTime ( const ISO8601ConversionOptions & options = ISO8601ConversionOptions() )

static

Returns an ASCII representation of the current UTC date and time in ISO 8601 extended format.

Parameters

options Optional settings to control the representation of date and time in ISO 8601 format.

See also: CurrentLocalISO8601DateTime(), ToISO8601DateTime(), ISO8601ConversionOptions, TimePoint::Now()

◆ DecodedHTMLSpecialChars()

IsoString pcl::IsoString::DecodedHTMLSpecialChars ( ) const

inline

Returns a duplicate of this string with all occurrences of special HTML entities replaced with their corresponding plain text character equivalents.

See also: ToDecodedHTMLSpecialChars(), EncodedHTMLSpecialChars()

Definition at line 6414 of file String.h.

◆ EncodedHTMLSpecialChars()

IsoString pcl::IsoString::EncodedHTMLSpecialChars ( ) const

inline

Returns a duplicate of this string with all occurrences of HTML special characters replaced with valid HTML entities.

See also: ToEncodedHTMLSpecialChars(), DecodedHTMLSpecialChars()

Definition at line 6384 of file String.h.

◆ Format()

IsoString& pcl::IsoString::Format	(	const_c_string	fmt,
			...
	)

inline

Replaces the contents of this string with a formatted representation of a variable-length set of values. Returns a reference to this string.

The fmt null-terminated string is a standard printf format string. It follows the same rules as its counterpart parameter in the standard printf( const char* fmt, ... ) C runtime function.

The required space to store the resulting formatted output is calculated and allocated transparently.

Definition at line 6603 of file String.h.

Referenced by pcl::RGBAColorToHexString(), and pcl::RGBColorToHexString().

◆ FromBase64()

ByteArray pcl::IsoString::FromBase64 ( ) const

Decodes a Base64-encoded string, and returns the decoded binary raw data stored in a ByteArray object.

This function expects this string to be Base64-encoded; if it isn't, or if it contains an invalid Base64 representation, a ParseError exception will be thrown.

If this string is empty, this function returns an empty ByteArray.

See also: ToBase64(), FromBase64URL(), FromHex()

Referenced by FromBase64URL().

◆ FromBase64URL()

ByteArray pcl::IsoString::FromBase64URL ( ) const

inline

Decodes a Base64URL-encoded string, and returns the decoded binary raw data stored in a ByteArray object.

See ToBase64URL( const void*, size_type ) for information on Base64URL encoding and its differences with respect to standard Base64.

See also: FromBase64()

Definition at line 7776 of file String.h.

References FromBase64().

◆ FromHex()

ByteArray pcl::IsoString::FromHex ( ) const

Decodes an hex-encoded string, and returns the decoded binary raw data stored in a ByteArray object.

This function expects this string to be hex-encoded; if it isn't, or if it contains invalid hexadecimal digits, a ParseError exception will be thrown.

If this string is empty, this function returns an empty ByteArray.

See also: ToHex(), FromBase64()

◆ FromURLEncoded() [1/3]

ByteArray pcl::IsoString::FromURLEncoded ( ) const

inline

Decodes this URL-encoded string, and returns the decoded binary raw data as a ByteArray object.

This function replaces all percent-encoded character representations in this string with their actual characters in the output array.

If this string is empty, this function returns an empty ByteArray.

See also: FromURLEncoded( const void*, size_type ), ToURLEncoded()

Definition at line 6509 of file String.h.

◆ FromURLEncoded() [2/3]

template<class C >

static ByteArray pcl::IsoString::FromURLEncoded ( const C & c )

inlinestatic

Decodes a URL-encoded generic string represented as a container c. Returns the decoded binary raw data as a ByteArray object.

See also: FromURLEncoded( const void*, size_type ), ToURLEncoded( const void*, size_type )

Definition at line 6493 of file String.h.

◆ FromURLEncoded() [3/3]

static ByteArray pcl::IsoString::FromURLEncoded	(	const void *	data,
		size_type	length
	)

static

Decodes a URL-encoded string stored as a raw data vector of the specified length in bytes. Returns the decoded binary raw data as a ByteArray object.

This function replaces all percent-encoded character representations in the specified data vector with their actual characters in the output array.

See also: FromURLEncoded(), ToURLEncoded( const void*, size_type )

◆ MBSToWCS()

ustring_base pcl::IsoString::MBSToWCS ( ) const

Returns a copy of this multibyte string converted to a UTF-16 string. This conversion is dependent on the current locale.

In the event of conversion error (if there are invalid multibyte characters in the source string) this routine returns an empty string.

This member function is a convenience wrapper for the mbstowcs() routine of the standard C runtime library. Note that on platforms where the size of wchar_t is four bytes (e.g. Linux) this routine performs an additional conversion from UTF-32 to UTF-16. On platforms where the size of wchar_t is two bytes (e.g. Windows), the conversion is direct.

See also: UTF8ToUTF16(), ToString()

◆ operator=() [1/8]

IsoString& pcl::IsoString::operator= ( char_type c )

inline

Assigns a single copy of a character c to this string. Returns a reference to this object.

Definition at line 5952 of file String.h.

◆ operator=() [2/8]

IsoString& pcl::IsoString::operator= ( const IsoString & s )

inline

Copy assignment operator. Returns a reference to this object.

Definition at line 5888 of file String.h.

◆ operator=() [3/8]

IsoString& pcl::IsoString::operator= ( const string_base & s )

inline

Assigns a shallow copy of the string_base string s to this string. Returns a reference to this object.

Definition at line 5907 of file String.h.

◆ operator=() [4/8]

IsoString& pcl::IsoString::operator= ( const ustring_base & s )

inline

Assigns a copy of the Unicode string s (UTF-16) to this string, after converting source UTF-16 characters to ISO/IEC-8859-1 characters. Returns a reference to this object.

If the specified UTF-16 string contains characters that cannot be converted to ISO/IEC-8859-1, the corresponding characters in this string will have undefined values. For conversions from UTF-16 to UTF-8, see String::ToUTF8() and String::UTF16ToUTF8().

Definition at line 5933 of file String.h.

References pcl::GenericString< T, R, A >::Begin().

◆ operator=() [5/8]

IsoString& pcl::IsoString::operator= ( const_c_string t )

inline

Assigns a copy of the null-terminated string t to this string. Returns a reference to this object.

Definition at line 5942 of file String.h.

◆ operator=() [6/8]

IsoString & pcl::IsoString::operator= ( const_c_ustring t )

inline

Assigns a copy of the null-terminated Unicode string s (UTF-16) to this string, after converting source UTF-16 characters to ISO/IEC-8859-1 characters. Returns a reference to this object.

If the specified UTF-16 string contains characters that cannot be converted to ISO/IEC-8859-1, the corresponding characters in this string will have undefined values. For conversions from UTF-16 to UTF-8, see String::ToUTF8() and String::UTF16ToUTF8().

Definition at line 12355 of file String.h.

References pcl::GenericString< char, IsoCharTraits, PCL_STRING_ALLOCATOR >::Clear(), pcl::GenericString< char, IsoCharTraits, PCL_STRING_ALLOCATOR >::end(), and pcl::CharTraits::Length().

◆ operator=() [7/8]

IsoString& pcl::IsoString::operator= ( IsoString && s )

inline

Move assignment operator. Returns a reference to this object.

Definition at line 5897 of file String.h.

◆ operator=() [8/8]

IsoString& pcl::IsoString::operator= ( string_base && s )

inline

Transfers the data from the string_base string s to this string (move assignment from base class). Returns a reference to this object.

Definition at line 5917 of file String.h.

◆ ParseISO8601DateTime()

void pcl::IsoString::ParseISO8601DateTime	(	int &	year,
		int &	month,
		int &	day,
		double &	dayf,
		double &	tz
	)		const

Evaluates this string as a date and time specification in ISO 8601 extended format, and stores the resulting components in the specified variables.

Parameters

year	On output, the year of the date.
month	On output, the month of the date in the range [1,12].
day	On output, the day of the date in the range [1,31].
dayf	On output, the day fraction corresponding to the time specification, in the range [0,1).
tz	On output, the time zone offset in hours, in the range [-12,+12].

In ISO 8601 extended representations, decimal fractions must be divided from integer parts exclusively by the full stop or dot character ('.', ASCII code point 46(10) = 2E(16)).

See also: TryParseISO8601DateTime(), TimePoint::FromString()

Referenced by pcl::TimePoint::TimePoint(), and pcl::TimePoint::FromString().

◆ ParseListOfDouble()

Array<double> pcl::IsoString::ParseListOfDouble	(	char	separator = `','`,
		size_type	maxCount = `~size_type(0)`
	)		const

Evaluates this string as a sequence:

as a list <f1><f2>...<fn> of 64-bit floating point values separated by <sep> separator characters.

Parameters

separator	The separator character. Cannot be a character pertaining to a floating point numeric representation (decimal digit [09], sign character [+-], decimal separator '.' or exponent delimiter [eE]). If not specified, the default separator is a comma character ','.
maxCount	The maximum number of values allowed. If the parsed list includes more than this number of elements, a ParseError exception will be thrown with the appropriate error message. If this parameter is not specified, there is no practical limit on the list's length by default.

Returns a dynamic array of double values. Returns an empty array if this string is either empty or entirely composed of trimmable characters.

For each element in the parsed list, trimmable characters (whitespace) are ignored. Empty list elements (that is, sequences of contiguous separator characters, or separators separated by trimmable characters) are not allowed. In the event of syntactic errors or invalid or unrepresentable values, this function throws a ParseError exception.

◆ ParseListOfDoubleAsVector()

GenericVector<double> pcl::IsoString::ParseListOfDoubleAsVector	(	char	separator = `','`,
		int	maxCount = `int_max`
	)		const

Returns a new vector initialized with 64-bit floating point component values evaluated from this string.

This function performs the same task as ParseListOfDouble() but builds and returns a GenericVector object instead of Array.

◆ ParseListOfFloat()

Array<float> pcl::IsoString::ParseListOfFloat	(	char	separator = `','`,
		size_type	maxCount = `~size_type(0)`
	)		const

Evaluates this string as a sequence:

as a list <f1><f2>...<fn> of 32-bit floating point values separated by <sep> separator characters.

Parameters

separator	The separator character. Cannot be a character pertaining to a floating point numeric representation (decimal digit [09], sign character [+-], decimal separator '.' or exponent delimiter [eE]). If not specified, the default separator is a comma character ','.
maxCount	The maximum number of values allowed. If the parsed list includes more than this number of elements, a ParseError exception will be thrown with the appropriate error message. If this parameter is not specified, there is no practical limit on the list's length by default.

Returns a dynamic array of float values. Returns an empty array if this string is either empty or entirely composed of trimmable characters.

For each element in the parsed list, trimmable characters (whitespace) are ignored. Empty list elements (that is, sequences of contiguous separator characters, or separators separated by trimmable characters) are not allowed. In the event of syntactic errors or invalid or unrepresentable values, this function throws a ParseError exception.

◆ ParseListOfFloatAsVector()

GenericVector<float> pcl::IsoString::ParseListOfFloatAsVector	(	char	separator = `','`,
		int	maxCount = `int_max`
	)		const

Returns a new vector initialized with 32-bit floating point component values evaluated from this string.

This function performs the same task as ParseListOfFloat() but builds and returns a GenericVector object instead of Array.

◆ Random()

static IsoString pcl::IsoString::Random	(	size_type	n,
		RandomizationOptions	options = `RandomizationOption::Default`
	)

static

Generates a string of n random 8-bit code points, with character types and ranges as prescribed by the specified options.

See also: RandomizationOption

◆ ToBase64() [1/2]

template<class C >

static IsoString pcl::IsoString::ToBase64 ( const C & c )

inlinestatic

Returns a Base64-encoded string for a container c, whose contents are treated as raw binary data. The objects stored in the container are considered as a sequence of bytes, irrespective of their actual data types or the classes they are instances of.

The type C represents an array of contiguous objects, and must provide PCL container semantics: the Begin() and Length() standard container functions are required.

See also: ToBase64( const void*, size_type ), ToBase64URL( const C& ), ToByteArray()

Definition at line 7679 of file String.h.

◆ ToBase64() [2/2]

static IsoString pcl::IsoString::ToBase64	(	const void *	data,
		size_type	length
	)

static

Returns a Base64-encoded string for a binary data block of the specified length in bytes.

Base64 is a MIME content transfer encoding of binary data translated into a base 64 representation composed of printable characters. See RFC 1421 (http://tools.ietf.org/html/rfc1421).

See also: ToBase64( const C& ), ToBase64URL( const void*, size_type ), ToHex(), ToByteArray()

◆ ToBase64URL() [1/2]

template<class C >

static IsoString pcl::IsoString::ToBase64URL ( const C & c )

inlinestatic

Returns a Base64URL-encoded string for a container c, whose contents are treated as raw binary data.

See ToBase64( const C& ) for complete information on Base64 encoding of contained objects. See ToBase64URL( const void*, size_type ) for information on Base64URL encoding and its differences with respect to standard Base64.

See also: ToBase64( const C& ), ToBase64URL( const void*, size_type )

Definition at line 7722 of file String.h.

◆ ToBase64URL() [2/2]

static IsoString pcl::IsoString::ToBase64URL	(	const void *	data,
		size_type	length
	)

inlinestatic

Returns a Base64URL-encoded string for a binary data block of the specified length in bytes.

Base64URL is a modification of the Base64 encoding standard able to encode URL fragments. Base64URL is identical to Base64 with the following exceptions:

The '+' character (plus) is replaced by '-' (minus)
The '/' character (slash) is replaced by '_' (underline)
All '=' padding characters are removed

See also: ToBase64( const void*, size_type )

Definition at line 7698 of file String.h.

References pcl::GenericString< T, R, A >::DeleteChar().

◆ ToBool()

bool pcl::IsoString::ToBool ( ) const

Evaluates this string as a Boolean literal, and returns the result as a bool value.

Returns true if this string is equal to "1", "true", "TRUE" or "T". Returns false if this string is equal to "0", "false", "FALSE" or "F". Otherwise this function throws a ParseError exception.

See also: TryToBool()

◆ ToByteArray()

ByteArray pcl::IsoString::ToByteArray ( ) const

inline

Returns a ByteArray object that stores a copy of this string. In the returned array, source 8-bit characters have been reinterpreted as unsigned 8-bit integers.

See also: ToBase64(), ToHex()

Definition at line 7734 of file String.h.

◆ ToColonSeparated()

template<class C >

IsoString& pcl::IsoString::ToColonSeparated ( const C & c )

inline

Replaces the contents of this string with a sequence of colon-separated tokens extracted from a container c. Returns a reference to this string.

This member function is equivalent to:

ToSeparated( c, ':' );

pcl::IsoString::ToSeparated

IsoString & ToSeparated(const C &c, char_type separator)

Definition: String.h:6151

Definition at line 6281 of file String.h.

◆ ToCommaSeparated()

template<class C >

IsoString& pcl::IsoString::ToCommaSeparated ( const C & c )

inline

Replaces the contents of this string with a sequence of comma-separated tokens extracted from a container c. Returns a reference to this string.

This member function is equivalent to:

ToSeparated( c, ',' );

Definition at line 6266 of file String.h.

◆ ToDecodedHTMLSpecialChars()

IsoString& pcl::IsoString::ToDecodedHTMLSpecialChars ( )

Replaces all occurrences of special HTML entities in this string with their corresponding plain text character equivalents. Returns a reference to this string.

The following replacements are performed:

"\&" (ampersand) becomes '&'
"\"" (double quote) becomes '"'
"\'" (single quote) becomes "'"
"\'" (apostrophe) becomes "'"
"\<" (less than) becomes '<'
"\>" (greater than) becomes '>'

See also: DecodedHTMLSpecialChars(), ToEncodedHTMLSpecialChars()

◆ ToDouble()

double pcl::IsoString::ToDouble ( ) const

Evaluates this string as a floating point literal, and returns the result as a double value.

The source string is expected to have the following format (informal format specification):

[+|-][<integer-part>][.[<decimal-part>]][<exp>[+|-]<exponent>]

where <integer-part> and <decimal-part> are optional sequences of decimal digits from 0 to 9, <exp> is an exponent specifier (the letter 'e' (or 'E')), and <exponent> is a sequence of decimal digits specifying a power of ten that multiplies the preceding numeric constant. At least a one-digit integer part, or a one-digit decimal part, is mandatory. FORTRAN exponent specifiers ('d' and 'f' (or 'D' and 'F')) are also recognized by this implementation.

If this string doesn't contain a valid floating point literal, or if the range of double is exceeded, this member function throws a ParseError exception.

See also: TryToDouble()

◆ ToEncodedHTMLSpecialChars()

IsoString& pcl::IsoString::ToEncodedHTMLSpecialChars ( )

Replaces all occurrences of HTML special characters in this string with valid HTML entities. Returns a reference to this string.

The following replacements are performed:

'&' (ampersand) becomes "\&"
'"' (double quote) becomes "\""
"'" (single quote) becomes "\'"
'<' (less than) becomes "\<"
'>' (greater than) becomes "\>"

See also: EncodedHTMLSpecialChars(), ToDecodedHTMLSpecialChars()

◆ ToFloat()

float pcl::IsoString::ToFloat ( ) const

Evaluates this string as a floating point numeric literal, and returns the result as a float value.

For information about the legal syntax of a floating point literal, see the documentation for the ToDouble() member function.

If this string doesn't contain a valid floating point literal, or if the range of float is exceeded, this member function throws a ParseError exception.

See also: TryToFloat()

◆ ToHex() [1/2]

template<class C >

static IsoString pcl::IsoString::ToHex ( const C & c )

inlinestatic

Returns an hex-encoded string for a container c, whose contents are treated as raw binary data. The objects stored in the container are considered as a sequence of bytes, irrespective of their actual data types or the classes they are instances of.

The type C represents an array of contiguous objects, and must provide PCL container semantics: the Begin() and Length() standard container functions are required.

See also: ToHex( const void*, size_type )

Definition at line 7647 of file String.h.

◆ ToHex() [2/2]

static IsoString pcl::IsoString::ToHex	(	const void *	data,
		size_type	length
	)

static

Returns an hex-encoded string for a binary data block of the specified length in bytes. The hex-encoded string is composed of hexadecimal digits: 0-9 and a-f, and its length is twice that of the input length.

See also: ToHex( const C& ), ToBase64(), ToByteArray()

Referenced by pcl::AES256::AES256().

◆ ToHyphenated()

template<class C >

IsoString& pcl::IsoString::ToHyphenated ( const C & c )

inline

Replaces the contents of this string with a hyphenated sequence of tokens extracted from a container c. Returns a reference to this string.

This member function is equivalent to:

ToSeparated( c, '-' );

Definition at line 6355 of file String.h.

◆ ToInt() [1/2]

long pcl::IsoString::ToInt ( ) const

inline

Evaluates this string as an integer literal, and returns the result as a long value.

Calling this member function for a string s is equivalent to:

long n = s.ToInt( 0 );

See the documentation under ToInt( int ) for information about automatic base conversions when base=0 is specified.

If this string doesn't contain a valid integer literal, or if the range of long is exceeded, this member function throws a ParseError exception.

See also: TryToInt()

Definition at line 6852 of file String.h.

◆ ToInt() [2/2]

long pcl::IsoString::ToInt ( int base ) const

Evaluates this string as an integer literal in the specified base, and returns the result as a long value.

If base is 0, the source string is expected to represent either a decimal constant, an octal constant, or a hexadecimal constant, any of which optionally preceded by a sign character (+ or -). A decimal constant begins with a non-zero digit, and consists of a sequence of decimal digits from '0' to '9'. An octal begins with the prefix '0', optionally followed by a sequence of the digits 0 to 7 only. A hexadecimal constant begins with the prefix '0x' or '0X', which must be followed by a sequence of decimal digits and letters from 'a' (or 'A') to 'f' (or 'F'), whose corresponding decimal values are from 10 to 15, respectively.

Other legal values of base, from 2 to 36, specify the expected base of the integer constant represented by the source string. Decimal digits and letters from 'a' (or 'A') to 'z' (or 'Z') are used to represent all possible digits in the specified base, as necessary.

If this string doesn't contain a valid integer literal in the specified base, if an illegal base is specified, or if the range of long is exceeded, this member function throws a ParseError exception.

See also: TryToInt( int&, int ) const

◆ ToInt64() [1/2]

long long pcl::IsoString::ToInt64 ( ) const

inline

Evaluates this string as an integer literal, and returns the result as a long long value.

Calling this member function for a string s is equivalent to:

long long n = s.ToInt64( 0 );

If this string doesn't contain a valid integer literal, or if the range of long long is exceeded, this member function throws a ParseError exception.

See also: TryToInt64()

Definition at line 7033 of file String.h.

◆ ToInt64() [2/2]

long long pcl::IsoString::ToInt64 ( int base ) const

Evaluates this string as an unsigned integer literal in the specified base, and returns the result as a long long value.

For information about possible values of base and how these are interpreted, see the documentation under ToInt( int ).

If this string doesn't contain a valid integer literal in the specified base, if an illegal base is specified, or if the range of long long is exceeded, this member function throws a ParseError exception.

See also: TryToInt64( long long&, int ) const

◆ ToISO8601DateTime()

static IsoString pcl::IsoString::ToISO8601DateTime	(	int	year,
		int	month,
		int	day,
		double	dayf,
		double	tz = `0`,
		const ISO8601ConversionOptions &	options = `ISO8601ConversionOptions()`
	)

static

Returns an ASCII representation of a date and time in ISO 8601 extended format.

Parameters

year	The year of the date.
month	The month of the date in the range [1,12].
day	The day of the date in the range [1,31].
dayf	The day fraction corresponding to the time specification, in the range [0,1).
tz	The time zone offset in hours, in the range [-12,+12]. The default value is zero, to be interpreted as UTC.
options	Optional settings to control the representation of date and time in ISO 8601 format.

See also: CurrentUTCISO8601DateTime(), CurrentLocalISO8601DateTime(), ParseISO8601DateTime(), ISO8601ConversionOptions, TimePoint::ToIsoString()

◆ ToNewLineSeparated()

template<class C >

IsoString& pcl::IsoString::ToNewLineSeparated ( const C & c )

inline

Replaces the contents of this string with a sequence of new line separated tokens extracted from a container c. Returns a reference to this string.

This member function is equivalent to:

ToSeparated( c, '\n' );

Definition at line 6326 of file String.h.

◆ ToNullSeparated()

template<class C >

IsoString& pcl::IsoString::ToNullSeparated ( const C & c )

inline

Replaces the contents of this string with a sequence of null-separated tokens extracted from a container c. Returns a reference to this string.

This member function is equivalent to:

ToSeparated( c, '\0' );

Definition at line 6341 of file String.h.

◆ ToSeparated() [1/6]

template<class C >

IsoString& pcl::IsoString::ToSeparated	(	const C &	c,
		char_type	separator
	)

inline

Replaces the contents of this string with a sequence of tokens extracted from a container c, separated with the specified separator character. Returns a reference to this string.

The container type C must have separated list generation semantics. All iterable PCL containers such as Array, Vector, etc. provide the necessary ToSeparated member functions.

Definition at line 6151 of file String.h.

◆ ToSeparated() [2/6]

template<class C , class AF >

IsoString& pcl::IsoString::ToSeparated	(	const C &	c,
		char_type	separator,
		AF	append
	)

inline

Replaces the contents of this string with a sequence of tokens extracted from a container c, separated with the specified separator character, and built using an append binary function. Returns a reference to this string.

The binary function must be of the form:

void append( IsoString& s, char c );

where c is being appended to s.

The container type C must have separated list generation semantics. All iterable PCL containers such as Array, Vector, etc. provide the necessary ToSeparated member functions.

Definition at line 6174 of file String.h.

◆ ToSeparated() [3/6]

template<class C >

IsoString& pcl::IsoString::ToSeparated	(	const C &	c,
		const IsoString &	separator
	)

inline

Replaces the contents of this string with a sequence of tokens extracted from a container c, separated with the specified separator string. Returns a reference to this string.

The container type C must have separated list generation semantics. All iterable PCL containers such as Array, Vector, etc. provide the necessary ToSeparated member functions.

Definition at line 6190 of file String.h.

◆ ToSeparated() [4/6]

template<class C , class AF >

IsoString& pcl::IsoString::ToSeparated	(	const C &	c,
		const IsoString &	separator,
		AF	append
	)

inline

Replaces the contents of this string with a sequence of tokens extracted from a container c, separated with the specified separator string, and built using an append binary function. Returns a reference to this string.

The binary function must be of the form:

void append( IsoString& s1, const IsoString& s2 );

where s2 is being appended to s1.

The container type C must have separated list generation semantics. All iterable PCL containers such as Array, Vector, etc. provide the necessary ToSeparated member functions.

Definition at line 6213 of file String.h.

◆ ToSeparated() [5/6]

template<class C >

IsoString& pcl::IsoString::ToSeparated	(	const C &	c,
		const_c_string	separator
	)

inline

Replaces the contents of this string with a sequence of tokens extracted from a container c, separated with the specified separator null-terminated string. Returns a reference to this string.

The container type C must have separated list generation semantics. All iterable PCL containers such as Array, Vector, etc. provide the necessary ToSeparated member functions.

Definition at line 6229 of file String.h.

◆ ToSeparated() [6/6]

template<class C , class AF >

IsoString& pcl::IsoString::ToSeparated	(	const C &	c,
		const_c_string	separator,
		AF	append
	)

inline

Replaces the contents of this string with a sequence of tokens extracted from a container c, separated with the specified separator null-terminated string, and built using an append binary function. Returns a reference to this string.

The binary function must be of the form:

void append( IsoString& s1, const char* s2 );

where s2 is being appended to s1.

The container type C must have separated list generation semantics. All iterable PCL containers such as Array, Vector, etc. provide the necessary ToSeparated member functions.

Definition at line 6251 of file String.h.

◆ ToSpaceSeparated()

template<class C >

IsoString& pcl::IsoString::ToSpaceSeparated ( const C & c )

inline

Replaces the contents of this string with a sequence of space-separated tokens extracted from a container c. Returns a reference to this string.

This member function is equivalent to:

ToSeparated( c, ' ' );

Definition at line 6296 of file String.h.

◆ ToString()

ustring_base pcl::IsoString::ToString ( ) const

inline

Returns a UTF-16 string with a converted copy of this IsoString object.

This function assumes that this IsoString object contains only valid ISO/IEC-8859-1 characters. To perform UTF-8 to UTF-16 conversions, see UTF8ToUTF16() and MBSToWCS().

See also: UTF8ToUTF16(), MBSToWCS()

Definition at line 6675 of file String.h.

References pcl::GenericString< T, R, A >::Begin(), and pcl::GenericString< T, R, A >::SetLength().

◆ ToTabSeparated()

template<class C >

IsoString& pcl::IsoString::ToTabSeparated ( const C & c )

inline

Replaces the contents of this string with a sequence of tabulator-separated tokens extracted from a container c. Returns a reference to this string.

This member function is equivalent to:

ToSeparated( c, '\t' );

Definition at line 6311 of file String.h.

◆ ToUInt() [1/2]

unsigned long pcl::IsoString::ToUInt ( ) const

inline

Evaluates this string as an unsigned integer literal, and returns the result as an unsigned long value.

Calling this member function for a string s is equivalent to:

unsigned long n = s.ToUInt( 0 );

See the documentation under ToInt( int ) for information about automatic base conversions when base=0 is specified.

If this string doesn't contain a valid unsigned integer literal, or if the range of unsigned long is exceeded, this member function throws a ParseError exception.

See also: TryToUInt()

Definition at line 6949 of file String.h.

◆ ToUInt() [2/2]

unsigned long pcl::IsoString::ToUInt ( int base ) const

Evaluates this string as an unsigned integer literal in the specified base, and returns the result as an unsigned long value.

For information about possible values of base and how these are interpreted, see the documentation under ToInt( int ). The only exception is that for this member function, only a + sign is legal preceding the numeric constant represented by the source string.

If this string doesn't contain a valid integer literal in the specified base, if an illegal base is specified, or if the range of unsigned long is exceeded, this member function throws a ParseError exception.

See also: TryToUInt( unsigned&, int ) const

◆ ToUInt64() [1/2]

unsigned long long pcl::IsoString::ToUInt64 ( ) const

inline

Evaluates this string as an unsigned integer literal in the specified base, and returns the result as an unsigned long long value.

Calling this member function for a string s is equivalent to:

unsigned long long n = s.ToUInt64( 0 );

If this string doesn't contain a valid unsigned integer literal, or if the range of unsigned long long is exceeded, this member function throws a ParseError exception.

See also: TryToUInt64()

Definition at line 7116 of file String.h.

◆ ToUInt64() [2/2]

unsigned long long pcl::IsoString::ToUInt64 ( int base ) const

Evaluates this string as an unsigned integer literal in the specified base, and returns the result as an unsigned long long value.

For information about possible values of base and how these are interpreted, see the documentation under ToInt( int ).

If this string doesn't contain a valid unsigned integer literal in the specified base, if an illegal base is specified, or if the range of unsigned long long is exceeded, this member function throws a ParseError exception.

See also: TryToUInt64( unsigned long long&, int ) const

◆ ToURLDecoded() [1/3]

IsoString& pcl::IsoString::ToURLDecoded ( )

Replaces all percent-encoded representations of characters with their actual characters. Returns a reference to this string.

This is the reverse transformation to URL encoding. See ToURLEncoded() for more information.

See also: URLDecoded(), ToURLEncoded(), FromURLEncoded()

◆ ToURLDecoded() [2/3]

template<class C >

static IsoString pcl::IsoString::ToURLDecoded ( const C & c )

inlinestatic

Decodes a URL-encoded generic string represented as a container c. Returns the decoded data stored as an 8-bit string.

See also: ToURLDecoded( const void*, size_type ), ToURLDecoded(), URLDecoded()

Definition at line 6534 of file String.h.

◆ ToURLDecoded() [3/3]

static IsoString pcl::IsoString::ToURLDecoded	(	const void *	data,
		size_type	length
	)

static

Decodes a URL-encoded string stored as a raw data vector of the specified length in bytes. Returns the decoded data stored as an 8-bit string.

This function replaces all percent-encoded character representations in the specified data vector with their actual characters in the output string.

See also: ToURLDecoded(), URLDecoded()

◆ ToURLEncoded() [1/3]

IsoString& pcl::IsoString::ToURLEncoded ( )

Replaces all characters that are not a-z, A-Z, 0-9, '-', '.', '_' or '~' with their percent-encoded representation NN, where NN is a zero-padded, two-digit uppercase hexadecimal number. Returns a reference to this string. See RFC 3986 / URI Generic Syntax, for more information on URL encodings.

See also: URLEncoded(), ToURLDecoded()

◆ ToURLEncoded() [2/3]

template<class C >

static IsoString pcl::IsoString::ToURLEncoded ( const C & c )

inlinestatic

Returns a URL-encoded string for a container c, whose contents are treated as raw binary data. The objects stored in the container are considered as a sequence of bytes, irrespective of their actual data types or the classes they are instances of.

The type C represents an array of contiguous objects, and must provide PCL container semantics: the Begin() and Length() standard container functions are required.

See also: ToURLEncoded( const void*, size_type )

Definition at line 6445 of file String.h.

◆ ToURLEncoded() [3/3]

static IsoString pcl::IsoString::ToURLEncoded	(	const void *	data,
		size_type	length
	)

static

Returns a URL-encoded string that represents a binary data block of the specified length in bytes.

In a URL-encoded string, all characters that are not a-z, A-Z, 0-9, '-', '.', '_' or '~' are replaced with their percent-encoded representation NN, where NN is a zero-padded, two-digit uppercase hexadecimal number. See RFC 3986 (http://tools.ietf.org/html/rfc3986).

See also: ToURLEncoded( const C& ), ToURLEncoded()

◆ TryParseISO8601DateTime()

bool pcl::IsoString::TryParseISO8601DateTime	(	int &	year,
		int &	month,
		int &	day,
		double &	dayf,
		double &	tz
	)		const

noexcept

Attempts to evaluate this string as a date and time specification in ISO 8601 extended format. If successful, stores the resulting components in the specified year, month, day and dayf and tz variables, and returns true. For more information on syntax and output values and ranges, see the ParseISO8601DateTime().

If this string cannot be evaluated as a valid date and time in ISO 8601 format, this function returns false and does not change any of the passed variables. This function does not throw any exception.

See also: ParseISO8601DateTime(), TimePoint::TryFromString()

Referenced by pcl::TimePoint::TryFromString().

◆ TryToBool()

bool pcl::IsoString::TryToBool ( bool & value ) const

noexcept

Attempts to evaluate this string as a Boolean literal.

If this string can legally be converted to a Boolean value, this function returns true and stores the evaluation result in the value variable. A string can only be converted to Boolean type if it is equal to either "1", "true", "TRUE", "T", "0", "false", "FALSE" or "F".

If this string cannot be converted to a Boolean value, this function returns false and does not change the value variable. This function does not throw any exception.

See also: ToBool()

◆ TryToDouble()

bool pcl::IsoString::TryToDouble ( double & value ) const

noexcept

Attempts to evaluate this string as a floating point numeric literal.

If this string can legally be converted to a floating point number, this function returns true and stores the evaluation result in the value variable. For information about the legal syntax of a floating point literal, see the documentation for the ToDouble() member function.

If this string cannot be converted to a floating point number, this function returns false and does not change the value variable. This function does not throw any exception.

See also: ToDouble()

Referenced by pcl::FITSHeaderKeyword::FixValueDelimiters(), and pcl::FITSHeaderKeyword::GetNumericValue().

◆ TryToFloat()

bool pcl::IsoString::TryToFloat ( float & value ) const

noexcept

Attempts to evaluate this string as a floating point numeric literal.

If this string can legally be converted to a floating point number, this function returns true and stores the evaluation result in the value variable. For information about the legal syntax of a floating point literal, see the documentation for the ToDouble() member function.

If this string cannot be converted to a floating point number, this function returns false and does not change the value variable. This function does not throw any exception.

See also: ToFloat()

◆ TryToInt() [1/2]

bool pcl::IsoString::TryToInt ( int & value ) const

inlinenoexcept

Attempts to evaluate this string as an integer numeric literal.

If this string can legally be converted to an integer number, this function returns true and stores the evaluation result in the value variable.

Calling this member function for a string s is equivalent to:

int v;

if ( s.TryToInt( v, 0 ) ) ...

See the documentation under ToInt( int ) for information about automatic base conversions when base=0 is specified.

If this string cannot be converted to an integer number, this function returns false and does not change the value variable. This function does not throw any exception.

See also: ToInt()

Definition at line 6880 of file String.h.

◆ TryToInt() [2/2]

bool pcl::IsoString::TryToInt	(	int &	value,
		int	base
	)		const

noexcept

Attempts to evaluate this string as an integer numeric literal in the specified base.

If this string can legally be converted to an integer number in the specified base, this function returns true and stores the evaluation result in the value variable.

See the documentation under ToInt( int ) for information about automatic base conversions when base=0 is specified.

If this string cannot be converted to an integer number in the specified base, this function returns false and does not change the value variable. This function does not throw any exception.

See also: ToInt( int ) const

◆ TryToInt64() [1/2]

bool pcl::IsoString::TryToInt64 ( long long & value ) const

inlinenoexcept

Attempts to evaluate this string as a 64-bit integer numeric literal in the specified base.

If this string can legally be converted to a 64-bit integer number in the specified base, this function returns true and stores the evaluation result in the value variable.

Calling this member function for a string s is equivalent to:

long long v;

if ( s.TryToInt64( v, 0 ) ) ...

See the documentation under ToInt( int ) for information about automatic base conversions when base=0 is specified.

If this string cannot be converted to a 64-bit integer number, this function returns false and does not change the value variable. This function does not throw any exception.

See also: ToInt64()

Definition at line 7062 of file String.h.

◆ TryToInt64() [2/2]

bool pcl::IsoString::TryToInt64	(	long long &	value,
		int	base
	)		const

noexcept

Attempts to evaluate this string as a 64-bit integer numeric literal in the specified base.

If this string can legally be converted to a 64-bit integer number in the specified base, this function returns true and stores the evaluation result in the value variable.

For information about possible values of base and how these are interpreted, see the documentation under ToInt( int ).

If this string cannot be converted to a 64-bit integer number in the specified base, this function returns false and does not change the value variable. This function does not throw any exception.

See also: ToInt64( int ) const

◆ TryToUInt() [1/2]

bool pcl::IsoString::TryToUInt ( unsigned & value ) const

inlinenoexcept

Attempts to evaluate this string as an unsigned integer literal.

If this string can legally be converted to an unsigned integer number, this function returns true and stores the evaluation result in the value variable.

Calling this member function for a string s is equivalent to:

unsigned v;

if ( s.TryToUInt( v, 0 ) ) ...

See the documentation under ToInt( int ) for information about automatic base conversions when base=0 is specified.

If this string cannot be converted to an integer number, this function returns false and does not change the value variable. This function does not throw any exception.

See also: ToUInt()

Definition at line 6977 of file String.h.

◆ TryToUInt() [2/2]

bool pcl::IsoString::TryToUInt	(	unsigned &	value,
		int	base
	)		const

noexcept

Attempts to evaluate this string as an unsigned integer literal in the specified base.

If this string can legally be converted to an unsigned integer number in the specified base, this function returns true and stores the evaluation result in the value variable.

See the documentation under ToUInt( int ) for information about automatic base conversions when base=0 is specified.

If this string cannot be converted to an unsigned integer number in the specified base, this function returns false and does not change the value variable. This function does not throw any exception.

See also: ToUInt( int ) const

◆ TryToUInt64() [1/2]

bool pcl::IsoString::TryToUInt64 ( unsigned long long & value ) const

inlinenoexcept

Attempts to evaluate this string as a 64-bit unsigned integer numeric literal in the specified base.

If this string can legally be converted to a 64-bit unsigned integer number in the specified base, this function returns true and stores the evaluation result in the value variable.

Calling this member function for a string s is equivalent to:

unsigned long long v;

if ( s.TryToUInt64( v, 0 ) ) ...

See the documentation under ToInt( int ) for information about automatic base conversions when base=0 is specified.

If this string cannot be converted to a 64-bit unsigned integer number, this function returns false and does not change the value variable. This function does not throw any exception.

See also: ToUInt64()

Definition at line 7145 of file String.h.

◆ TryToUInt64() [2/2]

bool pcl::IsoString::TryToUInt64	(	unsigned long long &	value,
		int	base
	)		const

noexcept

Attempts to evaluate this string as an unsigned 64-bit integer numeric literal in the specified base.

If this string can legally be converted to an unsigned 64-bit integer number in the specified base, this function returns true and stores the evaluation result in the value variable.

For information about possible values of base and how these are interpreted, see the documentation under ToInt( int ).

If this string cannot be converted to an unsigned 64-bit integer number in the specified base, this function returns false and does not change the value variable. This function does not throw any exception.

See also: ToUInt64( int ) const

◆ URLDecoded()

IsoString pcl::IsoString::URLDecoded ( ) const

inline

Returns a URL-decoded duplicate of this string. See ToURLDecoded() for detailed information.

See also: ToURLDecoded(), URLEncoded()

Definition at line 6556 of file String.h.

◆ URLEncoded()

IsoString pcl::IsoString::URLEncoded ( ) const

inline

Returns a URL-encoded duplicate of this string. See ToURLEncoded() for detailed information.

See also: ToURLEncoded(), URLDecoded()

Definition at line 6467 of file String.h.

◆ UTF8ToUTF16()

IsoString::ustring_base pcl::IsoString::UTF8ToUTF16	(	size_type	i = `0`,
		size_type	n = `maxPos`
	)		const

inline

Returns a UTF-16 string with a representation of a subset of n contiguous UTF-8 characters from this IsoString object, starting at the i-th character.

See also: ToString(), MBSToWCS()

Definition at line 12370 of file String.h.

References pcl::GenericString< char, IsoCharTraits, PCL_STRING_ALLOCATOR >::Begin(), and pcl::String::UTF8ToUTF16().

◆ UUID()

static IsoString pcl::IsoString::UUID ( )

static

Generates a universally unique identifier (UUID) in canonical form.

The canonical UUID has 36 characters with the following format:

xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx

where 'x' represents a lowercase hexadecimal digit, '4' is the UUID version indicator (version 4 = truly random UUID), and 'y' is one of '8', '9', 'a', or 'b'.

◆ VFormat()

int pcl::IsoString::VFormat	(	const_c_string	fmt,
		va_list	paramList
	)

Replaces the contents of this string with a formatted representation of a variable-length set of values, specified as a va_list standard parameter list. Returns the number of characters generated.

The fmt null-terminated string is a standard printf format string. It follows the same rules as its counterpart parameter in the standard printf( const char* fmt, ... ) C runtime function.

The required space to store the resulting formatted output is calculated and allocated transparently.

Referenced by pcl::String::AppendVFormat(), and pcl::String::VFormat().

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

String.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ allocator

◆ block_allocator

◆ c_string

◆ c_ustring

◆ char_traits

◆ char_type

◆ const_c_string

◆ const_c_ustring

◆ const_item_type

◆ const_iterator

◆ const_reverse_iterator

◆ const_uchar_iterator

◆ container_type

◆ item_type

◆ iterator

◆ reverse_iterator

◆ string_base

◆ uchar_iterator

◆ uchar_traits

◆ uchar_type

◆ ustring_base

Constructor & Destructor Documentation

◆ IsoString() [1/29]

◆ IsoString() [2/29]

◆ IsoString() [3/29]

◆ IsoString() [4/29]

◆ IsoString() [5/29]

◆ IsoString() [6/29]

◆ IsoString() [7/29]

◆ IsoString() [8/29]

◆ IsoString() [9/29]

◆ IsoString() [10/29]

◆ IsoString() [11/29]

◆ IsoString() [12/29]

◆ IsoString() [13/29]

◆ IsoString() [14/29]

◆ IsoString() [15/29]

◆ IsoString() [16/29]

◆ IsoString() [17/29]

◆ IsoString() [18/29]

◆ IsoString() [19/29]

◆ IsoString() [20/29]

◆ IsoString() [21/29]

◆ IsoString() [22/29]

◆ IsoString() [23/29]

◆ IsoString() [24/29]

◆ IsoString() [25/29]

◆ IsoString() [26/29]

◆ IsoString() [27/29]

◆ IsoString() [28/29]

◆ IsoString() [29/29]

Member Function Documentation

◆ AppendFormat()

◆ AppendVFormat()

◆ CurrentLocalISO8601DateTime()

◆ CurrentUTCISO8601DateTime()

◆ DecodedHTMLSpecialChars()

◆ EncodedHTMLSpecialChars()

◆ Format()

◆ FromBase64()

◆ FromBase64URL()

◆ FromHex()

◆ FromURLEncoded() [1/3]

◆ FromURLEncoded() [2/3]

◆ FromURLEncoded() [3/3]

◆ MBSToWCS()

◆ operator=() [1/8]

◆ operator=() [2/8]

◆ operator=() [3/8]

◆ operator=() [4/8]

◆ operator=() [5/8]

◆ operator=() [6/8]

◆ operator=() [7/8]

◆ operator=() [8/8]