# ApplicationFramework
PTKernel
PCollection

# PCollection_HAsciiString Class Reference

`#include <PCollection_HAsciiString.hxx>`

## Public Member Functions

Standard_EXPORT | PCollection_HAsciiString (const Standard_CString S)
| Creation and initialization with the string S. .
Standard_EXPORT | PCollection_HAsciiString (const TCollection_AsciiString &S)
| Creation and initialization with the string S from TCollection. .
Standard_EXPORT | PCollection_HAsciiString (const Standard_Character C)
| Creation and initialization with the character C. .
Standard_EXPORT | PCollection_HAsciiString (const Handle(PCollection_HAsciiString)&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 .
Standard_EXPORT | PCollection_HAsciiString (const Handle(PCollection_HExtendedString)&S)
| Creation by converting an extended string to a normal string. Raises OutOfRange if the String is not in the "Ascii range". .
Standard_EXPORT | PCollection_HAsciiString (const Standard_Real R, const Standard_CString F="%f")
| Creation and initialization by converting the real value into a string. F describes a format using "C" conventions. .
Standard_EXPORT | PCollection_HAsciiString (const Standard_Integer I, const Standard_CString F="%d")
| Creation and initialization by converting the Integer value into a string. F describes a format using "C" conventions. .
Standard_EXPORT void | Append (const Handle(PCollection_HAsciiString)&S)
| Pushing a string at the end of the string me .
Standard_EXPORT void | Capitalize ()
| Converts the first character into its corresponding upper-case character and the other characters into lowercase .
Standard_EXPORT void | Center (const Standard_Integer Width, const Standard_Character 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_Character C, const Standard_Character NewC, const Standard_Boolean CaseSensitive)
| Substitutes all the characters equal to C by NewC in the string <me>.The substition can be case sensitive. .
Standard_EXPORT void | Clear ()
| Remove all characters in the string <me>. Length is equal to zero now. .
Standard_EXPORT TCollection_AsciiString | Convert () const
| Converts a persistent HAsciiString to a non persistent AsciiString. .
Standard_EXPORT Standard_Integer | FirstLocationInSet (const Handle(PCollection_HAsciiString)&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 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_HAsciiString)&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_HAsciiString)&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_HAsciiString)&S)
| Pushing a string before a specific index in the string <me> Raises an exception if Index is out of bounds .
Standard_EXPORT Standard_Integer | IntegerValue () const
| Returns the integer value corresponding to the string <me> Raises an exception if the string does not correspond to an integer value. .
Standard_EXPORT Standard_Boolean | IsDifferent (const Handle(PCollection_HAsciiString)&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_HAsciiString)&other) const
| Returns TRUE if <me> is 'ASCII' greater than <other>. .
Standard_EXPORT Standard_Boolean | IsIntegerValue () const
| Returns True if the string contains an integer value. .
Standard_EXPORT Standard_Boolean | IsLess (const Handle(PCollection_HAsciiString)&other) const
| Returns TRUE if <me> is 'ASCII' less than <other>. .
Standard_EXPORT Standard_Boolean | IsRealValue () const
| Returns True if the string contains an Real value. .
Standard_EXPORT Standard_Boolean | IsSameString (const Handle(PCollection_HAsciiString)&S) const
| Returns True if two strings are equal. The comparison is case sensitive. .
Standard_EXPORT Standard_Boolean | IsSameString (const Handle(PCollection_HAsciiString)&S, const Standard_Boolean CaseSensitive) 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. .
Standard_EXPORT void | LeftJustify (const Standard_Integer Width, const Standard_Character 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_Character 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_HAsciiString)&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 | Lowercase ()
| Converts any upper-case character to its corresponding lower-case character in the string <me>. If there is no corresponding lower-case character, the character is unchanged before me = "aBAcd123" after me = "abacd123" .
Standard_EXPORT void | Prepend (const Handle(PCollection_HAsciiString)&S)
| Pushing a string at the begining of the string <me> before me = "cde" , S = "ab" after me = "abcde" , S = "ab" .
Standard_EXPORT void | Print (Standard_OStream &S) const
| Prints the content of <me> on the stream S. .
Standard_EXPORT Standard_Real | RealValue () const
| Returns the real value corresponding to the string <me>. Raises an exception if the string does not correspond to a real value. .
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_Character C, const Standard_Boolean CaseSensitive)
| 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. .
Standard_EXPORT void | RightJustify (const Standard_Integer Width, const Standard_Character 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_Character 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_HAsciiString)&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_HAsciiString | Split (const Standard_Integer Index)
| Splits a string of characters into two sub-strings. .
Standard_EXPORT Handle_PCollection_HAsciiString | 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 Handle_PCollection_HAsciiString | Token (const Standard_CString separators=" \t", const Standard_Integer whichone=1) const
| Extracts <astring> token from <me>. The token extracted is the indice number <num>. .
Standard_EXPORT void | Uppercase ()
| Transforms all the characters into upper-case. If there is no corresponding upper-case character, the character is unchanged. .
Standard_EXPORT Standard_Integer | UsefullLength () const
| Length of the string ignoring all spaces (' ') and the control character at the end. .
Standard_EXPORT Standard_Character | 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_HAsciiString ()
| PCollection_HAsciiString (const Storage_stCONSTclCOM &a)
const DBC_VArrayOfCharacter & | _CSFDB_GetPCollection_HAsciiStringData () const
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Private Member Functions

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

