src/StdLPersistent/StdLPersistent_HString.hxx

   1 // Copyright (c) 2015 OPEN CASCADE SAS
   2 //
   3 // This file is part of Open CASCADE Technology software library.
   4 //
   5 // This library is free software; you can redistribute it and/or modify it under
   6 // the terms of the GNU Lesser General Public License version 2.1 as published
   7 // by the Free Software Foundation, with special exception defined in the file
   8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
   9 // distribution for complete text of the license and disclaimer of any warranty.
  10 //
  11 // Alternatively, this file may be used under the terms of Open CASCADE
  12 // commercial license or contractual agreement.
  13
  14
  15 #ifndef _StdLPersistent_HString_HeaderFile
  16 #define _StdLPersistent_HString_HeaderFile
  17
  18 #include <StdObjMgt_Persistent.hxx>
  19
  20 #include <Standard_TypeDef.hxx>
  21 #include <TCollection_HAsciiString.hxx>
  22 #include <TCollection_HExtendedString.hxx>
  23
  24
  25 class StdLPersistent_HString
  26 {
  27   template <class StringClass, typename CharType>
  28   class instance : public StdObjMgt_Persistent
  29   {
  30   public:
  31     //! Read persistent data from a file.
  32     Standard_EXPORT virtual void Read (StdObjMgt_ReadData& theReadData);
  33     //! Write persistent data to a file.
  34     Standard_EXPORT virtual void Write (StdObjMgt_WriteData& theWriteData) const;
  35     virtual void PChildren(StdObjMgt_Persistent::SequenceOfPersistent&) const { }
  36
  37     //! Get/create a label defined by referenced string.
  38     Standard_EXPORT virtual TDF_Label Label (const Handle(TDF_Data)& theDF) const;
  39
  40     //! Get the value.
  41     const Handle(StringClass)& Value() const  { return myValue; }
  42
  43   protected:
  44     Handle(StringClass) myValue;
  45   };
  46
  47 public:
  48   class Ascii
  49     : public instance<TCollection_HAsciiString, Standard_Character>
  50   {
  51   public:
  52     //! Get referenced ASCII string.
  53     Standard_EXPORT virtual Handle(TCollection_HAsciiString) AsciiString() const;
  54
  55     inline Standard_CString PName() const { return "PCollection_HAsciiString"; }
  56   };
  57
  58   class Extended
  59     : public instance<TCollection_HExtendedString, Standard_ExtCharacter>
  60   {
  61   public:
  62     //! Get referenced extended string.
  63     Standard_EXPORT virtual Handle(TCollection_HExtendedString) ExtString() const;
  64
  65     inline Standard_CString PName() const { return "PCollection_HExtendedString"; }
  66   };
  67 };
  68
  69 #endif