src/apps/cortex/RouteApp/DormantNodeIO.h

   1 /*
   2  * Copyright (c) 1999-2000, Eric Moon.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions, and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions, and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * 3. The name of the author may not be used to endorse or promote products
  17  *    derived from this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
  20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21  * OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  26  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  27  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31
  32 // DormantNodeIO.h
  33 // * PURPOSE
  34 //   Manage the import and export of a user-instantiated
  35 //   media node descriptor.
  36 //
  37 // * HISTORY
  38 //   e.moon             8dec99          Begun
  39
  40 #ifndef __DormantNodeIO_H__
  41 #define __DormantNodeIO_H__
  42
  43 #include "NodeRef.h"
  44 #include "XML.h"
  45
  46 #include <String.h>
  47 #include <Entry.h>
  48
  49 class dormant_node_info;
  50
  51 #include "cortex_defs.h"
  52 __BEGIN_CORTEX_NAMESPACE
  53
  54 class NodeManager;
  55
  56 class DormantNodeIO :
  57         public          IPersistent {
  58
  59 public:                                                                                 // *** ctor/dtor
  60         virtual ~DormantNodeIO();
  61
  62         DormantNodeIO();
  63         DormantNodeIO(
  64                 NodeRef*                                                                ref,
  65                 const char*                                                     nodeKey);
  66
  67         bool exportValid() const { return m_exportValid; }
  68
  69         const char* nodeKey() const { return m_nodeKey.String(); }
  70
  71 public:                                                                                 // *** operations
  72
  73         // call when object imported to create the described node
  74         status_t instantiate(
  75                 NodeManager*                                            manager,
  76                 NodeRef**                                                               outRef);
  77
  78 public:                                                                                 // *** document-type setup
  79         static void AddTo(
  80                 XML::DocumentType*                      docType);
  81
  82 public:                                                                                 // *** IPersistent
  83
  84         // EXPORT:
  85
  86         void xmlExportBegin(
  87                 ExportContext&                                          context) const;
  88
  89         void xmlExportAttributes(
  90                 ExportContext&                                          context) const;
  91
  92         void xmlExportContent(
  93                 ExportContext&                                          context) const;
  94
  95         void xmlExportEnd(
  96                 ExportContext&                                          context) const;
  97
  98         // IMPORT:
  99
 100         virtual void xmlImportBegin(
 101                 ImportContext&                                          context);
 102
 103         virtual void xmlImportAttribute(
 104                 const char*                                                             key,
 105                 const char*                                                             value,
 106                 ImportContext&                                          context);
 107
 108         virtual void xmlImportContent(
 109                 const char*                                                             data,
 110                 uint32                                                                          length,
 111                 ImportContext&                                          context);
 112
 113         virtual void xmlImportChild(
 114                 IPersistent*                                                    child,
 115                 ImportContext&                                          context);
 116
 117         virtual void xmlImportComplete(
 118                 ImportContext&                                          context);
 119
 120 private:                                                                                        // *** implementation
 121         // imported data
 122         BString                                                                         m_nodeKey;
 123
 124         BString                                                                         m_dormantName;
 125         int64                                                                                   m_kinds;
 126         int32                                                                                   m_flavorID;
 127
 128         int32                                                                                   m_flags;
 129         int32                                                                                   m_runMode;
 130         bigtime_t                                                                       m_recordingDelay;
 131         bool                                                                                    m_cycle;
 132
 133         BEntry                                                                          m_entry;
 134
 135         bool                                                                                    m_exportValid;
 136
 137         status_t _matchDormantNode(
 138                 dormant_node_info*                      outInfo);
 139 };
 140
 141 __END_CORTEX_NAMESPACE
 142 #endif /*__DormantNodeIO_H__*/
 143