# FoundationClasses
TKernel
TCollection

# TCollection_HExtendedString Class Reference

A variable-length sequence of "extended"
(UNICODE) characters (16-bit character
type). It provides editing operations with
built-in memory management to make
ExtendedString objects easier to use than
ordinary extended character arrays.
HExtendedString objects are handles to strings.
- HExtendedString strings may be shared by several objects.
- You may use an ExtendedString object to get the actual string.
Note: HExtendedString objects use an
ExtendedString string as a field.
.

`#include <TCollection_HExtendedString.hxx>`

Inheritance diagram for TCollection_HExtendedString:

[legend]

## Public Member Functions

Standard_EXPORT | TCollection_HExtendedString ()
| Initializes a HExtendedString to an empty ExtendedString. .
Standard_EXPORT | TCollection_HExtendedString (const Standard_CString message)
| Initializes a HExtendedString with a CString. .
Standard_EXPORT | TCollection_HExtendedString (const Standard_ExtString message)
| Initializes a HExtendedString with an ExtString. .
Standard_EXPORT | TCollection_HExtendedString (const Standard_ExtCharacter aChar)
| Initializes a HExtendedString with a single character. .
Standard_EXPORT | TCollection_HExtendedString (const Standard_Integer length, const Standard_ExtCharacter filler)
| Initializes a HExtendedString with <length> space allocated. and filled with <filler>.This is usefull for buffers. .
Standard_EXPORT | TCollection_HExtendedString (const TCollection_ExtendedString &aString)
| Initializes a HExtendedString with a HExtendedString. .
Standard_EXPORT | TCollection_HExtendedString (const Handle(TCollection_HAsciiString)&aString)
| Initializes a HExtendedString with an HAsciiString. .
Standard_EXPORT | TCollection_HExtendedString (const Handle(TCollection_HExtendedString)&aString)
| Initializes a HExtendedString with a HExtendedString. .
Standard_EXPORT void | AssignCat (const Handle(TCollection_HExtendedString)&other)
| Appends <other> to me. .
Standard_EXPORT Handle_TCollection_HExtendedString | Cat (const Handle(TCollection_HExtendedString)&other) const
| Returns a string appending <other> to me. .
Standard_EXPORT void | ChangeAll (const Standard_ExtCharacter aChar, const Standard_ExtCharacter NewChar)
| Substitutes all the characters equal to aChar by NewChar in the string <me>. .
Standard_EXPORT void | Clear ()
| Removes all characters contained in <me>. This produces an empty ExtendedString. .
Standard_EXPORT Standard_Boolean | IsEmpty () const
| Returns True if the string <me> contains zero character .
Standard_EXPORT void | Insert (const Standard_Integer where, const Standard_ExtCharacter what)
| Insert a ExtCharacter at position <where>. Example: aString contains "hy not ?" aString.Insert(1,'W'); gives "Why not ?" aString contains "Wh" aString.Insert(3,'y'); gives "Why" aString contains "Way" aString.Insert(2,'h'); gives "Why" .
Standard_EXPORT void | Insert (const Standard_Integer where, const Handle(TCollection_HExtendedString)&what)
| Insert a HExtendedString at position <where>. .
Standard_EXPORT Standard_Boolean | IsLess (const Handle(TCollection_HExtendedString)&other) const
| Returns TRUE if <me> is less than <other>. .
Standard_EXPORT Standard_Boolean | IsGreater (const Handle(TCollection_HExtendedString)&other) const
| Returns TRUE if <me> is greater than <other>. .
Standard_EXPORT Standard_Boolean | IsAscii () const
| Returns True if the string contains only "Ascii Range" characters .
Standard_EXPORT Standard_Integer | Length () const
| Returns number of characters in <me>. This is the same functionality as 'strlen' in C. .
Standard_EXPORT void | Remove (const Standard_Integer where, const Standard_Integer ahowmany=1)
| Erases <ahowmany> characters from position <where>, <where> included. Example: aString contains "Hello" aString.Erase(2,2) erases 2 characters from position 1 This gives "Hlo". .
Standard_EXPORT void | RemoveAll (const Standard_ExtCharacter what)
| Removes every <what> characters from <me>. .
Standard_EXPORT void | SetValue (const Standard_Integer where, const Standard_ExtCharacter what)
| Replaces one character in the string at position <where>. If <where> is less than zero or greater than the length of <me> an exception is raised. Example: aString contains "Garbake" astring.Replace(6,'g') gives <me> = "Garbage" .
Standard_EXPORT void | SetValue (const Standard_Integer where, const Handle(TCollection_HExtendedString)&what)
| Replaces a part of <me> by another string. .
Standard_EXPORT Handle_TCollection_HExtendedString | Split (const Standard_Integer where)
| Splits a ExtendedString into two sub-strings. Example: aString contains "abcdefg" aString.Split(3) gives <me> = "abc" and returns "defg" .
Standard_EXPORT Standard_Integer | Search (const Handle(TCollection_HExtendedString)&what) const
| Searches a String in <me> from the beginning and returns position of first item <what> matching. It returns -1 if not found. .
Standard_EXPORT Standard_Integer | SearchFromEnd (const Handle(TCollection_HExtendedString)&what) const
| Searches a ExtendedString in another ExtendedString from the end and returns position of first item <what> matching. It returns -1 if not found. .
Standard_EXPORT const Standard_ExtString | ToExtString () const
| Returns pointer to ExtString .
Standard_EXPORT Handle_TCollection_HExtendedString | Token (const Standard_ExtString separators, const Standard_Integer whichone=1) const