## Private Attributes

DBC_VArrayOfCharacter | Data

## Constructor & Destructor Documentation

Standard_EXPORT PCollection_HAsciiString::PCollection_HAsciiString | ( | const Standard_CString | S | ) |

Standard_EXPORT PCollection_HAsciiString::PCollection_HAsciiString | ( | const TCollection_AsciiString & | S | ) |

Standard_EXPORT PCollection_HAsciiString::PCollection_HAsciiString | ( | const Standard_Character | C | ) |

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

Standard_EXPORT PCollection_HAsciiString::PCollection_HAsciiString | ( | const Handle(PCollection_HExtendedString)& | S | ) |

Standard_EXPORT PCollection_HAsciiString::PCollection_HAsciiString | ( | const Standard_Real | R,
|  | const Standard_CString | F = `"%f"`
| ) |

Standard_EXPORT PCollection_HAsciiString::PCollection_HAsciiString | ( | const Standard_Integer | I,
|  | const Standard_CString | F = `"%d"`
| ) |

PCollection_HAsciiString::PCollection_HAsciiString | ( |  | ) | `[inline]`

PCollection_HAsciiString::PCollection_HAsciiString | ( | const Storage_stCONSTclCOM & | a | ) | `[inline]`

## Member Function Documentation

const DBC_VArrayOfCharacter& PCollection_HAsciiString::_CSFDB_GetPCollection_HAsciiStringData | ( |  | ) | const`[inline]`

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

Standard_EXPORT void PCollection_HAsciiString::Assign | ( | const DBC_VArrayOfCharacter & | TheData | ) | `[private]`

Standard_EXPORT void PCollection_HAsciiString::Capitalize | ( |  | ) |

Standard_EXPORT void PCollection_HAsciiString::Center | ( | const Standard_Integer | Width,
|  | const Standard_Character | Filler
| ) |

Standard_EXPORT void PCollection_HAsciiString::ChangeAll | ( | const Standard_Character | C,
|  | const Standard_Character | NewC,
|  | const Standard_Boolean | CaseSensitive
| ) |

Standard_EXPORT void PCollection_HAsciiString::Clear | ( |  | ) |

Standard_EXPORT TCollection_AsciiString PCollection_HAsciiString::Convert | ( |  | ) | const

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

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

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

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

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

Standard_EXPORT Standard_Integer PCollection_HAsciiString::IntegerValue | ( |  | ) | const

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

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

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

Standard_EXPORT Standard_Boolean PCollection_HAsciiString::IsIntegerValue | ( |  | ) | const

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

Standard_EXPORT Standard_Boolean PCollection_HAsciiString::IsRealValue | ( |  | ) | const

Standard_EXPORT Standard_Boolean PCollection_HAsciiString::IsSameString | ( | const Handle(PCollection_HAsciiString)& | S,
|  | const Standard_Boolean | CaseSensitive
| ) | const

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

Standard_EXPORT void PCollection_HAsciiString::LeftAdjust | ( |  | ) |

Standard_EXPORT void PCollection_HAsciiString::LeftJustify | ( | const Standard_Integer | Width,
|  | const Standard_Character | Filler
| ) |

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

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

Standard_EXPORT Standard_Integer PCollection_HAsciiString::Location | ( | const Standard_Integer | N,
|  | const Standard_Character | C,
|  | const Standard_Integer | FromIndex,
|  | const Standard_Integer | ToIndex
| ) | const

Standard_EXPORT void PCollection_HAsciiString::Lowercase | ( |  | ) |

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

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

Standard_EXPORT Standard_Real PCollection_HAsciiString::RealValue | ( |  | ) | const

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

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

Standard_EXPORT void PCollection_HAsciiString::RemoveAll | ( | const Standard_Character | C,
|  | const Standard_Boolean | CaseSensitive
| ) |

Standard_EXPORT void PCollection_HAsciiString::RightAdjust | ( |  | ) |

Standard_EXPORT void PCollection_HAsciiString::RightJustify | ( | const Standard_Integer | Width,
|  | const Standard_Character | Filler
| ) |

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

Standard_EXPORT void PCollection_HAsciiString::SetValue | ( | const Standard_Integer | Index,
|  | const Standard_Character | C
| ) |

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

Standard_EXPORT Handle_PCollection_HAsciiString PCollection_HAsciiString::Split | ( | const Standard_Integer | Index | ) |

Standard_EXPORT Handle_PCollection_HAsciiString PCollection_HAsciiString::SubString | ( | const Standard_Integer | FromIndex,
|  | const Standard_Integer | ToIndex
| ) | const

Standard_EXPORT Handle_PCollection_HAsciiString PCollection_HAsciiString::Token | ( | const Standard_CString | separators = `" \t"`,
|  | const Standard_Integer | whichone = `1`
| ) | const

Standard_EXPORT void PCollection_HAsciiString::Uppercase | ( |  | ) |

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

Standard_EXPORT Standard_Character PCollection_HAsciiString::Value | ( | const Standard_Integer | Index | ) | const

## Field Documentation

DBC_VArrayOfCharacter PCollection_HAsciiString::Data `[private]`

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

- PCollection_HAsciiString.hxx