ColCOWS_WorkspaceDesc.hh

//===========================================================================//
//    
//    Description: interface for user defined event handling classes
//    Filename: colcows/ColCOWS_WorkspaceDesc.hh
//    Authors: Michael Dussere and Aurélien Esnard
//    
//===========================================================================//
//    
//    Copyright (C) 2003 INRIA and CNRS
//    
//    This library is free software; you can redistribute it and/or
//    modify it under the terms of the GNU Lesser General Public
//    License as published by the Free Software Foundation; either
//    version 2.1 of the License, or (at your option) any later version.
//    
//    This library is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//    Lesser General Public License for more details.
//    
//    You should have received a copy of the GNU Lesser General Public
//    License along with this library; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//    
//===========================================================================//

#ifndef __COLCOWS_WORKSPACE_DESC_HH__
#define __COLCOWS_WORKSPACE_DESC_HH__

//---------------------------------------------------------------------------//
#include "ColCOWS_Include.hh"
#include "ColCOWS_Debug.hh" 
#include "ColCOWS_NodeDesc.hh" 
//---------------------------------------------------------------------------//

namespace ColCOWS {
  struct IdlWorkspaceDesc;
  class NodeInterface;
};

__COLCOWS_BEGIN__

//! Workspace Description
/** 
 *
 */
class WorkspaceDesc : public std::vector<NodeDesc>
{

  //================================================//
  //=========== class standard interface ===========//
public:
  //! standard constructor
  WorkspaceDesc() {}

  //! idl constructor
  WorkspaceDesc( const IdlWorkspaceDesc & idl_ws_desc ) { convertFromIdl(idl_ws_desc); } 
  
  //! destructor
  virtual ~WorkspaceDesc() {}

  //! print self
  virtual void printself(std::ostream & stream, int indent = 0) const;

  //=========================================//
  //=========== public  interface ===========//
public:

  //! get a vector of references on the workspace
  void  getObjectDescVec( ExtObjectDescVec & object_desc_vec, 
                          std::string node_kind = "", 
                          std::string obj_id = "", 
                          std::string obj_kind = "" ) const ;

  //! idl import
  void convertFromIdl( const IdlWorkspaceDesc & idl_ws_desc);

  //=========== Accessors ===========//
public:

  //! get/set Workspace Id
  inline std::string getId() const { return _ws_id; }
  //! get/set Workspace Id
  inline void setId(std::string ws_id) { _ws_id = ws_id; }

  //! get/set Workspace Kind
  inline std::string getKind() const { return _ws_kind; }
  //! get/set Workspace Kind
  inline void setKind(std::string ws_kind) { _ws_kind = ws_kind; }

  //! get/set Workspace Activated
  inline bool getActivated() const { return _activated; }
  //! get/set Workspace Activated
  inline void setActivated(bool activated) { _activated = activated; }

  //! get/set Number of nodes in the workspace
  inline unsigned long getNbNodes() const { return _nb_nodes; }
  //! get/set Number of nodes in the workspace
  inline void setNbNodes(unsigned long nb_nodes ) { _nb_nodes = nb_nodes; }

  //! get/set the connection number
  inline unsigned long getNumConnection() const { return _num_connection; }
  //! get/set the connection number
  inline void setNumConnection(unsigned long num_connection ) { _num_connection = num_connection; }

  //  //! get/set the enter node interface
  //  inline NodeInterface * getEnterNodeInterface() const { return _enter_node_ref; }
  //  //! get/set the enter node interface
  //  inline void setEnterNodeInterface(NodeInterface * enter_node_ref ) { _enter_node_ref = enter_node_ref; }


  //=========== Complex Accessors ===========//
public:

  //! get number of nodes in the workspace with a certain kind
  unsigned long getNbNodes( std::string node_kind ) const;

protected:

  //! Workspace Id
  std::string    _ws_id;

  //! Workspace Kind
  std::string    _ws_kind;
  
  //! Number of nodes in the workspace
  unsigned long  _nb_nodes;
  
  //! Is the workspace activated
  bool _activated;

  //! Local number of connection
  unsigned long  _num_connection;
  
  //  //! Reference on the root ColCOWS Node
  //  NodeInterface * _enter_node_ref;
  
};

//------------------------------------------------------------------------// 

//! standard output stream operator
inline std::ostream & operator <<(std::ostream & stream, const WorkspaceDesc & _this)
{
  stream << "WorkspaceDesc { " << std::endl;
  _this.printself(stream);
  stream << "}" << std::flush;
  return stream;
}

__COLCOWS_END__

#endif // __COLCOWS_WORKSPACE_DESC_HH__

// EOF

---