SEAction.h

/**************************************************************************************
Copyright 2015 Applied Research Associates, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the License
at:
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
**************************************************************************************/

#pragma once
#include <biogears/cdm/CommonDataModel.h>
#include <biogears/exports.h>

CDM_BIND_DECL(ActionData);

namespace biogears {
class SESubstanceManager;

class BIOGEARS_API SEAction : public Loggable {
public:
  virtual const char* classname() const = 0;

  SEAction();
  virtual ~SEAction();

  virtual void Clear(); // Deletes all members

  virtual bool IsValid() const { return true; }
  virtual bool IsActive() const { return IsValid(); }

  static SEAction* newFromBind(const CDM::ActionData& action, SESubstanceManager& substances);

  virtual bool Load(const CDM::ActionData& in);
  virtual CDM::ActionData* Unload() const;

protected:
  void Unload(CDM::ActionData& data) const;

public:
  virtual const char* GetComment() const;
  virtual void SetComment(const char* comment);
  virtual void SetComment(const std::string& comment);
  virtual bool HasComment() const;
  virtual void InvalidateComment();

  virtual void ToString(std::ostream& str) const = 0;
  virtual const char* ToString() const;
 
protected:
  std::string m_Comment;
  mutable std::string m_StringRepresnetation; //<Cached Value of the last called to ToString();
};

inline std::ostream& operator<<(std::ostream& out, const SEAction& a)
{
  a.ToString(out);
  return out;
}
}