mlBaseItem.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_BASE_ITEM_H
#define ML_BASE_ITEM_H
 
 
 
// 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.
 
// ML-includes
#include "mlBaseInit.h"
#include "mlModuleIncludes.h"
 
ML_START_NAMESPACE
 
class TreeNode;
 
// ------------------------------------------------------------------
// Base object class BaseItem
// ------------------------------------------------------------------
 
class MLBASEEXPORT BaseItem : public Base
{
public:
 
 
  BaseItem () : Base(), _id(0), _name(nullptr) {}
 
  BaseItem (MLssize_t id, const char *nameStr = nullptr) : Base(), _id(id), _name(nullptr) { setName(nameStr); }
 
  BaseItem (const BaseItem &item) : Base(), _name(nullptr) { *this = item; }
 
 
  void setId(MLssize_t id){ _id = id; }
 
  MLssize_t getId() const { return _id; }
 
  ~BaseItem () override { setName(nullptr); }
 
 
  BaseItem &operator = (const BaseItem &item);
 
 
  const char *name () const { return _name; }
 
  void setName (const char *newName);
 
 
 
  std::string persistentState() const override;
 
  void setPersistentState(const std::string& state) override;
 
#if !ML_DEPRECATED_SINCE(3,5,0)
protected:
#endif
  [[nodiscard]]
  [[deprecated]] char *getPersistentState () const override;
 
  [[deprecated]] void setPersistentState (const char *state) override;
 
#if !ML_DEPRECATED_SINCE(3,5,0)
public:
#endif
 
  [[deprecated]] void clearPersistentState(char *state) const override;
 
 
  void addStateToTree(TreeNode* parent) const override;
 
 
  ML_SET_ADDSTATE_VERSION(0);
 
  void readStateFromTree(TreeNode* parent) override;
 
  void writeTo(AbstractPersistenceOutputStream* stream) const override;
 
  void readFrom(AbstractPersistenceInputStream* stream, int version) override;
 
 
  BaseItem* deepCopy() const override { 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