Extracts <whichone> token from <me>.
By default, the <separators> is set to space and tabulation.
By default, the token extracted is the first one (whichone = 1).
<separators> contains all separators you need.
If no token indexed by <whichone> is found, it returns an empty String.
Example:
aString contains "This is a message"
aString.Token() returns "This"
aString.Token(" ",4) returns "message"
aString.Token(" ",2) returns "is"
aString.Token(" ",9) returns ""
Other separators than space character and tabulation are allowed
aString contains "1234; test:message , value"
aString.Token("; :,",4) returns "value"
aString.Token("; :,",2) returns "test"
.

Standard_EXPORT void | Trunc (const Standard_Integer ahowmany)
| Truncates <me> to <ahowmany> characters. Example: me = "Hello Dolly" -> Trunc(3) -> me = "Hel" .
Standard_EXPORT Standard_ExtCharacter | Value (const Standard_Integer where) const
| Returns ExtCharacter at position <where> in <me>. If <where> is less than zero or greater than the length of <me>, an exception is raised. Example: aString contains "Hello" aString.Value(2) returns 'e' .
Standard_EXPORT TCollection_ExtendedString | String () const
| Returns the field myString .
Standard_EXPORT void | Print (Standard_OStream &astream) const
| Displays <me> . .
Standard_EXPORT Handle_TCollection_HExtendedString | ShallowCopy () const
Standard_EXPORT void | ShallowDump (Standard_OStream &s) const
Standard_EXPORT Standard_Boolean | IsSameState (const Handle(TCollection_HExtendedString)&other) const
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Private Member Functions

Standard_EXPORT TCollection_ExtendedString & | ChangeString () const
| Returns the field myString .

## Private Attributes

TCollection_ExtendedString | myString

## Constructor & Destructor Documentation

Standard_EXPORT TCollection_HExtendedString::TCollection_HExtendedString | ( |  | ) |

Standard_EXPORT TCollection_HExtendedString::TCollection_HExtendedString | ( | const Standard_CString | message | ) |

Standard_EXPORT TCollection_HExtendedString::TCollection_HExtendedString | ( | const Standard_ExtString | message | ) |

Standard_EXPORT TCollection_HExtendedString::TCollection_HExtendedString | ( | const Standard_ExtCharacter | aChar | ) |

Standard_EXPORT TCollection_HExtendedString::TCollection_HExtendedString | ( | const Standard_Integer | length,
|  | const Standard_ExtCharacter | filler
| ) |

Standard_EXPORT TCollection_HExtendedString::TCollection_HExtendedString | ( | const TCollection_ExtendedString & | aString | ) |

Standard_EXPORT TCollection_HExtendedString::TCollection_HExtendedString | ( | const Handle(TCollection_HAsciiString)& | aString | ) |

Standard_EXPORT TCollection_HExtendedString::TCollection_HExtendedString | ( | const Handle(TCollection_HExtendedString)& | aString | ) |

## Member Function Documentation

Standard_EXPORT void TCollection_HExtendedString::AssignCat | ( | const Handle(TCollection_HExtendedString)& | other | ) |

