include/opencascade/TDataStd.hxx

0001 // Created on: 1995-05-10
0002 // Created by: Denis PASCAL
0003 // Copyright (c) 1995-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 _TDataStd_HeaderFile
0018 #define _TDataStd_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_GUID.hxx>
0025 #include <NCollection_List.hxx>
0026 #include <Standard_OStream.hxx>
0027 #include <TDataStd_RealEnum.hxx>
0028
0029 //! This package defines standard attributes for
0030 //! modelling.
0031 //! These allow you to create and modify labels
0032 //! and attributes for many basic data types.
0033 //! Standard topological and visualization
0034 //! attributes have also been created.
0035 //! To find an attribute attached to a specific label,
0036 //! you use the GUID of the type of attribute you
0037 //! are looking for. To do this, first find this
0038 //! information using the method GetID as follows: Standard_GUID anID =
0039 //! MyAttributeClass::GetID();
0040 //! Then, use the method Find for the label as follows:
0041 //! bool HasAttribute
0042 //! =
0043 //! aLabel.Find(anID,anAttribute);
0044 //! Note
0045 //! For information on the relations between this
0046 //! component of OCAF and the others, refer to the OCAF User's Guide.
0047 class TDataStd
0048 {
0049 public:
0050   DEFINE_STANDARD_ALLOC
0051
0052   //! Appends to <anIDList> the list of the attributes
0053   //! IDs of this package. CAUTION: <anIDList> is NOT
0054   //! cleared before use.
0055   Standard_EXPORT static void IDList(NCollection_List<Standard_GUID>& anIDList);
0056
0057   //! Prints the name of the real dimension <DIM> as a String on
0058   //! the Stream <S> and returns <S>.
0059   Standard_EXPORT static Standard_OStream& Print(const TDataStd_RealEnum DIM, Standard_OStream& S);
0060 };
0061
0062 #endif // _TDataStd_HeaderFile