[occt.git] / src / IFSelect / IFSelect_SelectSignedSharing.cdl

-- File:	IFSelect_SelectSignedSharing.cdl
-- Created:	Wed Sep 25 14:12:50 1996
-- Author:	Christian CAILLET
--		<cky@fidox.paris1.matra-dtv.fr>
---Copyright:	 Matra Datavision 1996


class SelectSignedSharing  from IFSelect  inherits SelectExplore

    ---Purpose : In the graph, explore the sharings of the input entities,
    --           until it encounters some which match a given Signature
    --           (for a limited level, filters the returned list)
    --           By default, fitted for any level

uses AsciiString, Transient,  Graph, EntityIterator, Signature

is

    Create (matcher : Signature;
            signtext : CString;
            exact : Boolean = Standard_True;
   	    level : Integer = 0)  returns mutable SelectSignedSharing;
    ---Purpose : Creates a SelectSignedSharing, defaulted for any level
    --           with a given Signature and text to match

    Signature (me) returns mutable Signature;
    ---Purpose : Returns the used Signature, then it is possible to access it,
    --           modify it as required

    SignatureText (me) returns AsciiString from TCollection;
    ---Purpose : Returns Text used to Sort Entity on its Signature
    ---C++ : return const &

    IsExact (me) returns Boolean;
    ---Purpose : Returns True if match must be exact

    Explore (me; level : Integer; ent : Transient; G : Graph;
    	     explored : in out EntityIterator)
    	returns Boolean;
    ---Purpose : Explores an entity : its sharing entities
    --           <ent> to take if it matches the Signature
    --           At level max, filters the result. Else gives all sharings


    ExploreLabel (me) returns AsciiString from TCollection;
    ---Purpose : Returns a text defining the criterium.
    --           (it refers to the text and exact flag to be matched, and is
    --           qualified by the Name provided by the Signature)

fields
 
    thematcher  : Signature;
    thesigntext : AsciiString from TCollection;
    theexact    : Boolean;

end SelectSignedSharing;
Commit	Line	Data
7fd59977	1	-- File: IFSelect_SelectSignedSharing.cdl
	2	-- Created: Wed Sep 25 14:12:50 1996
	3	-- Author: Christian CAILLET
	4	-- <cky@fidox.paris1.matra-dtv.fr>
	5	---Copyright: Matra Datavision 1996
	6
	7
	8	class SelectSignedSharing from IFSelect inherits SelectExplore
	9
	10	---Purpose : In the graph, explore the sharings of the input entities,
	11	-- until it encounters some which match a given Signature
	12	-- (for a limited level, filters the returned list)
	13	-- By default, fitted for any level
	14
	15	uses AsciiString, Transient, Graph, EntityIterator, Signature
	16
	17	is
	18
	19	Create (matcher : Signature;
	20	signtext : CString;
	21	exact : Boolean = Standard_True;
	22	level : Integer = 0) returns mutable SelectSignedSharing;
	23	---Purpose : Creates a SelectSignedSharing, defaulted for any level
	24	-- with a given Signature and text to match
	25
	26	Signature (me) returns mutable Signature;
	27	---Purpose : Returns the used Signature, then it is possible to access it,
	28	-- modify it as required
	29
	30	SignatureText (me) returns AsciiString from TCollection;
	31	---Purpose : Returns Text used to Sort Entity on its Signature
	32	---C++ : return const &
	33
	34	IsExact (me) returns Boolean;
	35	---Purpose : Returns True if match must be exact
	36
	37	Explore (me; level : Integer; ent : Transient; G : Graph;
	38	explored : in out EntityIterator)
	39	returns Boolean;
	40	---Purpose : Explores an entity : its sharing entities
	41	-- <ent> to take if it matches the Signature
	42	-- At level max, filters the result. Else gives all sharings
	43
	44
	45	ExploreLabel (me) returns AsciiString from TCollection;
	46	---Purpose : Returns a text defining the criterium.
	47	-- (it refers to the text and exact flag to be matched, and is
	48	-- qualified by the Name provided by the Signature)
	49
	50	fields
	51
	52	thematcher : Signature;
	53	thesigntext : AsciiString from TCollection;
	54	theexact : Boolean;
	55
	56	end SelectSignedSharing;