Files
OCCT/src/IFSelect/IFSelect_DispPerFiles.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

78 lines
3.2 KiB
Plaintext
Executable File

-- Created on: 1994-12-21
-- Created by: Christian CAILLET
-- Copyright (c) 1994-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 DispPerFiles from IFSelect inherits Dispatch
---Purpose : A DispPerFiles produces a determined count of Packets from the
-- input Entities. It divides, as equally as possible, the input
-- list into a count of files. This count is the parameter of the
-- DispPerFiles. If the input list has less than this count, of
-- course there will be one packet per input entity.
-- This count is a Parameter of the DispPerFiles, given as an
-- IntParam, thus allowing external control of its Value
uses AsciiString from TCollection, Graph, SubPartsIterator, IntParam
raises InterfaceError
is
Create returns mutable DispPerFiles;
---Purpose : Creates a DispPerFiles with no Count (default value 1 file)
Count (me) returns mutable IntParam;
---Purpose : Returns the Count Parameter used for splitting
SetCount (me : mutable; count : mutable IntParam);
---Purpose : Sets a new Parameter for Count
CountValue (me) returns Integer;
---Purpose : Returns the effective value of the count parameter
-- (if Count Parameter not Set or value not positive, returns 1)
Label (me) returns AsciiString from TCollection;
---Purpose : Returns as Label, "Maximum <count> Files"
-- -- Evaluation -- --
LimitedMax (me; nbent : Integer; max : out Integer) returns Boolean
is redefined;
---Purpose : Returns True, maximum count is given as CountValue
PacketsCount (me; G : Graph; count : out Integer) returns Boolean
is redefined;
---Purpose : Returns True (count is easy to know) and count is the minimum
-- value between length of input list and CountValue
Packets (me; G : Graph; packs : in out SubPartsIterator)
raises InterfaceError;
---Purpose : Computes the list of produced Packets. It defines Packets in
-- order to have <Count> Packets, except if the input count of
-- Entities is lower. Entities are given by RootResult from the
-- Final Selection.
fields
thecount : IntParam;
end DispPerFiles;