include/opencascade/BOPDS_CoupleOfPaveBlocks.hxx

0001 // Created by: Peter KURNEV
0002 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0003 //
0004 // This file is part of Open CASCADE Technology software library.
0005 //
0006 // This library is free software; you can redistribute it and/or modify it under
0007 // the terms of the GNU Lesser General Public License version 2.1 as published
0008 // by the Free Software Foundation, with special exception defined in the file
0009 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0010 // distribution for complete text of the license and disclaimer of any warranty.
0011 //
0012 // Alternatively, this file may be used under the terms of Open CASCADE
0013 // commercial license or contractual agreement.
0014
0015 #ifndef BOPDS_CoupleOfPaveBlocks_HeaderFile
0016 #define BOPDS_CoupleOfPaveBlocks_HeaderFile
0017
0018 #include <BOPDS_PaveBlock.hxx>
0019
0020 /**
0021  * The Class BOPDS_CoupleOfPaveBlocks is to store
0022  * the information about two pave blocks
0023  * and some satellite information
0024  *
0025 */
0026 //=======================================================================
0027 //class : BOPDS_CoupleOfPaveBlocks
0028 //purpose  :
0029 //=======================================================================
0030 class BOPDS_CoupleOfPaveBlocks {
0031  public:
0032   /**
0033    * Constructor
0034    */
0035   BOPDS_CoupleOfPaveBlocks() :
0036     myIndexInterf(-1),
0037     myIndex(-1),
0038     myTolerance(0)
0039   {}
0040   //
0041   /**
0042    * Constructor
0043    * @param thePB1
0044    *  first pave block
0045    * @param thePB2
0046    *  secondt pave block
0047    */
0048   BOPDS_CoupleOfPaveBlocks(const Handle(BOPDS_PaveBlock)& thePB1,
0049     const Handle(BOPDS_PaveBlock)& thePB2) :
0050     myIndexInterf(-1),
0051     myIndex(-1),
0052     myTolerance(0)
0053   {
0054     SetPaveBlocks(thePB1, thePB2);
0055   }
0056   //
0057   /**
0058    * Destructor
0059    */
0060   ~BOPDS_CoupleOfPaveBlocks() {
0061   }
0062   //
0063   /**
0064    * Sets an index
0065    * @param theIndex
0066    *  index
0067    */
0068   void SetIndex(const Standard_Integer theIndex) {
0069     myIndex=theIndex;
0070   }
0071   //
0072   /**
0073    * Returns the index
0074    * @return
0075    *   index
0076    */
0077   Standard_Integer Index()const {
0078     return myIndex;
0079   }
0080   //
0081   /**
0082    * Sets an index of an interference
0083    * @param theIndex
0084    *  index of an interference
0085    */
0086   void SetIndexInterf(const Standard_Integer theIndex) {
0087     myIndexInterf=theIndex;
0088   }
0089   //
0090   /**
0091    * Returns the index of an interference
0092    * @return
0093    *   index of an interference
0094    */
0095   Standard_Integer IndexInterf()const {
0096     return myIndexInterf;
0097   }
0098   //
0099   /**
0100    * Sets pave blocks
0101    * @param thePB1
0102    *  first pave block
0103    * @param thePB2
0104    *  secondt pave block
0105    */
0106   void SetPaveBlocks(const Handle(BOPDS_PaveBlock)& thePB1,
0107              const Handle(BOPDS_PaveBlock)& thePB2) {
0108     myPB[0]=thePB1;
0109     myPB[1]=thePB2;
0110   }
0111   //
0112   /**
0113    * Returns pave blocks
0114    * @param thePB1
0115    *  the first pave block
0116    * @param thePB2
0117    *  the second pave block
0118    */
0119   void PaveBlocks(Handle(BOPDS_PaveBlock)& thePB1,
0120           Handle(BOPDS_PaveBlock)& thePB2) const {
0121     thePB1=myPB[0];
0122     thePB2=myPB[1];
0123   }
0124   //
0125   /**
0126    * Sets the first pave block
0127    * @param thePB
0128    *  the first pave block
0129    */
0130   void SetPaveBlock1(const Handle(BOPDS_PaveBlock)& thePB) {
0131     myPB[0]=thePB;
0132   }
0133   /**
0134    * Returns the first pave block
0135    * @return
0136    * the first pave block
0137    */
0138   const Handle(BOPDS_PaveBlock)& PaveBlock1()const {
0139     return myPB[0];
0140   }
0141   //
0142   /**
0143    * Sets the second pave block
0144    * @param thePB
0145    *  the second pave block
0146    */
0147   void SetPaveBlock2(const Handle(BOPDS_PaveBlock)& thePB) {
0148     myPB[1]=thePB;
0149   }
0150   //
0151   /**
0152    * Returns the second pave block
0153    * @return
0154    * the second pave block
0155    */
0156   const Handle(BOPDS_PaveBlock)& PaveBlock2()const {
0157     return myPB[1];
0158   }
0159
0160   /**
0161   * Sets the tolerance associated with this couple
0162   */
0163   void SetTolerance(const Standard_Real theTol) {
0164     myTolerance = theTol;
0165   }
0166   //
0167   /**
0168   * Returns the tolerance associated with this couple
0169   */
0170   Standard_Real Tolerance()const {
0171     return myTolerance;
0172   }
0173
0174  protected:
0175   Standard_Integer myIndexInterf;
0176   Standard_Integer myIndex;
0177   Handle(BOPDS_PaveBlock) myPB[2];
0178   Standard_Real    myTolerance;
0179 };
0180 //
0181 #endif