include/opencascade/IGESData_ViewKindEntity.hxx

0001 // Created on: 1992-04-07
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1992-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESData_ViewKindEntity_HeaderFile
0018 #define _IGESData_ViewKindEntity_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <IGESData_IGESEntity.hxx>
0023 #include <Standard_Integer.hxx>
0024
0025 //! defines required type for ViewKind in directory part
0026 //! that is, Single view or Multiple view
0027 //! An effective ViewKind entity must inherit it and define
0028 //! IsSingle (True for Single, False for List of Views),
0029 //! NbViews and ViewItem (especially for a List)
0030 class IGESData_ViewKindEntity : public IGESData_IGESEntity
0031 {
0032
0033 public:
0034   //! says if "me" is a Single View (True) or a List of Views (False)
0035   Standard_EXPORT virtual bool IsSingle() const = 0;
0036
0037   //! Returns the count of Views for a List of Views. For a Single
0038   //! View, may return simply 1
0039   Standard_EXPORT virtual int NbViews() const = 0;
0040
0041   //! Returns the View n0. <num> for a List of Views. For a Single
0042   //! Views, may return <me> itself
0043   Standard_EXPORT virtual occ::handle<IGESData_ViewKindEntity> ViewItem(const int num) const = 0;
0044
0045   DEFINE_STANDARD_RTTIEXT(IGESData_ViewKindEntity, IGESData_IGESEntity)
0046 };
0047
0048 #endif // _IGESData_ViewKindEntity_HeaderFile