File: Interface_FileParameter.hxx

package info (click to toggle)
opencascade 6.2-7
  • links: PTS
  • area: non-free
  • in suites: lenny
  • size: 444,652 kB
  • ctags: 256,750
  • sloc: cpp: 1,150,123; ansic: 225,762; tcl: 30,130; makefile: 12,619; sh: 7,958; xml: 3,981; lisp: 283; java: 212; csh: 203; perl: 15
file content (142 lines) | stat: -rw-r--r-- 3,919 bytes parent folder | download
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
// File generated by CPPExt (Value)
//
//                     Copyright (C) 1991 - 2000 by  
//                      Matra Datavision SA.  All rights reserved.
//  
//                     Copyright (C) 2001 - 2004 by
//                     Open CASCADE SA.  All rights reserved.
// 
// This file is part of the Open CASCADE Technology software.
//
// This software may be distributed and/or modified under the terms and
// conditions of the Open CASCADE Public License as defined by Open CASCADE SA
// and appearing in the file LICENSE included in the packaging of this file.
//  
// This software is distributed on an "AS IS" basis, without warranty of any
// kind, and Open CASCADE SA hereby disclaims all such warranties,
// including without limitation, any warranties of merchantability, fitness
// for a particular purpose or non-infringement. Please see the License for
// the specific terms and conditions governing rights and limitations under the
// License.

#ifndef _Interface_FileParameter_HeaderFile
#define _Interface_FileParameter_HeaderFile

#ifndef _Interface_ParamType_HeaderFile
#include <Interface_ParamType.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
class TCollection_AsciiString;


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

//! Auxiliary class to store a litteral parameter in a file <br>
//!           intermediate directory or in an UndefinedContent : a reference <br>
//!           type Parameter detains an Integer which is used to address a <br>
//!           record in the directory. <br>
//!           FileParameter is intended to be stored in a ParamSet : hence <br>
//!           memory management is performed by ParamSet, which calls Clear <br>
//!           to work, while the Destructor (see Destroy) does nothing. <br>
//!           Also a FileParameter can be read for consultation only, not to <br>
//!           be read from a Structure to be included into another one. <br>
class Interface_FileParameter  {

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); 
      }
 // Methods PUBLIC
 // 


Standard_EXPORT Interface_FileParameter();

//! Fills fields (with Entity Number set to zero) <br>
Standard_EXPORT   void Init(const TCollection_AsciiString& val,const Interface_ParamType typ) ;

//! Same as above, but builds the Value from a CString <br>
Standard_EXPORT   void Init(const Standard_CString val,const Interface_ParamType typ) ;

//! Same as above, but as a CString (for immediate exploitation) <br>
//! was C++ : return const <br>
Standard_EXPORT   Standard_CString CValue() const;

//! Returns the type of the parameter <br>
Standard_EXPORT   Interface_ParamType ParamType() const;

//! Allows to set a reference to an Entity in a numbered list <br>
Standard_EXPORT   void SetEntityNumber(const Standard_Integer num) ;

//! Returns value set by SetEntityNumber <br>
Standard_EXPORT   Standard_Integer EntityNumber() const;

//! Clears stored data : frees memory taken for the String Value <br>
Standard_EXPORT   void Clear() ;

//! Destructor. Does nothing because Memory is managed by ParamSet <br>
Standard_EXPORT   void Destroy() ;
~Interface_FileParameter()
{
  Destroy();
}






protected:

 // Methods PROTECTED
 // 


 // Fields PROTECTED
 //


private: 

 // Methods PRIVATE
 // 


 // Fields PRIVATE
 //
Interface_ParamType thetype;
Standard_CString theval;
Standard_Integer thenum;


};





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


#endif