| 
    Open CASCADE Technology
    6.9.1
    
   | 
 
#include <PCollection_HAsciiString.hxx>

Public Member Functions | |
| PCollection_HAsciiString (const Standard_CString S) | |
| Creation and initialization with the string S.  More... | |
| PCollection_HAsciiString (const TCollection_AsciiString &S) | |
| Creation and initialization with the string S from TCollection.  More... | |
| PCollection_HAsciiString (const Standard_Character C) | |
| Creation and initialization with the character C.  More... | |
| 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.  More... | |
| 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".  More... | |
| 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.  More... | |
| 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.  More... | |
| void | Append (const Handle< PCollection_HAsciiString > &S) | 
| Pushing a string at the end of the string me.  More... | |
| void | Capitalize () | 
| Converts the first character into its corresponding upper-case character and the other characters into lowercase.  More... | |
| 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  More... | |
| 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.  More... | |
| void | Clear () | 
| Remove all characters in the string <me>. Length is equal to zero now.  More... | |
| TCollection_AsciiString | Convert () const | 
| Converts a persistent HAsciiString to a non persistent AsciiString.  More... | |
| 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.  More... | |
| 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.  More... | |
| 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.  More... | |
| 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.  More... | |
| 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.  More... | |
| Standard_Boolean | IsDifferent (const Handle< PCollection_HAsciiString > &other) const | 
| Test if characters are different between <me> and <other>.  More... | |
| Standard_Boolean | IsEmpty () const | 
| Returns True if the string <me> contains zero character.  More... | |
| Standard_Boolean | IsGreater (const Handle< PCollection_HAsciiString > &other) const | 
| Returns TRUE if <me> is 'ASCII' greater than <other>.  More... | |
| Standard_Boolean | IsIntegerValue () const | 
| Returns True if the string contains an integer value.  More... | |
| Standard_Boolean | IsLess (const Handle< PCollection_HAsciiString > &other) const | 
| Returns TRUE if <me> is 'ASCII' less than <other>.  More... | |
| Standard_Boolean | IsRealValue () const | 
| Returns True if the string contains an Real value.  More... | |
| Standard_Boolean | IsSameString (const Handle< PCollection_HAsciiString > &S) const | 
| Returns True if two strings are equal. The comparison is case sensitive.  More... | |
| 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.  More... | |
| void | LeftAdjust () | 
| Removes all space characters in the begining of the string.  More... | |
| 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.  More... | |
| Standard_Integer | Length () const | 
| Number of characters of the String.  More... | |
| 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.  More... | |
| 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.  More... | |
| 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".  More... | |
| 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".  More... | |
| void | Print (Standard_OStream &S) const | 
| Prints the content of <me> on the stream S.  More... | |
| 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.  More... | |
| 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.  More... | |
| 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.  More... | |
| void | RemoveAll (const Standard_Character C, const Standard_Boolean CaseSensitive) | 
| Removes all the occurences of the character C in the string.  More... | |
| void | RightAdjust () | 
| Removes all space characters at the end of the string.  More... | |
| 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.  More... | |
| 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.  More... | |
| 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.  More... | |
| Handle< PCollection_HAsciiString > | Split (const Standard_Integer Index) | 
| Splits a string of characters into two sub-strings.  More... | |
| 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.  More... | |
| 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>.  More... | |
| void | Uppercase () | 
| Transforms all the characters into upper-case. If there is no corresponding upper-case character, the character is unchanged.  More... | |
| Standard_Integer | UsefullLength () const | 
| Length of the string ignoring all spaces (' ') and the control character at the end.  More... | |
| Standard_Character | Value (const Standard_Integer Index) const | 
| Returns the character of index Index of the string.  More... | |
| PCollection_HAsciiString () | |
| PCollection_HAsciiString (const Storage_stCONSTclCOM &a) | |
| const DBC_VArrayOfCharacter & | _CSFDB_GetPCollection_HAsciiStringData () const | 
  Public Member Functions inherited from Standard_Persistent | |
| virtual Handle_Standard_Persistent | This () const | 
| virtual void | Delete () const | 
| virtual | ~Standard_Persistent () | 
| Standard_Persistent & | operator= (const Standard_Persistent &) | 
| Standard_Persistent () | |
| Standard_Persistent (const Standard_Persistent &) | |
| Standard_Persistent (const Storage_stCONSTclCOM &) | |
| virtual const Handle_Standard_Type & | DynamicType () const | 
| Standard_Boolean | IsKind (const Handle_Standard_Type &) const | 
| Standard_Boolean | IsInstance (const Handle_Standard_Type &) const | 
| virtual Handle_Standard_Persistent | This () const | 
| virtual void | Delete () const | 
| virtual | ~Standard_Persistent () | 
| Standard_Persistent & | operator= (const Standard_Persistent &) | 
| Standard_Persistent () | |
| Standard_Persistent (const Standard_Persistent &) | |
| Standard_Persistent (const Storage_stCONSTclCOM &) | |
| virtual const Handle_Standard_Type & | DynamicType () const | 
| Standard_Boolean | IsKind (const Handle_Standard_Type &) const | 
| Standard_Boolean | IsInstance (const Handle_Standard_Type &) const | 
| PCollection_HAsciiString::PCollection_HAsciiString | ( | const Standard_CString | S | ) | 
Creation and initialization with the string S.
| PCollection_HAsciiString::PCollection_HAsciiString | ( | const TCollection_AsciiString & | S | ) | 
Creation and initialization with the string S from TCollection.
| PCollection_HAsciiString::PCollection_HAsciiString | ( | const Standard_Character | C | ) | 
Creation and initialization with the character C.
| PCollection_HAsciiString::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.
| PCollection_HAsciiString::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".
| PCollection_HAsciiString::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.
| PCollection_HAsciiString::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.
      
  | 
  inline | 
      
  | 
  inline | 
      
  | 
  inline | 
