Open CASCADE Technology 6.6.0
Public Member Functions
PCollection_HExtendedString Class Reference

#include <PCollection_HExtendedString.hxx>

Inheritance diagram for PCollection_HExtendedString:
Inheritance graph
[legend]

Public Member Functions

 PCollection_HExtendedString (const TCollection_ExtendedString &S)
 Creation and initialization with the string S from
TCollection.

 PCollection_HExtendedString (const Standard_ExtCharacter C)
 Creation and initialisation with the character C

 PCollection_HExtendedString (const Handle< PCollection_HExtendedString > &S, const Standard_Integer FromIndex, const Standard_Integer ToIndex)
 Creation of a sub-string of the string S
the sub-string starts at the index Fromindex and ends
at the index ToIndex.
Raises an exception if ToIndex is less than FromIndex

 PCollection_HExtendedString (const Standard_CString astring)
 Creation by converting a CString to an extended string.

 PCollection_HExtendedString (const Handle< PCollection_HAsciiString > &S)
 Creation by converting a normal Ascii string to an extended string.

void Append (const Handle< PCollection_HExtendedString > &S)
 Pushing a string at the end of the string me.

void Center (const Standard_Integer Width, const Standard_ExtCharacter Filler)
 Center.
Length becomes equal to Width and the new characters are
equal to Filler.
Raises an exception if Width is less than zero.
If Width < Length nothing happens.

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

void Clear ()
 Removes all characters in the string <me>.
Length is equal to zero now.

TCollection_ExtendedString Convert () const
 Converts a persistent HExtendedString to a non
persistent ExtendedString.

Standard_Integer FirstLocationInSet (const Handle< PCollection_HExtendedString > &Set, const Standard_Integer FromIndex, const Standard_Integer ToIndex) const
 Returns the index of the first character of <Set> founded in <me>.
The search begins to the index FromIndex and ends to the index ToIndex.
Returns zero if failure.
Raises an exception if FromIndex or ToIndex is out of range.

Standard_Integer FirstLocationNotInSet (const Handle< PCollection_HExtendedString > &Set, const Standard_Integer FromIndex, const Standard_Integer ToIndex) const
 Returns the index of the first character of <me>
that is not present in the set <Set>.
The search begins to the index FromIndex and ends to the
the index ToIndex in <me>. Returns zero if failure.
Raises an exception if FromIndex or ToIndex is out of range.

void InsertAfter (const Standard_Integer Index, const Handle< PCollection_HExtendedString > &S)
 Pushing a string after a specific index in the string <me>.
Raises an exception if Index is out of bounds.

void InsertBefore (const Standard_Integer Index, const Handle< PCollection_HExtendedString > &S)
 Pushing a string before a specific index in the string <me>.
Raises an exception if Index is out of bounds.

Standard_Boolean IsAscii () const
 Returns True if the string <me> is in the "Ascii range".

Standard_Boolean IsDifferent (const Handle< PCollection_HExtendedString > &other) const
 Test if characters are different between <me> and <other>.

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

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

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

Standard_Boolean IsSameString (const Handle< PCollection_HExtendedString > &S) const
 Returns True if two strings are equal.
The comparison is case sensitive if the flag is set.

void LeftAdjust ()
 Removes all space characters in the begining of the string.
Raises an exception if the string <me> is not in the "Ascii range".

void LeftJustify (const Standard_Integer Width, const Standard_ExtCharacter Filler)
 Left justify.
Length becomes equal to Width and the new characters are
equal to Filler.
If Width < Length nothing happens.
Raises an exception if Width is less than zero.

Standard_Integer Length () const
 Number of characters of the String

Standard_Integer Location (const Standard_Integer N, const Standard_ExtCharacter C, const Standard_Integer FromIndex, const Standard_Integer ToIndex) const
 Returns the index of the nth occurence of the character C
in the string <me> from the starting index FromIndex to the
ending index ToIndex. Returns zero if failure.
Raises an exception if FromIndex or ToIndex is out of range

