src/apps/cortex/RouteApp/NodeExportContext.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 // NodeExportContext.h
  33 // * PURPOSE
  34 //   Extends ExportContext to include a set of nodes
  35 //   to be stored.  This is an abstract class; implement
  36 //   exportUIState() to store any user-interface state
  37 //   info needed for the listed nodes.
  38 //
  39 // TO DO ++++++ GO AWAY!  NodeSetIOContext provides the same
  40 //   functionality for both import and export...
  41 //
  42 // * HISTORY
  43 //   e.moon                     7dec99          Begun
  44
  45 #ifndef __NodeExportContext_H__
  46 #define __NodeExportContext_H__
  47
  48 #include <vector>
  49 #include "ExportContext.h"
  50 #include "IStateArchivable.h"
  51
  52 #include "cortex_defs.h"
  53 __BEGIN_CORTEX_NAMESPACE
  54
  55 class NodeExportContext :
  56         public  ExportContext {
  57
  58 public:                                                                                                 // *** dtor/ctor
  59         virtual ~NodeExportContext() {}
  60
  61         NodeExportContext(
  62                 BDataIO*                                                                                _stream,
  63                 BString&                                                                                error) :
  64                 ExportContext(_stream, error) {}
  65
  66 public:                                                                                                 // *** members
  67         // set of nodes to export; if one or more nodes are
  68         // not fit to be exported, they may be removed or
  69         // set to media_node::null.node during the export process.
  70         typedef vector<media_node_id>   media_node_set;
  71         media_node_set                                                          nodes;
  72
  73 public:                                                                                                 // *** interface
  74         virtual void exportUIState(
  75                 BMessage*                                                                               archive) =0;
  76 };
  77
  78 __END_CORTEX_NAMESPACE
  79 #endif /*__NodeExportContext_H__*/