OCC Main Page | FoundationClasses | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

FoundationClasses
TKernel
TCollection


TCollection_BaseSequence Class Reference

Definition of a base class for all instanciations
of sequence.

The methods : Clear, Remove accepts a pointer to a
function to use to delete the nodes. This allow
proper call of the destructor on the Items.
Without adding a virtual function pointer to each
node or each sequence.
.

#include <TCollection_BaseSequence.hxx>

Inheritance diagram for TCollection_BaseSequence:

Inheritance graph
[legend]

Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_Boolean IsEmpty () const
 returns True if the sequence <me> contains no elements.

Standard_Integer Length () const
 Returns the number of element(s) in the
sequence. Returns zero if the sequence is empty.
.
Standard_EXPORT void Reverse ()
 Reverses the order of items on <me>.
Example:
before
me = (A B C)
after
me = (C B A)
.
Standard_EXPORT void Exchange (const Standard_Integer I, const Standard_Integer J)
 Swaps elements which are located at
positions and <j> in <me>.
Raises an exception if I or J is out of bound.
Example:
before
me = (A B C), I = 1, J = 3
after
me = (C B A)
.


Protected Member Functions

Standard_EXPORT TCollection_BaseSequence ()
 Creation of an empty sequence.
.
Standard_EXPORT void Clear (const Standard_Address DelNode)
Standard_EXPORT void PAppend (const Standard_Address Node)
Standard_EXPORT void PAppend (TCollection_BaseSequence &S)
 Concatenates <s> at the end of <me>.
<s> is cleared.
Example:
before
me = (A B C)
S = (D E F)
after
me = (A B C D E F)
S = ()
.
Standard_EXPORT void PPrepend (const Standard_Address Node)
Standard_EXPORT void PPrepend (TCollection_BaseSequence &S)
 Concatenates <s> at the beginning of <me>.
<s> is cleared.
Example:
before
me = (A B C) S = (D E F)
after me = (D E F A B C)
S = ()
.
Standard_EXPORT void PInsertAfter (const Standard_Integer Index, const Standard_Address Node)
Standard_EXPORT void PInsertAfter (const Standard_Integer Index, TCollection_BaseSequence &S)
 Inserts the sequence <s> in <me> after the
position <index>. <s> is cleared.
Raises an exception if the index is out of bound.
Example:
before
me = (A B C), Index = 3, S = (D E F)
after
me = (A B C D E F)
S = ()
.
Standard_EXPORT void PSplit (const Standard_Integer Index, TCollection_BaseSequence &Sub)
 Keeps in <me> the items 1 to <index>-1 and
puts in the items <index> to the end.
Example:
before
me = (A B C D) ,Index = 3
after
me = (A B)
Sub = (C D)
.

Standard_EXPORT void Remove (const Standard_Integer Index, const Standard_Address DelNode)
Standard_EXPORT void Remove (const Standard_Integer FromIndex, const Standard_Integer ToIndex, const Standard_Address DelNode)
Standard_EXPORT Standard_Address Find (const Standard_Integer Index) const
 Returns the node at position <index>.
.

Protected Attributes

Standard_Address FirstItem
Standard_Address LastItem
Standard_Address CurrentItem
Standard_Integer CurrentIndex
Standard_Integer Size

Private Member Functions

Standard_EXPORT TCollection_BaseSequence (const TCollection_BaseSequence &Other)
 Creation by copy of existing Sequence.
Warning: This constructor prints a warning message.
We recommand to use the operator =.
.
Standard_EXPORT void Nullify ()
 Clear all fields.

.

Constructor & Destructor Documentation

Standard_EXPORT TCollection_BaseSequence::TCollection_BaseSequence  )  [protected]
 

Standard_EXPORT TCollection_BaseSequence::TCollection_BaseSequence const TCollection_BaseSequence Other  )  [private]
 


Member Function Documentation

Standard_EXPORT void TCollection_BaseSequence::Clear const Standard_Address  DelNode  )  [protected]
 

Standard_EXPORT void TCollection_BaseSequence::Exchange const Standard_Integer  I,
const Standard_Integer  J
 

Standard_EXPORT Standard_Address TCollection_BaseSequence::Find const Standard_Integer  Index  )  const [protected]
 

Standard_Boolean TCollection_BaseSequence::IsEmpty  )  const [inline]
 

Standard_Integer TCollection_BaseSequence::Length  )  const [inline]
 

Standard_EXPORT void TCollection_BaseSequence::Nullify  )  [private]
 

void TCollection_BaseSequence::operator delete void *  anAddress  )  [inline]
 

Reimplemented in Bnd_SeqOfBox, Convert_SequenceOfArray1OfPoles, Convert_SequenceOfArray1OfPoles2d, Dynamic_SeqOfClasses, Dynamic_SeqOfFuzzyDefinitions, Dynamic_SeqOfMethodDefinitions, Dynamic_SeqOfMethods, Expr_SequenceOfGeneralExpression, Expr_SequenceOfGeneralRelation, ExprIntrp_SequenceOfNamedExpression, ExprIntrp_SequenceOfNamedFunction, Materials_MtsSequence, Message_SequenceOfPrinters, Message_SequenceOfProgressScale, Storage_SeqOfCallBack, Storage_SeqOfPersistent, Storage_SeqOfRoot, TColgp_SequenceOfDir, TColgp_SequenceOfDir2d, TColgp_SequenceOfPnt, TColgp_SequenceOfPnt2d, TColgp_SequenceOfVec, TColgp_SequenceOfVec2d, TColgp_SequenceOfXY, TColgp_SequenceOfXYZ, TColStd_SequenceOfAsciiString, TColStd_SequenceOfExtendedString, TColStd_SequenceOfHAsciiString, TColStd_SequenceOfHExtendedString, TColStd_SequenceOfInteger, TColStd_SequenceOfReal, TColStd_SequenceOfTransient, TShort_SequenceOfShortReal, Units_QtsSequence, Units_StrgSequence, Units_TksSequence, and Units_UtsSequence.

