#include <PCollection_HExtendedString.hxx>

Inheritance diagram for PCollection_HExtendedString:

Public Member Functions
	PCollection_HExtendedString (const TCollection_ExtendedString &S)
	Creation and initialization with the string S from <br> TCollection. More...

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

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

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

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

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

void	Center (const Standard_Integer Width, const Standard_ExtCharacter Filler)
	Center. <br> 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_ExtCharacter C, const Standard_ExtCharacter NewC)
	Substitutes all the characters equal to C by NewC in the <br> string <me>. More...

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

TCollection_ExtendedString	Convert () const
	Converts a persistent HExtendedString to a non <br> persistent ExtendedString. More...

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>. <br> 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. More...

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> <br> 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_HExtendedString > &S)
	Pushing a string after a specific index in the string <me>. <br> Raises an exception if Index is out of bounds. More...

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

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

Standard_Boolean	IsDifferent (const Handle< PCollection_HExtendedString > &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_HExtendedString > &other) const
	Returns TRUE if <me> is greater than <other>. More...

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

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

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

void	LeftJustify (const Standard_Integer Width, const Standard_ExtCharacter Filler)
	Left justify. <br> 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_ExtCharacter C, const Standard_Integer FromIndex, const Standard_Integer ToIndex) const
	Returns the index of the nth occurence of the character C <br> 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_HExtendedString > &S, const Standard_Integer FromIndex, const Standard_Integer ToIndex) const
	Returns an index in the string <me> of the first occurence <br> 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	Prepend (const Handle< PCollection_HExtendedString > &S)
	Pushing a string at the begining of the string <me>. More...

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

void	Remove (const Standard_Integer Index)
	Removes the character located at the index Index in the string. <br> 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 <br> index ToIndex. Raises an exception if FromIndex or ToIndex is out of bounds. More...

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

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

void	RightJustify (const Standard_Integer Width, const Standard_ExtCharacter Filler)
	Right justify. <br> 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_ExtCharacter C)
	Substitutes the character located to the position Index <br> by the character C. Raises an exception if the Index is out of bounds More...

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

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

Handle_PCollection_HExtendedString	SubString (const Standard_Integer FromIndex, const Standard_Integer ToIndex) const
	Creation of a sub-string of the string <me>. <br> 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...

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

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

virtual void	ShallowDump (Standard_OStream &s) const

	PCollection_HExtendedString ()

	PCollection_HExtendedString (const Storage_stCONSTclCOM &a)

const DBC_VArrayOfExtCharacter &	_CSFDB_GetPCollection_HExtendedStringData () const

Public Member Functions inherited from Standard_Persistent
virtual Handle_Standard_Persistent	This () const

virtual Handle_Standard_Persistent	ShallowCopy () 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 Handle_Standard_Persistent	ShallowCopy () 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

Constructor & Destructor Documentation

PCollection_HExtendedString::PCollection_HExtendedString ( const TCollection_ExtendedString & S )

 Creation and initialization with the string S from <br>

TCollection.

PCollection_HExtendedString::PCollection_HExtendedString ( const Standard_ExtCharacter C )

Creation and initialisation with the character C

PCollection_HExtendedString::PCollection_HExtendedString	(	const Handle< PCollection_HExtendedString > &	S,
		const Standard_Integer	FromIndex,
		const Standard_Integer	ToIndex
	)

 Creation of a sub-string of the string S <br>

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::PCollection_HExtendedString ( const Standard_CString astring )

Creation by converting a CString to an extended string.

PCollection_HExtendedString::PCollection_HExtendedString ( const Handle< PCollection_HAsciiString > & S )

Creation by converting a normal Ascii string to an extended string.

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 )

Pushing a string at the end of the string me.

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

 Center. <br>

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_HExtendedString::ChangeAll	(	const Standard_ExtCharacter	C,
		const Standard_ExtCharacter	NewC
	)

 Substitutes all the characters equal to C by NewC in the <br>

string <me>.

void PCollection_HExtendedString::Clear ( )

 Removes all characters in the string <me>. <br>

Length is equal to zero now.

TCollection_ExtendedString PCollection_HExtendedString::Convert ( ) const

 Converts a persistent HExtendedString to a non <br>

persistent ExtendedString.

