source: trunk/yao/src/YAOObjects/Trajectory.hpp @ 1

//! \file    Trajectory.hpp
//! \brief   Declaration and implementation of the Trajectory class, which
//!          handles model (time) trajectories.
//! \version 2007/10/01 (yyyy/mm/dd) 
//! \author  Luigi Nardi <luiginardi(at)gmail.com> 
//
// This file is part of YAO, a framework for variational assimilation in
// numerical models.
// Copyright (c) 2001-onwards LOCEAN. All rights reserved.
//
// This program may be redistributed and/or modified under the terms of the GNU
// General Public License as published by the Free Software Foundation, either
// version 2 of the license, or (at your option) any later version.
//
// This program is provided AS IS and WITHOUT ANY WARRANTY, including any
// implied warranty of DESIGN, MERCHANTABILITY or FITNESS FOR A PARTICULAR
// PURPOSE.


#ifndef YAO_TRAJECTORY_HPP_INCLUDED
#define YAO_TRAJECTORY_HPP_INCLUDED

//#include "../help/Enforcer.hpp"
#include "Object.hpp"

namespace yao{

  //! Trajectory class, handles model (time) trajectories.
  class Trajectory: public Object{

    public:

      typedef char Type; //!< Supported types: any alphabetical letter is admitted.

      /**
       * Default constructor.
       * @param aName is the name of the trajectory.
       * @param aBoot is the number of boot steps (so-called uptime), is the initialization time.
       * @param aSize is the total number of steps (so-called nbsteptime).
       * @param aStep is the time step (so-called dtime).
       * @param anOffset is the Time offset (so-called offtime).
       * @param aType is a label for the trajectory.
       */
      Trajectory(const std::string& aName="", int aBoot=0, int aSize=1, double aStep=1, double anOffset=0, char aType='M');

      /**
       * Get the boot number of the trajectory.
       * @return the boot number.
       */
      int getBoot() const { return theBoot; }

      /**
       * Get the size number of the trajectory.
       * @return the size number.
       */
      int getSize() const { return theSize; }

      /**
       * Get the step number of the trajectory.
       * @return the step number.
       */
      double getStep() const { return theStep; }

      /**
       * Get the offset number of the trajectory.
       * @return the offset number.
       */
      double getOffset() const { return theOffset; }

      /**
       * Get the type label of the trajectory.
       * @return the character label.
       */
      char getType() const { return theType; }

      /** 
       * Set the trajectory counter of the directive order. 
       * true the Trajectory has been already inserted in the header of the directive order spaceintraj, false otherwise.
       * With "in the header" we mean the first line of the directive order: order spaceintraj traj_name.... 
       * This is in opposite with the body of the directive that is the rest of the directive.
       * With this header example traj_name will be marked to true.
       * We can find trajectories only in the header of one spaceintraj directive. This counter allows to perform this control.
       * Note that for the space is different because we have to check the space in the header of modinspace and the space in the body of spaceintraj.
       * @param flag true if we want to enable this option, false otherwise.
       */
      void setCounterOrder(bool flag){ counterOrder = flag; }

      /**
       * Check if the trajectory has been already inserted in an header of the directive spaceintraj.
       * @return true the object has been already inserted in the directive, false otherwise.
       */
      bool isCounterOrder(){ return counterOrder; }

      //! The number of information stored in this class.
      static int getPropertyCount() { return 6; }

      //! Get the name of the property: "trajectory", "boot", "size", "step", "offset", "type".
      static std::string getPropertyName(int anIndex){
        ENFORCE(anIndex >= 0 && anIndex < Trajectory::getPropertyCount());
        static const char* propertyName[] = { "trajectory", "boot", "size", "step", "offset", "type" };

        return propertyName[anIndex];
      }

      //! Get the information in function of an integer that identifies it.
      std::string getProperty(int anIndex) const;
    
    private:

      int theBoot;        //!< Number of boot steps (so-called uptime).
      int theSize;        //!< Total number of steps (so-called nbsteptime).
      double theStep;     //!< Time step (so-called dtime).
      double theOffset;   //!< Time offset (so-called offtime).
      Type theType;       //!< Type/label.
      bool counterOrder;  //!< A counter to control that the directive order spaceintraj include at least one time this object.
  };

  inline
    Trajectory::Trajectory(const std::string& aName, int aBoot, int aSize, double aStep, double anOffset, char aType):
      Object(aName), theBoot(aBoot), theSize(aSize), theStep(aStep), theOffset(anOffset), theType(aType), counterOrder(false){
        ENFORCE(theOffset >= 0.0);
        ENFORCE(theBoot >= 0);
        ENFORCE(theStep > 0);
        ENFORCE(theSize > 0);
        ENFORCE(theBoot < theSize);
        ENFORCE((theType >= 'a' && theType <= 'z') || (theType >= 'A' && theType <= 'Z'));
      }

  inline
    std::string Trajectory::getProperty(int anIndex) const{
      std::string property = Object::getProperty(anIndex);
      switch (anIndex){
        case 1:
          property = stream_cast<std::string>(theBoot);
          break;
        case 2:
          property = stream_cast<std::string>(theSize);
          break;
        case 3:
          property = stream_cast<std::string>(theStep);
          break;
        case 4:
          property = stream_cast<std::string>(theOffset);
          break;
        case 5:
          property = stream_cast<std::string>(theType);
      }

      return property;
    }

} // Namespace yao.
#endif // !YAO_TRAJECTORY_HPP_INCLUDED.