Standard_Integer Location (const Handle< PCollection_HExtendedString > &S, const Standard_Integer FromIndex, const Standard_Integer ToIndex) const
 Returns an index in the string <me> of the first occurence
of the string S in the string <me> from the starting index.
FromIndex to the ending index ToIndex.
Returns zero if failure.
Raises an exception if FromIndex or ToIndex is out of range.

void Prepend (const Handle< PCollection_HExtendedString > &S)
 Pushing a string at the begining of the string <me>.

void Print (Standard_OStream &S) const
 Prints the content of <me> on the stream S.

void Remove (const Standard_Integer Index)
 Removes the character located at the index Index in the string.
Raises an exception if Index is out of bounds.

void Remove (const Standard_Integer FromIndex, const Standard_Integer ToIndex)
 Removes all the characters from the index FromIndex to the
index ToIndex.
Raises an exception if FromIndex or ToIndex is out of bounds.

void RemoveAll (const Standard_ExtCharacter C)
 Removes all the occurences of the character C in the string.

void RightAdjust ()
 Removes all space characters at the end of the string.
Raises an exception if the string <me> is not in the Unicod "Ascii range".

void RightJustify (const Standard_Integer Width, const Standard_ExtCharacter Filler)
 Right justify.
Length becomes equal to Width and the new characters are
equal to Filler.
If Width < Length nothing happens.
Raises an exception if Width is less than zero.

void SetValue (const Standard_Integer Index, const Standard_ExtCharacter C)
 Substitutes the character located to the position Index
by the character C.
Raises an exception if the Index is out of bounds

void SetValue (const Standard_Integer Index, const Handle< PCollection_HExtendedString > &S)
 Substitutes from the index Index to the end by the string S.
Raises an exception if Index is out of bounds.

Handle_PCollection_HExtendedString Split (const Standard_Integer Index)
 Splits a string of characters into two sub-strings.

Handle_PCollection_HExtendedString SubString (const Standard_Integer FromIndex, const Standard_Integer ToIndex) const
 Creation of a sub-string of the string <me>.
The sub-string starts to the index FromIndex and ends
to the index ToIndex.
Raises an exception if ToIndex or FromIndex is out of bounds.

Standard_Integer UsefullLength () const
 Length of the string ignoring all spaces (' ') and the
control character at the end.
Raises an exception if the string <me> is not in the "Ascii range".

Standard_ExtCharacter Value (const Standard_Integer Index) const
 Returns the character of index Index of the string.

virtual void ShallowDump (Standard_OStream &s) const
 PCollection_HExtendedString ()
 PCollection_HExtendedString (const Storage_stCONSTclCOM &a)
const DBC_VArrayOfExtCharacter_CSFDB_GetPCollection_HExtendedStringData () const

Constructor & Destructor Documentation

PCollection_HExtendedString::PCollection_HExtendedString ( const TCollection_ExtendedString S)
PCollection_HExtendedString::PCollection_HExtendedString ( const Standard_ExtCharacter  C)
PCollection_HExtendedString::PCollection_HExtendedString ( const Handle< PCollection_HExtendedString > &  S,
const Standard_Integer  FromIndex,
const Standard_Integer  ToIndex 
)
PCollection_HExtendedString::PCollection_HExtendedString ( const Standard_CString  astring)
PCollection_HExtendedString::PCollection_HExtendedString ( const Handle< PCollection_HAsciiString > &  S)
PCollection_HExtendedString::PCollection_HExtendedString ( ) [inline]
PCollection_HExtendedString::PCollection_HExtendedString ( const Storage_stCONSTclCOM a) [inline]

Member Function Documentation