| void PCollection_HAsciiString::Append | ( | const Handle< PCollection_HAsciiString > & | S | ) | 
Pushing a string at the end of the string me.
| void PCollection_HAsciiString::Capitalize | ( | ) | 
Converts the first character into its corresponding upper-case character and the other characters into lowercase.
| void PCollection_HAsciiString::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
| void PCollection_HAsciiString::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.
| void PCollection_HAsciiString::Clear | ( | ) | 
Remove all characters in the string <me>. Length is equal to zero now.
| TCollection_AsciiString PCollection_HAsciiString::Convert | ( | ) | const | 
Converts a persistent HAsciiString to a non persistent AsciiString.
| Standard_Integer PCollection_HAsciiString::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_Integer PCollection_HAsciiString::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.
| void PCollection_HAsciiString::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.
| void PCollection_HAsciiString::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_Integer PCollection_HAsciiString::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_Boolean PCollection_HAsciiString::IsDifferent | ( | const Handle< PCollection_HAsciiString > & | other | ) | const | 
Test if characters are different between <me> and <other>.
| Standard_Boolean PCollection_HAsciiString::IsEmpty | ( | ) | const | 
Returns True if the string <me> contains zero character.
| Standard_Boolean PCollection_HAsciiString::IsGreater | ( | const Handle< PCollection_HAsciiString > & | other | ) | const | 
Returns TRUE if <me> is 'ASCII' greater than <other>.
| Standard_Boolean PCollection_HAsciiString::IsIntegerValue | ( | ) | const | 
Returns True if the string contains an integer value.
| Standard_Boolean PCollection_HAsciiString::IsLess | ( | const Handle< PCollection_HAsciiString > & | other | ) | const | 
Returns TRUE if <me> is 'ASCII' less than <other>.
| Standard_Boolean PCollection_HAsciiString::IsRealValue | ( | ) | const | 
Returns True if the string contains an Real value.
| Standard_Boolean PCollection_HAsciiString::IsSameString | ( | const Handle< PCollection_HAsciiString > & | S | ) | const | 
Returns True if two strings are equal. The comparison is case sensitive.
| Standard_Boolean PCollection_HAsciiString::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.
| void PCollection_HAsciiString::LeftAdjust | ( | ) | 
Removes all space characters in the begining of the string.
| void PCollection_HAsciiString::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_Integer PCollection_HAsciiString::Length | ( | ) | const | 
Number of characters of the String.
| Standard_Integer PCollection_HAsciiString::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_Integer PCollection_HAsciiString::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.
| void PCollection_HAsciiString::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".
| void PCollection_HAsciiString::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".
| void PCollection_HAsciiString::Print | ( | Standard_OStream & | S | ) | const | 
Prints the content of <me> on the stream S.
| Standard_Real PCollection_HAsciiString::RealValue | ( | ) | const | 
Returns the real value corresponding to the string <me>. Raises an exception if the string does not correspond to a real value.
| void PCollection_HAsciiString::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 PCollection_HAsciiString::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 PCollection_HAsciiString::RemoveAll | ( | const Standard_Character | C, | 
| const Standard_Boolean | CaseSensitive | ||
| ) | 
Removes all the occurences of the character C in the string.
| void PCollection_HAsciiString::RightAdjust | ( | ) | 
Removes all space characters at the end of the string.
| void PCollection_HAsciiString::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.
| void PCollection_HAsciiString::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.
| void PCollection_HAsciiString::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.
| Handle< PCollection_HAsciiString > PCollection_HAsciiString::Split | ( | const Standard_Integer | Index | ) | 
Splits a string of characters into two sub-strings.
| Handle< PCollection_HAsciiString > 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.
| Handle< PCollection_HAsciiString > 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>.
| void PCollection_HAsciiString::Uppercase | ( | ) | 
Transforms all the characters into upper-case. If there is no corresponding upper-case character, the character is unchanged.
| Standard_Integer PCollection_HAsciiString::UsefullLength | ( | ) | const | 
Length of the string ignoring all spaces (' ') and the control character at the end.
| Standard_Character PCollection_HAsciiString::Value | ( | const Standard_Integer | Index | ) | const | 
Returns the character of index Index of the string.
 1.8.10