1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-07 18:30:55 +03:00
occt/src/StepData/StepData_ReadWriteModule.cdl
abv d5f74e42d6 0024624: Lost word in license statement in source files
License statement text corrected; compiler warnings caused by Bison 2.41 disabled for MSVC; a few other compiler warnings on 54-bit Windows eliminated by appropriate type cast
Wrong license statements corrected in several files.
Copyright and license statements added in XSD and GLSL files.
Copyright year updated in some files.
Obsolete documentation files removed from DrawResources.
2014-02-20 16:15:17 +04:00

108 lines
5.1 KiB
Plaintext

-- Created on: 1993-01-25
-- Created by: Christian CAILLET
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
deferred class ReadWriteModule from StepData inherits
ReaderModule from Interface
---Purpose : Defines basic File Access Module (Recognize, Read, Write)
-- That is : ReaderModule (Recognize & Read) + Write for
-- StepWriter (for a more centralized description)
-- Warning : A sub-class of ReadWriteModule, which belongs to a particular
-- Protocol, must use the same definition for Case Numbers (give
-- the same Value for a StepType defined as a String from a File
-- as the Protocol does for the corresponding Entity)
uses Transient, AsciiString from TCollection,
SequenceOfAsciiString from TColStd,
Check, FileReaderData, StepReaderData, StepWriter
raises DomainError
is
CaseNum (me; data : FileReaderData; num : Integer) returns Integer;
---Purpose : Translate the Type of record <num> in <data> to a positive
-- Case Number, or 0 if failed.
-- Works with a StepReaderData, in which the Type of an Entity
-- is defined as a String : Reads the RecordType <num> then calls
-- CaseNum (this type)
-- Warning : The methods CaseStep, StepType and Recognize,
-- must be in phase (triplets CaseNum-StepType-Type of Object)
CaseStep (me; atype : AsciiString from TCollection) returns Integer
is deferred;
---Purpose : Defines Case Numbers corresponding to the recognized Types
-- Called by CaseNum (data,num) above for a Simple Type Entity
-- Warning : CaseStep must give the same Value as Protocol does for the
-- Entity type which corresponds to this Type given as a String
CaseStep (me; types : SequenceOfAsciiString from TColStd) returns Integer
is virtual;
---Purpose : Same a above but for a Complex Type Entity ("Plex")
-- The provided Default recognizes nothing
IsComplex (me; CN : Integer) returns Boolean is virtual;
---Purpose : Returns True if the Case Number corresponds to a Complex Type
-- ("Plex"). Remember that all possible combinations must be
-- aknowledged to be processed
-- Default is False for all cases. For a Protocol which defines
-- possible Plexes, this method must be redefined.
StepType (me; CN : Integer) returns AsciiString from TCollection
is deferred;
---Purpose : Function specific to STEP, which delivers the StepType as it
-- is recorded in and read from a File compliant with STEP.
-- This method is symmetric to the method CaseStep.
-- StepType can be different from Dynamic Type's name, but
-- belongs to the same class of Object.
-- Returns an empty String if <CN> is zero.
-- Warning : For a Complex Type Entity, returns an Empty String
-- (Complex Type must be managed by users)
---C++ : return const &
ShortType (me; CN : Integer) returns AsciiString from TCollection
is virtual;
---Purpose : Function specific to STEP. Some STEP Types have a short form
-- This method can be redefined to fill it
-- By default, returns an empty string, which is then interpreted
-- to take normal form from StepType
ComplexType (me; CN : Integer;
types : in out SequenceOfAsciiString from TColStd)
returns Boolean is virtual;
---Purpose : Function specific to STEP, which delivers the list of types
-- which corresponds to a complex type. If <CN> is not for a
-- complex type, this method returns False. Else it returns True
-- and fills the list in alphabetic order.
-- The default returns False. To be redefined as required.
Read (me; CN : Integer; data : FileReaderData; num : Integer;
ach : in out Check; ent : mutable Transient)
raises DomainError;
---Purpose : General Read Function, calls ReadStep
ReadStep (me; CN : Integer; data : StepReaderData; num : Integer;
ach : in out Check; ent : mutable Transient)
raises DomainError is deferred;
---Purpose : Specific Read Function. Works with StepReaderData
WriteStep (me; CN : Integer; SW : in out StepWriter; ent : Transient)
is deferred;
---Purpose : Write Function, switched by CaseNum
end ReadWriteModule;