const DBC_VArrayOfExtCharacter& PCollection_HExtendedString::_CSFDB_GetPCollection_HExtendedStringData ( ) const [inline]
void PCollection_HExtendedString::Append ( const Handle< PCollection_HExtendedString > &  S)
void PCollection_HExtendedString::Center ( const Standard_Integer  Width,
const Standard_ExtCharacter  Filler 
)
void PCollection_HExtendedString::ChangeAll ( const Standard_ExtCharacter  C,
const Standard_ExtCharacter  NewC 
)
void PCollection_HExtendedString::Clear ( )
TCollection_ExtendedString PCollection_HExtendedString::Convert ( ) const
Standard_Integer PCollection_HExtendedString::FirstLocationInSet ( const Handle< PCollection_HExtendedString > &  Set,
const Standard_Integer  FromIndex,
const Standard_Integer  ToIndex 
) const
Standard_Integer PCollection_HExtendedString::FirstLocationNotInSet ( const Handle< PCollection_HExtendedString > &  Set,
const Standard_Integer  FromIndex,
const Standard_Integer  ToIndex 
) const
void PCollection_HExtendedString::InsertAfter ( const Standard_Integer  Index,
const Handle< PCollection_HExtendedString > &  S 
)
void PCollection_HExtendedString::InsertBefore ( const Standard_Integer  Index,
const Handle< PCollection_HExtendedString > &  S 
)
Standard_Boolean PCollection_HExtendedString::IsAscii ( ) const
Standard_Boolean PCollection_HExtendedString::IsDifferent ( const Handle< PCollection_HExtendedString > &  other) const
Standard_Boolean PCollection_HExtendedString::IsEmpty ( ) const
Standard_Boolean PCollection_HExtendedString::IsGreater ( const Handle< PCollection_HExtendedString > &  other) const
Standard_Boolean PCollection_HExtendedString::IsLess ( const Handle< PCollection_HExtendedString > &  other) const
Standard_Boolean PCollection_HExtendedString::IsSameString ( const Handle< PCollection_HExtendedString > &  S) const
void PCollection_HExtendedString::LeftAdjust ( )
void PCollection_HExtendedString::LeftJustify ( const Standard_Integer  Width,
const Standard_ExtCharacter  Filler 
)
Standard_Integer PCollection_HExtendedString::Length ( ) const
Standard_Integer PCollection_HExtendedString::Location ( const Standard_Integer  N,
const Standard_ExtCharacter  C,
const Standard_Integer  FromIndex,
const Standard_Integer  ToIndex 
) const
Standard_Integer PCollection_HExtendedString::Location ( const Handle< PCollection_HExtendedString > &  S,
const Standard_Integer  FromIndex,
const Standard_Integer  ToIndex 
) const
void PCollection_HExtendedString::Prepend ( const Handle< PCollection_HExtendedString > &  S)
void PCollection_HExtendedString::Print ( Standard_OStream S) const
void PCollection_HExtendedString::Remove ( const Standard_Integer  FromIndex,
const Standard_Integer  ToIndex 
)
void PCollection_HExtendedString::Remove ( const Standard_Integer  Index)
void PCollection_HExtendedString::RemoveAll ( const Standard_ExtCharacter  C)
void PCollection_HExtendedString::RightAdjust ( )
void PCollection_HExtendedString::RightJustify ( const Standard_Integer  Width,
const Standard_ExtCharacter  Filler 
)
void PCollection_HExtendedString::SetValue ( const Standard_Integer  Index,
const Standard_ExtCharacter  C 
)
void PCollection_HExtendedString::SetValue ( const Standard_Integer  Index,
const Handle< PCollection_HExtendedString > &  S 
)
virtual void PCollection_HExtendedString::ShallowDump ( Standard_OStream s) const [virtual]

Reimplemented from Standard_Persistent.

Handle_PCollection_HExtendedString PCollection_HExtendedString::Split ( const Standard_Integer  Index)
Handle_PCollection_HExtendedString PCollection_HExtendedString::SubString ( const Standard_Integer  FromIndex,
const Standard_Integer  ToIndex 
) const
Standard_Integer PCollection_HExtendedString::UsefullLength ( ) const
Standard_ExtCharacter PCollection_HExtendedString::Value ( const Standard_Integer  Index) const

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