Standard_EXPORT Handle_TCollection_HExtendedString TCollection_HExtendedString::Cat | ( | const Handle(TCollection_HExtendedString)& | other | ) | const

Standard_EXPORT void TCollection_HExtendedString::ChangeAll | ( | const Standard_ExtCharacter | aChar,
|  | const Standard_ExtCharacter | NewChar
| ) |

Standard_EXPORT TCollection_ExtendedString& TCollection_HExtendedString::ChangeString | ( |  | ) | const`[private]`

Standard_EXPORT void TCollection_HExtendedString::Clear | ( |  | ) |

Standard_EXPORT const TCollection_HExtendedString::Handle | ( | Standard_Type |  | ) | const

| Reimplemented from MMgt_TShared.

Standard_EXPORT void TCollection_HExtendedString::Insert | ( | const Standard_Integer | where,
|  | const Handle(TCollection_HExtendedString)& | what
| ) |

Standard_EXPORT void TCollection_HExtendedString::Insert | ( | const Standard_Integer | where,
|  | const Standard_ExtCharacter | what
| ) |

Standard_EXPORT Standard_Boolean TCollection_HExtendedString::IsAscii | ( |  | ) | const

Standard_EXPORT Standard_Boolean TCollection_HExtendedString::IsEmpty | ( |  | ) | const

Standard_EXPORT Standard_Boolean TCollection_HExtendedString::IsGreater | ( | const Handle(TCollection_HExtendedString)& | other | ) | const

Standard_EXPORT Standard_Boolean TCollection_HExtendedString::IsLess | ( | const Handle(TCollection_HExtendedString)& | other | ) | const

Standard_EXPORT Standard_Boolean TCollection_HExtendedString::IsSameState | ( | const Handle(TCollection_HExtendedString)& | other | ) | const

Standard_EXPORT Standard_Integer TCollection_HExtendedString::Length | ( |  | ) | const

Standard_EXPORT void TCollection_HExtendedString::Print | ( | Standard_OStream & | astream | ) | const

Standard_EXPORT void TCollection_HExtendedString::Remove | ( | const Standard_Integer | where,
|  | const Standard_Integer | ahowmany = `1`
| ) |

Standard_EXPORT void TCollection_HExtendedString::RemoveAll | ( | const Standard_ExtCharacter | what | ) |

Standard_EXPORT Standard_Integer TCollection_HExtendedString::Search | ( | const Handle(TCollection_HExtendedString)& | what | ) | const

Standard_EXPORT Standard_Integer TCollection_HExtendedString::SearchFromEnd | ( | const Handle(TCollection_HExtendedString)& | what | ) | const

Standard_EXPORT void TCollection_HExtendedString::SetValue | ( | const Standard_Integer | where,
|  | const Handle(TCollection_HExtendedString)& | what
| ) |

Standard_EXPORT void TCollection_HExtendedString::SetValue | ( | const Standard_Integer | where,
|  | const Standard_ExtCharacter | what
| ) |

Standard_EXPORT Handle_TCollection_HExtendedString TCollection_HExtendedString::ShallowCopy | ( |  | ) | const

Standard_EXPORT void TCollection_HExtendedString::ShallowDump | ( | Standard_OStream & | s | ) | const`[virtual]`

| Reimplemented from Standard_Transient.

Standard_EXPORT Handle_TCollection_HExtendedString TCollection_HExtendedString::Split | ( | const Standard_Integer | where | ) |

Standard_EXPORT TCollection_ExtendedString TCollection_HExtendedString::String | ( |  | ) | const

Standard_EXPORT const Standard_ExtString TCollection_HExtendedString::ToExtString | ( |  | ) | const

Standard_EXPORT Handle_TCollection_HExtendedString TCollection_HExtendedString::Token | ( | const Standard_ExtString | separators,
|  | const Standard_Integer | whichone = `1`
| ) | const

Standard_EXPORT void TCollection_HExtendedString::Trunc | ( | const Standard_Integer | ahowmany | ) |

Standard_EXPORT Standard_ExtCharacter TCollection_HExtendedString::Value | ( | const Standard_Integer | where | ) | const

## Field Documentation

TCollection_ExtendedString TCollection_HExtendedString::myString `[private]`

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

- TCollection_HExtendedString.hxx