Standard_Integer PCollection_HExtendedString::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>. <br>

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 PCollection_HExtendedString::FirstLocationNotInSet	(	const Handle< PCollection_HExtendedString > &	Set,
		const Standard_Integer	FromIndex,
		const Standard_Integer	ToIndex
	)		const

 Returns the index of the first character of <me> <br>

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_HExtendedString::InsertAfter	(	const Standard_Integer	Index,
		const Handle< PCollection_HExtendedString > &	S
	)

 Pushing a string after a specific index in the string <me>. <br>

Raises an exception if Index is out of bounds.

void PCollection_HExtendedString::InsertBefore	(	const Standard_Integer	Index,
		const Handle< PCollection_HExtendedString > &	S
	)

 Pushing a string before a specific index in the string <me>. <br>

Raises an exception if Index is out of bounds.

Standard_Boolean PCollection_HExtendedString::IsAscii ( ) const

Returns True if the string <me> is in the "Ascii range".

Standard_Boolean PCollection_HExtendedString::IsDifferent ( const Handle< PCollection_HExtendedString > & other ) const

Test if characters are different between <me> and <other>.

Standard_Boolean PCollection_HExtendedString::IsEmpty ( ) const

Returns True if the string <me> contains zero character.

Standard_Boolean PCollection_HExtendedString::IsGreater ( const Handle< PCollection_HExtendedString > & other ) const

Returns TRUE if <me> is greater than <other>.

Standard_Boolean PCollection_HExtendedString::IsLess ( const Handle< PCollection_HExtendedString > & other ) const

Returns TRUE if <me> is less than <other>.

Standard_Boolean PCollection_HExtendedString::IsSameString ( const Handle< PCollection_HExtendedString > & S ) const

 Returns True if two strings are equal. <br>

The comparison is case sensitive if the flag is set.

void PCollection_HExtendedString::LeftAdjust ( )

 Removes all space characters in the begining of the string. <br>

Raises an exception if the string <me> is not in the "Ascii range".

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

 Left justify. <br>

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_HExtendedString::Length ( ) const

Number of characters of the String

Standard_Integer PCollection_HExtendedString::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 <br>

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_HExtendedString::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 <br>

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_HExtendedString::Prepend ( const Handle< PCollection_HExtendedString > & S )

Pushing a string at the begining of the string <me>.

void PCollection_HExtendedString::Print ( Standard_OStream & S ) const

Prints the content of <me> on the stream S.

void PCollection_HExtendedString::Remove ( const Standard_Integer Index )

 Removes the character located at the index Index in the string. <br>

Raises an exception if Index is out of bounds.

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

 Removes all the characters from the index FromIndex to the <br>

index ToIndex.
Raises an exception if FromIndex or ToIndex is out of bounds.

void PCollection_HExtendedString::RemoveAll ( const Standard_ExtCharacter C )

Removes all the occurences of the character C in the string.

void PCollection_HExtendedString::RightAdjust ( )

 Removes all space characters at the end of the string. <br>

Raises an exception if the string <me> is not in the Unicod "Ascii range".

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

 Right justify. <br>

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_HExtendedString::SetValue	(	const Standard_Integer	Index,
		const Standard_ExtCharacter	C
	)

 Substitutes the character located to the position Index <br>

by the character C.
Raises an exception if the Index is out of bounds

void PCollection_HExtendedString::SetValue	(	const Standard_Integer	Index,
		const Handle< PCollection_HExtendedString > &	S
	)

 Substitutes from the index Index to the end by the string S. <br>

Raises an exception if Index is out of bounds.

virtual void PCollection_HExtendedString::ShallowDump ( Standard_OStream & s ) const

virtual

Reimplemented from Standard_Persistent.

Handle_PCollection_HExtendedString PCollection_HExtendedString::Split ( const Standard_Integer Index )

Splits a string of characters into two sub-strings.

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

 Creation of a sub-string of the string <me>. <br>

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 PCollection_HExtendedString::UsefullLength ( ) const

 Length of the string ignoring all spaces (' ') and the <br>

control character at the end.
Raises an exception if the string <me> is not in the "Ascii range".

Standard_ExtCharacter PCollection_HExtendedString::Value ( const Standard_Integer Index ) const

Returns the character of index Index of the string.

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

PCollection_HExtendedString.hxx

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation