MeVisLab/Standard/Sources/ML/MLBase/mlBaseItem.h

Go to the documentation of this file.

// **InsertLicense** code
//----------------------------------------------------------------------------------

//
// Defines the following class:
// - BaseItem: A general base class (derived from Base) for list items that have 
//     an id and a name. Should be used for list objects that are editable via a 
//     container and/or editor module.
//----------------------------------------------------------------------------------

#ifndef __mlBaseItem_H
#define __mlBaseItem_H


// ML-includes
#ifndef __mlBaseInit_H
#include "mlBaseInit.h"
#endif
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif

ML_START_NAMESPACE

class TreeNode;

// ------------------------------------------------------------------
// Base object class BaseItem
// ------------------------------------------------------------------

class MLBASEEXPORT BaseItem : public Base
{
public:



  BaseItem () : Base(), _id(0), _name(NULL) {}
  
  BaseItem (MLssize_t id, const char *nameStr = NULL) : Base(), _id(id), _name(NULL) { setName(nameStr); }
  
  BaseItem (const BaseItem &item) : Base(), _name(NULL) { *this = item; }


  void setId(MLssize_t id){ _id = id; }

  MLssize_t getId() const { return _id; }
  
  virtual ~BaseItem () { setName(NULL); }

  
  virtual BaseItem &operator = (const BaseItem &item);

  bool operator <(const BaseItem &) const { return false; }

  bool operator ==(const BaseItem &) const { return false; }


  const char *name () const { return _name; }
  
  void setName (const char *newName);




  virtual char *getPersistentState () const;

  virtual void setPersistentState (const char *state);

  virtual void clearPersistentState (char *state) const;

  virtual void addStateToTree(TreeNode* parent) const;


  ML_SET_ADDSTATE_VERSION(0);

  virtual void readStateFromTree(TreeNode* parent);

  virtual void writeTo(AbstractPersistenceOutputStream* stream) const;

  virtual void readFrom(AbstractPersistenceInputStream* stream, int version);


  virtual BaseItem* deepCopy() const { return new BaseItem(*this); };

protected:

  char *newString (const std::string &str) const;

  void deleteString (char *str) const;


private:

  MLssize_t _id;

  char *_name;

  ML_CLASS_HEADER(BaseItem)

};


ML_END_NAMESPACE


#endif // __mlBaseItem_H