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 167 168 169 170 171 172 173 174
|
// File generated by CPPExt (Transient)
//
//
// 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 _StepData_ReadWriteModule_HeaderFile
#define _StepData_ReadWriteModule_HeaderFile
#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Handle_StepData_ReadWriteModule_HeaderFile
#include <Handle_StepData_ReadWriteModule.hxx>
#endif
#ifndef _Interface_ReaderModule_HeaderFile
#include <Interface_ReaderModule.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Handle_Interface_FileReaderData_HeaderFile
#include <Handle_Interface_FileReaderData.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Handle_Interface_Check_HeaderFile
#include <Handle_Interface_Check.hxx>
#endif
#ifndef _Handle_Standard_Transient_HeaderFile
#include <Handle_Standard_Transient.hxx>
#endif
#ifndef _Handle_StepData_StepReaderData_HeaderFile
#include <Handle_StepData_StepReaderData.hxx>
#endif
class Standard_DomainError;
class Interface_FileReaderData;
class TCollection_AsciiString;
class TColStd_SequenceOfAsciiString;
class Interface_Check;
class Standard_Transient;
class StepData_StepReaderData;
class StepData_StepWriter;
//! Defines basic File Access Module (Recognize, Read, Write) <br>
//! That is : ReaderModule (Recognize & Read) + Write for <br>
//! StepWriter (for a more centralized description) <br>
//! Warning : A sub-class of ReadWriteModule, which belongs to a particular <br>
//! Protocol, must use the same definition for Case Numbers (give <br>
//! the same Value for a StepType defined as a String from a File <br>
//! as the Protocol does for the corresponding Entity) <br>
class StepData_ReadWriteModule : public Interface_ReaderModule {
public:
// Methods PUBLIC
//
//! Translate the Type of record <num> in <data> to a positive <br>
//! Case Number, or 0 if failed. <br>
//! Works with a StepReaderData, in which the Type of an Entity <br>
//! is defined as a String : Reads the RecordType <num> then calls <br>
//! CaseNum (this type) <br>
//! Warning : The methods CaseStep, StepType and Recognize, <br>
//! must be in phase (triplets CaseNum-StepType-Type of Object) <br>
Standard_EXPORT Standard_Integer CaseNum(const Handle(Interface_FileReaderData)& data,const Standard_Integer num) const;
//! Defines Case Numbers corresponding to the recognized Types <br>
//! Called by CaseNum (data,num) above for a Simple Type Entity <br>
//! Warning : CaseStep must give the same Value as Protocol does for the <br>
//! Entity type which corresponds to this Type given as a String <br>
Standard_EXPORT virtual Standard_Integer CaseStep(const TCollection_AsciiString& atype) const = 0;
//! Same a above but for a Complex Type Entity ("Plex") <br>
//! The provided Default recognizes nothing <br>
Standard_EXPORT virtual Standard_Integer CaseStep(const TColStd_SequenceOfAsciiString& types) const;
//! Returns True if the Case Number corresponds to a Complex Type <br>
//! ("Plex"). Remember that all possible combinations must be <br>
//! aknowledged to be processed <br>
//! Default is False for all cases. For a Protocol which defines <br>
//! possible Plexes, this method must be redefined. <br>
Standard_EXPORT virtual Standard_Boolean IsComplex(const Standard_Integer CN) const;
//! Function specific to STEP, which delivers the StepType as it <br>
//! is recorded in and read from a File compliant with STEP. <br>
//! This method is symmetric to the method CaseStep. <br>
//! StepType can be different from Dynamic Type's name, but <br>
//! belongs to the same class of Object. <br>
//! Returns an empty String if <CN> is zero. <br>
//! Warning : For a Complex Type Entity, returns an Empty String <br>
//! (Complex Type must be managed by users) <br>
Standard_EXPORT virtual const TCollection_AsciiString& StepType(const Standard_Integer CN) const = 0;
//! Function specific to STEP. Some STEP Types have a short form <br>
//! This method can be redefined to fill it <br>
//! By default, returns an empty string, which is then interpreted <br>
//! to take normal form from StepType <br>
Standard_EXPORT virtual TCollection_AsciiString ShortType(const Standard_Integer CN) const;
//! Function specific to STEP, which delivers the list of types <br>
//! which corresponds to a complex type. If <CN> is not for a <br>
//! complex type, this method returns False. Else it returns True <br>
//! and fills the list in alphabetic order. <br>
//! The default returns False. To be redefined as required. <br>
Standard_EXPORT virtual Standard_Boolean ComplexType(const Standard_Integer CN,TColStd_SequenceOfAsciiString& types) const;
//! General Read Function, calls ReadStep <br>
Standard_EXPORT void Read(const Standard_Integer CN,const Handle(Interface_FileReaderData)& data,const Standard_Integer num,Handle(Interface_Check)& ach,const Handle(Standard_Transient)& ent) const;
//! Specific Read Function. Works with StepReaderData <br>
Standard_EXPORT virtual void ReadStep(const Standard_Integer CN,const Handle(StepData_StepReaderData)& data,const Standard_Integer num,Handle(Interface_Check)& ach,const Handle(Standard_Transient)& ent) const = 0;
//! Write Function, switched by CaseNum <br>
Standard_EXPORT virtual void WriteStep(const Standard_Integer CN,StepData_StepWriter& SW,const Handle(Standard_Transient)& ent) const = 0;
//Standard_EXPORT ~StepData_ReadWriteModule();
// Type management
//
Standard_EXPORT const Handle(Standard_Type)& DynamicType() const;
//Standard_EXPORT Standard_Boolean IsKind(const Handle(Standard_Type)&) const;
protected:
// Methods PROTECTED
//
// Fields PROTECTED
//
private:
// Methods PRIVATE
//
// Fields PRIVATE
//
};
// other Inline functions and methods (like "C++: function call" methods)
//
#endif
|