ColCOWS_NodeDesc.hh

//===========================================================================//
//    
//    Description: interface for user defined event handling classes
//    Filename: colcows/ColCOWS_NodeDesc.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_NODE_DESC_HH__
#define __COLCOWS_NODE_DESC_HH__

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

namespace ColCOWS {
  struct IdlNodeDesc;
};


__COLCOWS_BEGIN__

//! Node Description
/**  
 * Unlike the IDL description, the class NodeDesc does'nt contain the hierarchy of the node.
 */
class NodeDesc : public std::map<std::string, ObjectDesc>
{

  //================================================//
  //=========== class standard interface ===========//
public:
  //! constructor
  NodeDesc():_activated(false){}
  
  //! idl constructor
  NodeDesc( const IdlNodeDesc & idl_node_desc ) { convertFromIdl( idl_node_desc );}
  
  //! destructor
  virtual ~NodeDesc() {}

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

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

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

  //! idl import
  /** This method build the node description according to an IDL description. 
      Unlike the IDL description, the class NodeDesc does'nt contain the hierarchy of the node **/
  void convertFromIdl( const IdlNodeDesc & idl_node_desc );

  //! idl export
  /** This method build an IDL description according to the class NodeDesc. 
      Unlike the IDL description, the class NodeDesc does'nt contain the hierarchy of the node **/
  void convertToIdl(IdlNodeDesc & idl_node_desc) const;

  //! update idl description
  /** This method update the listof the CORBA objects in th IDL description according to the class NodeDesc. 
      Unlike the IDL description, the class NodeDesc does'nt contain the hierarchy of the node **/
  void updateIdl( IdlNodeDesc & idl_node_desc ) const;

  //! set a reference for this node
  void addReference( std::string obj_id, std::string obj_kind, CORBA::Object * ref) ;

  //! get a reference from this node
  CORBA::Object * getReference( std::string obj_id ) const ;

  //! clear all the references of this node
  void clearReferences( ) ;
  
  //=========== Accessors ===========//
public:
  //! get node kind
  inline std::string getKind() const { return _node_kind; }
  //! set node kind
  inline void setKind(std::string node_kind) { _node_kind = node_kind; }

  //! get node number
  inline unsigned long getNumNode() const { return _num_node; }
  //! set node number
  inline void setNumNode(unsigned long num_node) { _num_node = num_node; }

  //! get max node number of the descendants
  inline unsigned long getMaxDescendant() const { return _max_descendant; }
  //! set max node number of the descendants
  inline void setMaxDescendant(unsigned long max_descendant) { _max_descendant = max_descendant; }

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

protected:

    //! Kind of the Workspace node ("proxy", "node", "master" ...)
    std::string  _node_kind;

    //! Number of the node among the node hierarchy
    unsigned long  _num_node;

    //! Max number of its descendants among the node hierarchy
    unsigned long  _max_descendant;

    //! Is the node activated
    bool  _activated;

};

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

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

__COLCOWS_END__

#endif // __COLCOWS_NODE_DESC_HH__

// EOF

---