1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-01 10:26:12 +03:00
occt/src/XSControl/XSControl_SignTransferStatus.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

79 lines
3.4 KiB
Plaintext
Executable File

-- Created on: 1998-07-31
-- Created by: Christian CAILLET
-- Copyright (c) 1998-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer 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 the rights and limitations under the License.
class SignTransferStatus from XSControl inherits Signature from IFSelect
---Purpose : This Signatures gives the Transfer Status of an entity, as
-- recorded in a TransferProcess. It can be :
-- - Void : not recorded, or recorded as void with no message
-- (attributes are not taken into account)
-- - Warning : no result, warning message(s), no fail
-- - Fail : no result, fail messages (with or without warning)
-- - Result.. : result, no message (neither warning nor fail)
-- Result.. i.e. Result:TypeName of the result
-- - Result../Warning : result, with warning but no fail
-- - Result../Fail : result, with fail (.e. bad result)
-- - Fail on run : no result yet recorded, no message, but
-- an exception occurred while recording the result
-- (this should not appear and indicates a programming error)
uses CString, Transient, InterfaceModel,
TransientProcess, TransferReader
is
Create returns mutable SignTransferStatus;
---Purpose : Creates a SignTransferStatus, not initialised
-- it gives nothing (empty string)
Create (TR : TransferReader) returns mutable SignTransferStatus;
---Purpose : Creates a SignTransferStatus, which will work on the current
-- TransientProcess brought by the TransferReader (its MapReader)
SetReader (me : mutable; TR : TransferReader);
---Purpose : Sets a TransferReader to work
SetMap (me : mutable; TP : TransientProcess);
---Purpose : Sets a precise map to sign entities
-- This definition oversedes the creation with a TransferReader
Map (me) returns TransientProcess;
---Purpose : Returns the TransientProcess used as precised one
-- Returns a Null Handle for a creation from a TransferReader
-- without any further setting
Reader (me) returns TransferReader;
---Purpose : Returns the Reader (if created with a Reader)
-- Returns a Null Handle if not created with a Reader
Value (me; ent : any Transient; model : InterfaceModel) returns CString;
---Purpose : Returns the Signature for a Transient object, as its transfer
-- status
fields
theTR : TransferReader;
theTP : TransientProcess;
end SignTransferStatus;