Files
OCCT/src/IFSelect/IFSelect_SelectControl.cdl
T
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

75 lines
3.0 KiB
Plaintext
Executable File

-- Created on: 1994-02-16
-- 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.
deferred class SelectControl from IFSelect inherits Selection
---Purpose : A SelectControl kind Selection works with two input Selections
-- in a dissymmetric way : the Main Input which gives an input
-- list of Entities, to be processed, and the Second Input which
-- gives another list, to be used to filter the main input.
--
-- e.g. : SelectDiff retains the items of the Main Input which
-- are not in the Control Input (which acts as Diff Input)
-- or a specific selection which retains Entities from the Main
-- Input if and only if they are concerned by an entity from
-- the Control Input (such as Views in IGES, etc...)
--
-- The way RootResult and Label are produced are at charge of
-- each sub-class
uses SelectionIterator
is
MainInput (me) returns mutable Selection;
---Purpose : Returns the Main Input Selection
HasSecondInput (me) returns Boolean;
---Purpose : Returns True if a Control Input is defined
-- Thus, Result can be computed differently if there is a
-- Control Input or if there is none
SecondInput (me) returns mutable Selection;
---Purpose : Returns the Control Input Selection, or a Null Handle
SetMainInput (me : mutable; sel : mutable Selection);
---Purpose : Sets a Selection to be the Main Input
SetSecondInput (me : mutable; sel : mutable Selection);
---Purpose : Sets a Selection to be the Control Input
-- RootResult,Label remain to be defined by each class of Selection
-- (also HasUniqueResult if it applies)
FillIterator (me; iter : in out SelectionIterator);
---Purpose : Puts in an Iterator the Selections from which "me" depends
-- That is to say, the list of Input Selections
fields
themain : Selection;
thesecond : Selection;
end SelectControl;