void* TCollection_BaseSequence::operator new size_t  size  )  [inline]
 

Reimplemented in Bnd_SeqOfBox, Convert_SequenceOfArray1OfPoles, Convert_SequenceOfArray1OfPoles2d, Dynamic_SeqOfClasses, Dynamic_SeqOfFuzzyDefinitions, Dynamic_SeqOfMethodDefinitions, Dynamic_SeqOfMethods, Expr_SequenceOfGeneralExpression, Expr_SequenceOfGeneralRelation, ExprIntrp_SequenceOfNamedExpression, ExprIntrp_SequenceOfNamedFunction, Materials_MtsSequence, Message_SequenceOfPrinters, Message_SequenceOfProgressScale, Storage_SeqOfCallBack, Storage_SeqOfPersistent, Storage_SeqOfRoot, TColgp_SequenceOfDir, TColgp_SequenceOfDir2d, TColgp_SequenceOfPnt, TColgp_SequenceOfPnt2d, TColgp_SequenceOfVec, TColgp_SequenceOfVec2d, TColgp_SequenceOfXY, TColgp_SequenceOfXYZ, TColStd_SequenceOfAsciiString, TColStd_SequenceOfExtendedString, TColStd_SequenceOfHAsciiString, TColStd_SequenceOfHExtendedString, TColStd_SequenceOfInteger, TColStd_SequenceOfReal, TColStd_SequenceOfTransient, TShort_SequenceOfShortReal, Units_QtsSequence, Units_StrgSequence, Units_TksSequence, and Units_UtsSequence.

void* TCollection_BaseSequence::operator new size_t  ,
void *  anAddress
[inline]
 

Reimplemented in Bnd_SeqOfBox, Convert_SequenceOfArray1OfPoles, Convert_SequenceOfArray1OfPoles2d, Dynamic_SeqOfClasses, Dynamic_SeqOfFuzzyDefinitions, Dynamic_SeqOfMethodDefinitions, Dynamic_SeqOfMethods, Expr_SequenceOfGeneralExpression, Expr_SequenceOfGeneralRelation, ExprIntrp_SequenceOfNamedExpression, ExprIntrp_SequenceOfNamedFunction, Materials_MtsSequence, Message_SequenceOfPrinters, Message_SequenceOfProgressScale, Storage_SeqOfCallBack, Storage_SeqOfPersistent, Storage_SeqOfRoot, TColgp_SequenceOfDir, TColgp_SequenceOfDir2d, TColgp_SequenceOfPnt, TColgp_SequenceOfPnt2d, TColgp_SequenceOfVec, TColgp_SequenceOfVec2d, TColgp_SequenceOfXY, TColgp_SequenceOfXYZ, TColStd_SequenceOfAsciiString, TColStd_SequenceOfExtendedString, TColStd_SequenceOfHAsciiString, TColStd_SequenceOfHExtendedString, TColStd_SequenceOfInteger, TColStd_SequenceOfReal, TColStd_SequenceOfTransient, TShort_SequenceOfShortReal, Units_QtsSequence, Units_StrgSequence, Units_TksSequence, and Units_UtsSequence.

Standard_EXPORT void TCollection_BaseSequence::PAppend TCollection_BaseSequence S  )  [protected]
 

Standard_EXPORT void TCollection_BaseSequence::PAppend const Standard_Address  Node  )  [protected]
 

Standard_EXPORT void TCollection_BaseSequence::PInsertAfter const Standard_Integer  Index,
TCollection_BaseSequence S
[protected]
 

Standard_EXPORT void TCollection_BaseSequence::PInsertAfter const Standard_Integer  Index,
const Standard_Address  Node
[protected]
 

Standard_EXPORT void TCollection_BaseSequence::PPrepend TCollection_BaseSequence S  )  [protected]
 

Standard_EXPORT void TCollection_BaseSequence::PPrepend const Standard_Address  Node  )  [protected]
 

Standard_EXPORT void TCollection_BaseSequence::PSplit const Standard_Integer  Index,
TCollection_BaseSequence Sub
[protected]
 

Standard_EXPORT void TCollection_BaseSequence::Remove const Standard_Integer  FromIndex,
const Standard_Integer  ToIndex,
const Standard_Address  DelNode
[protected]
 

Standard_EXPORT void TCollection_BaseSequence::Remove const Standard_Integer  Index,
const Standard_Address  DelNode
[protected]
 

Standard_EXPORT void TCollection_BaseSequence::Reverse  ) 
 


Field Documentation

Standard_Integer TCollection_BaseSequence::CurrentIndex [protected]
 

Standard_Address TCollection_BaseSequence::CurrentItem [protected]
 

Standard_Address TCollection_BaseSequence::FirstItem [protected]
 

Standard_Address TCollection_BaseSequence::LastItem [protected]
 

Standard_Integer TCollection_BaseSequence::Size [protected]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:13:48 2008 for OpenCASCADE by  doxygen 1.4.1