# ApplicationFramework
PTKernel
PCollection

# PCollection_HExtendedString Class Reference

`#include <PCollection_HExtendedString.hxx>`

## Public Member Functions

Standard_EXPORT | PCollection_HExtendedString (const TCollection_ExtendedString &S)
| Creation and initialization with the string S from TCollection. .
Standard_EXPORT | PCollection_HExtendedString (const Standard_ExtCharacter C)
| Creation and initialisation with the character C .
Standard_EXPORT | 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 .
Standard_EXPORT | PCollection_HExtendedString (const Standard_CString astring)
| Creation by converting a CString to an extended string. .
Standard_EXPORT | PCollection_HExtendedString (const Handle(PCollection_HAsciiString)&S)
| Creation by converting a normal Ascii string to an extended string. .
Standard_EXPORT void | Append (const Handle(PCollection_HExtendedString)&S)
| Pushing a string at the end of the string me. .
Standard_EXPORT 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. .
Standard_EXPORT void | ChangeAll (const Standard_ExtCharacter C, const Standard_ExtCharacter NewC)
| Substitutes all the characters equal to C by NewC in the string <me>. .
Standard_EXPORT void | Clear ()
| Removes all characters in the string <me>. Length is equal to zero now. .
Standard_EXPORT TCollection_ExtendedString | Convert () const
| Converts a persistent HExtendedString to a non persistent ExtendedString. .
Standard_EXPORT 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_EXPORT 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. .
Standard_EXPORT 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. .
Standard_EXPORT 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_EXPORT Standard_Boolean | IsAscii () const
| Returns True if the string <me> is in the "Ascii range". .
Standard_EXPORT Standard_Boolean | IsDifferent (const Handle(PCollection_HExtendedString)&other) const
| Test if characters are different between <me> and <other>. .
Standard_EXPORT Standard_Boolean | IsEmpty () const
| Returns True if the string <me> contains zero character. .
Standard_EXPORT Standard_Boolean | IsGreater (const Handle(PCollection_HExtendedString)&other) const
| Returns TRUE if <me> is greater than <other>. .
Standard_EXPORT Standard_Boolean | IsLess (const Handle(PCollection_HExtendedString)&other) const
| Returns TRUE if <me> is less than <other>. .
Standard_EXPORT 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. .
Standard_EXPORT 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". .
Standard_EXPORT 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_EXPORT Standard_Integer | Length () const
| Number of characters of the String .
Standard_EXPORT 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_EXPORT 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. .
Standard_EXPORT void | Prepend (const Handle(PCollection_HExtendedString)&S)
| Pushing a string at the begining of the string <me>. .
Standard_EXPORT void | Print (Standard_OStream &S) const
| Prints the content of <me> on the stream S. .
Standard_EXPORT 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. .
Standard_EXPORT 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. .
Standard_EXPORT void | RemoveAll (const Standard_ExtCharacter C)
| Removes all the occurences of the character C in the string. .
Standard_EXPORT 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". .
Standard_EXPORT 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. .
Standard_EXPORT 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 .
Standard_EXPORT 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. .
Standard_EXPORT Handle_PCollection_HExtendedString | Split (const Standard_Integer Index)
| Splits a string of characters into two sub-strings. .
Standard_EXPORT 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_EXPORT 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_EXPORT Standard_ExtCharacter | Value (const Standard_Integer Index) const
| Returns the character of index Index of the string. .
virtual Standard_EXPORT void | ShallowDump (Standard_OStream &s) const
| PCollection_HExtendedString ()
| PCollection_HExtendedString (const Storage_stCONSTclCOM &a)
const DBC_VArrayOfExtCharacter & | _CSFDB_GetPCollection_HExtendedStringData () const
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Private Member Functions

Standard_EXPORT void | Assign (const DBC_VArrayOfExtCharacter &TheData)
| Assigns the field of the current structure with the given value. .

## Private Attributes

DBC_VArrayOfExtCharacter | Data

## Constructor & Destructor Documentation

Standard_EXPORT PCollection_HExtendedString::PCollection_HExtendedString | ( | const TCollection_ExtendedString & | S | ) |

Standard_EXPORT PCollection_HExtendedString::PCollection_HExtendedString | ( | const Standard_ExtCharacter | C | ) |

Standard_EXPORT PCollection_HExtendedString::PCollection_HExtendedString | ( | const Handle(PCollection_HExtendedString)& | S,
|  | const Standard_Integer | FromIndex,
|  | const Standard_Integer | ToIndex
| ) |

Standard_EXPORT PCollection_HExtendedString::PCollection_HExtendedString | ( | const Standard_CString | astring | ) |

