summaryrefslogtreecommitdiff
path: root/inc/TCollection_BaseSequence.hxx
blob: b80f41dbe363848970073f585be71d0309aeaf9b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _TCollection_BaseSequence_HeaderFile
#define _TCollection_BaseSequence_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _Standard_Address_HeaderFile
#include <Standard_Address.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class Standard_NoSuchObject;
class Standard_OutOfRange;


//! Definition of a base class for all instanciations <br>
//!          of sequence. <br>
//! <br>
//!          The methods : Clear, Remove accepts a pointer to a <br>
//!          function  to use  to delete the  nodes. This allow <br>
//!          proper    call of  the  destructor  on  the Items. <br>
//!          Without adding a  virtual function pointer to each <br>
//!          node or each sequence. <br>
class TCollection_BaseSequence  {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

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





protected:

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


Standard_Address FirstItem;
Standard_Address LastItem;
Standard_Address CurrentItem;
Standard_Integer CurrentIndex;
Standard_Integer Size;


private:

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




};


#include <TCollection_BaseSequence.lxx>



// other Inline functions and methods (like "C++: function call" methods)


#endif