Open CASCADE Technology 6.6.0
Public Member Functions
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.
More...

#include <TCollection_HExtendedString.hxx>

Inheritance diagram for TCollection_HExtendedString:
Inheritance graph
[legend]

Public Member Functions

 TCollection_HExtendedString ()
 Initializes a HExtendedString to an empty ExtendedString.

 TCollection_HExtendedString (const Standard_CString message)
 Initializes a HExtendedString with a CString.

 TCollection_HExtendedString (const Standard_ExtString message)
 Initializes a HExtendedString with an ExtString.

 TCollection_HExtendedString (const Standard_ExtCharacter aChar)
 Initializes a HExtendedString with a single character.

 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.

 TCollection_HExtendedString (const TCollection_ExtendedString &aString)
 Initializes a HExtendedString with a HExtendedString.

 TCollection_HExtendedString (const Handle< TCollection_HAsciiString > &aString)
 Initializes a HExtendedString with an HAsciiString.

 TCollection_HExtendedString (const Handle< TCollection_HExtendedString > &aString)
 Initializes a HExtendedString with a HExtendedString.

void AssignCat (const Handle< TCollection_HExtendedString > &other)
 Appends <other> to me.

Handle_TCollection_HExtendedString Cat (const Handle< TCollection_HExtendedString > &other) const
 Returns a string appending <other> to me.

void ChangeAll (const Standard_ExtCharacter aChar, const Standard_ExtCharacter NewChar)
 Substitutes all the characters equal to aChar by NewChar
in the string <me>.

void Clear ()
 Removes all characters contained in <me>.
This produces an empty ExtendedString.

Standard_Boolean IsEmpty () const
 Returns True if the string <me> contains zero character

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"

void Insert (const Standard_Integer where, const Handle< TCollection_HExtendedString > &what)
 Insert a HExtendedString at position <where>.

Standard_Boolean IsLess (const Handle< TCollection_HExtendedString > &other) const
 Returns TRUE if <me> is less than <other>.

Standard_Boolean IsGreater (const Handle< TCollection_HExtendedString > &other) const
 Returns TRUE if <me> is greater than <other>.

Standard_Boolean IsAscii () const
 Returns True if the string contains only "Ascii Range" characters

Standard_Integer Length () const
 Returns number of characters in <me>.
This is the same functionality as 'strlen' in C.

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".

void RemoveAll (const Standard_ExtCharacter what)
 Removes every <what> characters from <me>.

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"

void SetValue (const Standard_Integer where, const Handle< TCollection_HExtendedString > &what)
 Replaces a part of <me> by another string.

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_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_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.

const Standard_ExtString ToExtString () const
 Returns pointer to ExtString

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"

void Trunc (const Standard_Integer ahowmany)
 Truncates <me> to <ahowmany> characters.
Example: me = "Hello Dolly" -> Trunc(3) -> me = "Hel"

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'

const TCollection_ExtendedStringString () const
 Returns the field myString

void Print (Standard_OStream &astream) const
 Displays <me> .

Handle_TCollection_HExtendedString ShallowCopy () const
void ShallowDump (Standard_OStream &s) const
Standard_Boolean IsSameState (const Handle< TCollection_HExtendedString > &other) const

Detailed Description


Constructor & Destructor Documentation

TCollection_HExtendedString::TCollection_HExtendedString ( )
TCollection_HExtendedString::TCollection_HExtendedString ( const Standard_CString  message)
TCollection_HExtendedString::TCollection_HExtendedString ( const Standard_ExtString  message)
TCollection_HExtendedString::TCollection_HExtendedString ( const Standard_ExtCharacter  aChar)
TCollection_HExtendedString::TCollection_HExtendedString ( const Standard_Integer  length,
const Standard_ExtCharacter  filler 
)
TCollection_HExtendedString::TCollection_HExtendedString ( const TCollection_ExtendedString aString)
TCollection_HExtendedString::TCollection_HExtendedString ( const Handle< TCollection_HAsciiString > &  aString)
TCollection_HExtendedString::TCollection_HExtendedString ( const Handle< TCollection_HExtendedString > &  aString)

Member Function Documentation

void TCollection_HExtendedString::AssignCat ( const Handle< TCollection_HExtendedString > &  other)
Handle_TCollection_HExtendedString TCollection_HExtendedString::Cat ( const Handle< TCollection_HExtendedString > &  other) const
void TCollection_HExtendedString::ChangeAll ( const Standard_ExtCharacter  aChar,
const Standard_ExtCharacter  NewChar 
)
void TCollection_HExtendedString::Clear ( )
void TCollection_HExtendedString::Insert ( const Standard_Integer  where,
const Standard_ExtCharacter  what 
)
void TCollection_HExtendedString::Insert ( const Standard_Integer  where,
const Handle< TCollection_HExtendedString > &  what 
)
Standard_Boolean TCollection_HExtendedString::IsAscii ( ) const
Standard_Boolean TCollection_HExtendedString::IsEmpty ( ) const
Standard_Boolean TCollection_HExtendedString::IsGreater ( const Handle< TCollection_HExtendedString > &  other) const
Standard_Boolean TCollection_HExtendedString::IsLess ( const Handle< TCollection_HExtendedString > &  other) const
Standard_Boolean TCollection_HExtendedString::IsSameState ( const Handle< TCollection_HExtendedString > &  other) const
Standard_Integer TCollection_HExtendedString::Length ( ) const
void TCollection_HExtendedString::Print ( Standard_OStream astream) const
void TCollection_HExtendedString::Remove ( const Standard_Integer  where,
const Standard_Integer  ahowmany = 1 
)
void TCollection_HExtendedString::RemoveAll ( const Standard_ExtCharacter  what)
Standard_Integer TCollection_HExtendedString::Search ( const Handle< TCollection_HExtendedString > &  what) const
Standard_Integer TCollection_HExtendedString::SearchFromEnd ( const Handle< TCollection_HExtendedString > &  what) const
void TCollection_HExtendedString::SetValue ( const Standard_Integer  where,
const Handle< TCollection_HExtendedString > &  what 
)
void TCollection_HExtendedString::SetValue ( const Standard_Integer  where,
const Standard_ExtCharacter  what 
)
Handle_TCollection_HExtendedString TCollection_HExtendedString::ShallowCopy ( ) const
void TCollection_HExtendedString::ShallowDump ( Standard_OStream s) const [virtual]

Reimplemented from Standard_Transient.

Handle_TCollection_HExtendedString TCollection_HExtendedString::Split ( const Standard_Integer  where)
const TCollection_ExtendedString& TCollection_HExtendedString::String ( ) const
const Standard_ExtString TCollection_HExtendedString::ToExtString ( ) const
Handle_TCollection_HExtendedString TCollection_HExtendedString::Token ( const Standard_ExtString  separators,
const Standard_Integer  whichone = 1 
) const
void TCollection_HExtendedString::Trunc ( const Standard_Integer  ahowmany)
Standard_ExtCharacter TCollection_HExtendedString::Value ( const Standard_Integer  where) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines