occt/src/BOPDS/BOPDS_CommonBlock.cdl

-- Created by: Peter KURNEV
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and / or modify it
-- under the terms of the GNU Lesser General Public version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.

class CommonBlock from BOPDS 
    inherits TShared from MMgt   
	---Purpose: 
     
    	---Purpose:  
	-- The class BOPDS_CommonBlock is to store  
    	-- the information about pave blocks that have  
    	--  geometry coincidence (in  terms of a tolerance)  with
    	--  a) other pave block(s) 
    	--  b) face(s)

uses 
    ListOfInteger from BOPCol,  
    BaseAllocator from BOPCol,
    PaveBlock from BOPDS,
    ListOfPaveBlock from BOPDS

--raises

is 
    Create 
    	returns CommonBlock from BOPDS; 
	---Purpose:  
    	--- Empty contructor  
    	---  
	 
    Create (theAllocator: BaseAllocator from BOPCol) 
    	returns CommonBlock from BOPDS;      
    	---Purpose:  
    	---  Contructor    
    	---  <theAllocator> - the allocator to manage the memory     
    	---  
	
    AddPaveBlock(me:mutable; 
	    aPB : PaveBlock from BOPDS); 
      	---Purpose: 
    	--- Modifier   
	--- Adds the pave block <aPB> to the list of pave blocks    
	--- of the common block 
	
    AddPaveBlocks(me:mutable; 
    	    aLPB:ListOfPaveBlock from BOPDS);
     	---Purpose: 
    	--- Modifier   
	--- Adds the list of pave blocks <aLPB>  
    	--- to the list of pave blocks  
	--- of the common block 
	
    AddFace(me:mutable; 
	    aF : Integer from Standard); 
     	---Purpose: 
    	--- Modifier   
	--- Adds the index of the face <aF>  
    	--- to the list of indices of faces  
	--- of the common block 
	
    AddFaces (me:mutable; 
    	    aLF:ListOfInteger from BOPCol); 
	---Purpose: 
    	--- Modifier   
	--- Adds the list of indices of faces <aLF>  
    	--- to the list of indices of faces 
	--- of the common block  
	 
    PaveBlocks(me) 
    	returns ListOfPaveBlock from BOPDS; 
    ---C++:  return const &  
    	---Purpose: 
    	--- Selector   
	--- Returns the list of pave blocks  
    	--- of the common block  
	
    Faces (me) 
    	returns ListOfInteger from BOPCol; 
    ---C++:  return const &  
     	---Purpose: 
    	--- Selector   
	--- Returns the list of indices of faces  
    	--- of the common block   
	
    PaveBlock1  (me) 
    	returns  PaveBlock from BOPDS; 
    ---C++:  return const &	
	---Purpose: 
    	--- Selector   
	--- Returns the first pave block  
    	--- of the common block   
    	
    PaveBlockOnEdge  (me:mutable;  
    	    theIndex: Integer from Standard) 
    	returns  PaveBlock from BOPDS; 
    ---C++:  return  &	   
     	---Purpose: 
    	--- Selector   
	--- Returns the pave block that belongs 
        --- to the edge with index <theIx> 	 
	
    IsPaveBlockOnFace  (me;  
    	    theIndex: Integer from Standard) 
    	returns  Boolean from Standard; 
     	---Purpose: 
    	--- Query   
	--- Returns true if the common block contains 
    	--  a pave block that belongs  
    	--- to the face with index <theIx> 

    IsPaveBlockOnEdge  (me;  
    	    theIndex: Integer from Standard) 
    	returns  Boolean from Standard;   
	---Purpose: 
    	--- Query   
	--- Returns true if the common block contains 
    	--  a pave block that belongs  
    	--- to the edge with index <theIx> 

    Contains(me; 
    	    thePB:PaveBlock from BOPDS) 
	returns Boolean from Standard; 
    	---Purpose: 
    	--- Query   
	--- Returns true if the common block contains 
    	--  a pave block that is equal  to <thePB>  

    Contains(me; 
    	    theF: Integer from Standard) 
	returns Boolean from Standard;
      	---Purpose: 
    	--- Query   
	--- Returns true if the common block contains 
    	--  the face with index equal  to <theF>   
	
    SetEdge(me:mutable; 
    	    theEdge:Integer from Standard); 
	---Purpose: 
    	--- Modifier   
	--- Assign the index <theEdge> as the edge index  
    	--- to all pave blocks of the common block 

    Edge(me) 
        returns Integer from Standard; 
	---Purpose: 
    	--- Selector   
	--- Returns the index of the edge  
    	--- of  all pave blocks of the common block 
    
    Dump(me); 
    
fields 
    myPaveBlocks: ListOfPaveBlock from BOPDS  is protected;  
    myFaces     : ListOfInteger   from BOPCol is protected;  
      	    
end CommonBlock;