[occt.git] / src / BOP / BOP_WESCorrector.cdl

-- File:	BOP_WESCorrector.cdl
-- Created:	Fri Apr 13 10:41:43 2001
-- Author:	Peter KURNEV
--		<pkv@irinox>
---Copyright:	 Matra Datavision 2001


class WESCorrector from BOP 

	---Purpose: 
    	---  The algorithm to change the Wire Edges Set (WES) contents.
    	--   The NewWES will contain only wires instead of wires and edges. 
    	--
uses
    WireEdgeSet          from BOP,
    PWireEdgeSet         from BOP,
    ListOfConnexityBlock from BOP 
    
is 
    Create   
    	returns WESCorrector from BOP; 
    	---Purpose:  
    	--- Empty constructor; 
    	---
    SetWES  (me:out; 
		aWES: WireEdgeSet from BOP);  
    	---Purpose: 
    	--- Modifier 
    	---
    Do (me:out); 
    	---Purpose: 
    	--- Performs the algorithm that  consists  of  two  steps 
    	--- 1. Make conexity blocks (  DoConnexityBlocks()  )     
    	--- 2. Make corrections     (  DoCorrections()  )        
    	---
    DoConnexityBlocks(me:out) 
    	is  private; 
       
    DoCorrections(me:out) 
    	is  private; 
      
    IsDone(me)  
    	returns Boolean from Standard;   
    	---Purpose: 
    	--- Selector 
    	---
    ErrorStatus	(me)  
    	returns Integer from Standard; 
    	---Purpose: 
    	--- Selector  
    	--- contents see BOP_WESCorrector.cxx  
    	---
    WES     (me:out) 
    	returns WireEdgeSet from BOP; 
    	---C++:  return &  
    	---Purpose: 
    	--- Selector 
    	---
    NewWES  (me:out) 
    	returns WireEdgeSet from BOP; 
    	---C++:  return &   
    	---Purpose: 
    	--- Selector 
    	---

fields 

    myWES             : PWireEdgeSet         from BOP; 
    myNewWES          : WireEdgeSet          from BOP;  
    myConnexityBlocks : ListOfConnexityBlock from BOP;  
    myIsDone          : Boolean from Standard;  
    myErrorStatus     : Integer from Standard;  

end WESCorrector;
Commit	Line	Data
7fd59977	1	-- File: BOP_WESCorrector.cdl
	2	-- Created: Fri Apr 13 10:41:43 2001
	3	-- Author: Peter KURNEV
	4	-- <pkv@irinox>
	5	---Copyright: Matra Datavision 2001
	6
	7
	8	class WESCorrector from BOP
	9
	10	---Purpose:
	11	--- The algorithm to change the Wire Edges Set (WES) contents.
	12	-- The NewWES will contain only wires instead of wires and edges.
	13	--
	14	uses
	15	WireEdgeSet from BOP,
	16	PWireEdgeSet from BOP,
	17	ListOfConnexityBlock from BOP
	18
	19	is
	20	Create
	21	returns WESCorrector from BOP;
	22	---Purpose:
	23	--- Empty constructor;
	24	---
	25	SetWES (me:out;
	26	aWES: WireEdgeSet from BOP);
	27	---Purpose:
	28	--- Modifier
	29	---
	30	Do (me:out);
	31	---Purpose:
	32	--- Performs the algorithm that consists of two steps
	33	--- 1. Make conexity blocks ( DoConnexityBlocks() )
	34	--- 2. Make corrections ( DoCorrections() )
	35	---
	36	DoConnexityBlocks(me:out)
	37	is private;
	38
	39	DoCorrections(me:out)
	40	is private;
	41
	42	IsDone(me)
	43	returns Boolean from Standard;
	44	---Purpose:
	45	--- Selector
	46	---
	47	ErrorStatus (me)
	48	returns Integer from Standard;
	49	---Purpose:
	50	--- Selector
	51	--- contents see BOP_WESCorrector.cxx
	52	---
	53	WES (me:out)
	54	returns WireEdgeSet from BOP;
	55	---C++: return &
	56	---Purpose:
	57	--- Selector
	58	---
	59	NewWES (me:out)
	60	returns WireEdgeSet from BOP;
	61	---C++: return &
	62	---Purpose:
	63	--- Selector
	64	---
65
66	fields
67
68	myWES : PWireEdgeSet from BOP;
69	myNewWES : WireEdgeSet from BOP;
70	myConnexityBlocks : ListOfConnexityBlock from BOP;
71	myIsDone : Boolean from Standard;
72	myErrorStatus : Integer from Standard;
73
74	end WESCorrector;