SEForcedInhale.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/patient/actions/SEConsciousRespirationCommand.h>
#include <biogears/schema/cdm/PatientActions.hxx>

namespace biogears {
class SEScalar0To1;
class SEConsciousRespiration;

class BIOGEARS_API SEForcedInhale : public SEConsciousRespirationCommand {
  friend class SEConsciousRespiration;
  SEForcedInhale();

public:
  virtual ~SEForcedInhale();

  virtual void Clear(); //clear memory

  virtual bool IsValid() const;
  virtual bool IsActive() const;

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

protected:
  virtual void Unload(CDM::ForcedInhaleData& data) const;

public:
  virtual bool HasInspiratoryCapacityFraction() const;
  virtual SEScalar0To1& GetInspiratoryCapacityFraction();

  virtual bool HasPeriod() const;
  virtual SEScalarTime& GetPeriod();

  virtual void ToString(std::ostream& str) const;

protected:
  SEScalar0To1* m_InspiratoryCapacityFraction;
  SEScalarTime* m_Period;
};
}