Standard_EXPORT 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]`

Standard_EXPORT void PCollection_HExtendedString::Append | ( | const Handle(PCollection_HExtendedString)& | S | ) |

Standard_EXPORT void PCollection_HExtendedString::Assign | ( | const DBC_VArrayOfExtCharacter & | TheData | ) | `[private]`

Standard_EXPORT void PCollection_HExtendedString::Center | ( | const Standard_Integer | Width,
|  | const Standard_ExtCharacter | Filler
| ) |

Standard_EXPORT void PCollection_HExtendedString::ChangeAll | ( | const Standard_ExtCharacter | C,
|  | const Standard_ExtCharacter | NewC
| ) |

Standard_EXPORT void PCollection_HExtendedString::Clear | ( |  | ) |

Standard_EXPORT TCollection_ExtendedString PCollection_HExtendedString::Convert | ( |  | ) | const

Standard_EXPORT Standard_Integer PCollection_HExtendedString::FirstLocationInSet | ( | const Handle(PCollection_HExtendedString)& | Set,
|  | const Standard_Integer | FromIndex,
|  | const Standard_Integer | ToIndex
| ) | const

Standard_EXPORT Standard_Integer PCollection_HExtendedString::FirstLocationNotInSet | ( | const Handle(PCollection_HExtendedString)& | Set,
|  | const Standard_Integer | FromIndex,
|  | const Standard_Integer | ToIndex
| ) | const

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

Standard_EXPORT void PCollection_HExtendedString::InsertAfter | ( | const Standard_Integer | Index,
|  | const Handle(PCollection_HExtendedString)& | S
| ) |

Standard_EXPORT void PCollection_HExtendedString::InsertBefore | ( | const Standard_Integer | Index,
|  | const Handle(PCollection_HExtendedString)& | S
| ) |

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

Standard_EXPORT Standard_Boolean PCollection_HExtendedString::IsDifferent | ( | const Handle(PCollection_HExtendedString)& | other | ) | const

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

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

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

Standard_EXPORT Standard_Boolean PCollection_HExtendedString::IsSameString | ( | const Handle(PCollection_HExtendedString)& | S | ) | const

Standard_EXPORT void PCollection_HExtendedString::LeftAdjust | ( |  | ) |

Standard_EXPORT void PCollection_HExtendedString::LeftJustify | ( | const Standard_Integer | Width,
|  | const Standard_ExtCharacter | Filler
| ) |

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

Standard_EXPORT Standard_Integer PCollection_HExtendedString::Location | ( | const Handle(PCollection_HExtendedString)& | S,
|  | const Standard_Integer | FromIndex,
|  | const Standard_Integer | ToIndex
| ) | const

Standard_EXPORT Standard_Integer PCollection_HExtendedString::Location | ( | const Standard_Integer | N,
|  | const Standard_ExtCharacter | C,
|  | const Standard_Integer | FromIndex,
|  | const Standard_Integer | ToIndex
| ) | const

Standard_EXPORT void PCollection_HExtendedString::Prepend | ( | const Handle(PCollection_HExtendedString)& | S | ) |

Standard_EXPORT void PCollection_HExtendedString::Print | ( | Standard_OStream & | S | ) | const

Standard_EXPORT void PCollection_HExtendedString::Remove | ( | const Standard_Integer | FromIndex,
|  | const Standard_Integer | ToIndex
| ) |

Standard_EXPORT void PCollection_HExtendedString::Remove | ( | const Standard_Integer | Index | ) |

Standard_EXPORT void PCollection_HExtendedString::RemoveAll | ( | const Standard_ExtCharacter | C | ) |

Standard_EXPORT void PCollection_HExtendedString::RightAdjust | ( |  | ) |

Standard_EXPORT void PCollection_HExtendedString::RightJustify | ( | const Standard_Integer | Width,
|  | const Standard_ExtCharacter | Filler
| ) |

Standard_EXPORT void PCollection_HExtendedString::SetValue | ( | const Standard_Integer | Index,
|  | const Handle(PCollection_HExtendedString)& | S
| ) |

Standard_EXPORT void PCollection_HExtendedString::SetValue | ( | const Standard_Integer | Index,
|  | const Standard_ExtCharacter | C
| ) |

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

Standard_EXPORT Handle_PCollection_HExtendedString PCollection_HExtendedString::Split | ( | const Standard_Integer | Index | ) |

Standard_EXPORT Handle_PCollection_HExtendedString PCollection_HExtendedString::SubString | ( | const Standard_Integer | FromIndex,
|  | const Standard_Integer | ToIndex
| ) | const

Standard_EXPORT Standard_Integer PCollection_HExtendedString::UsefullLength | ( |  | ) | const

Standard_EXPORT Standard_ExtCharacter PCollection_HExtendedString::Value | ( | const Standard_Integer | Index | ) | const

## Field Documentation

DBC_VArrayOfExtCharacter PCollection_HExtendedString::Data`[private]`

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

- PCollection_HExtendedString.hxx