/**
 * @file
 * @brief OBCの時刻情報の定義と演算
 */
#ifndef OBC_TIME_H_
#define OBC_TIME_H_

#include <stdint.h>

typedef uint32_t cycle_t;
typedef uint32_t step_t;

/**
 * @struct ObcTime
 * @brief OBCの時刻情報を保持する構造体
 */
typedef struct
{
  cycle_t total_cycle; //!< TI のこと. OBC が起動してから（正確には，構造体が初期化されてから）の経過時間
  cycle_t mode_cycle;  //!< 最後に mode を変えてからの経過時間
  step_t  step;        //!< 内部 step.  TimeLine での処理時間分割に使われる
} ObcTime;

/**
 * @brief 引数から ObcTime を作成する
 * @param[in] total_cycle
 * @param[in] mode_cycle
 * @param[in] step
 * @return 新規に作成した ObcTime 構造体
 */
ObcTime OBCT_create(cycle_t total_cycle,
                    cycle_t mode_cycle,
                    step_t step);

/**
 * @brief ObcTime をクリアし全てゼロにする
 * @param[in] time クリアされる ObcTime 構造体
 * @return void
 */
void OBCT_clear(ObcTime* time);

/**
 * @brief ObcTimeをstep刻みでインクリメントする
 * @param[in] time カウントアップされる ObcTime 構造体
 * @return void
 */
void OBCT_count_up(ObcTime* time);

/**
 * @brief ObcTime が取りうる最大値を返す
 * @param void
 * @return 各メンバーを最大値にして新規作成した ObcTime 構造体
 */
ObcTime OBCT_get_max(void);

/**
 * @brief 引数で指定した ObcTime の total_cycle を返す
 * @param[in] time
 * @return total_cycle
 */
cycle_t OBCT_get_total_cycle(const ObcTime* time);

/**
 * @brief 引数で指定した ObcTime の mode_cycle を返す
 * @param[in] time
 * @return mode_cycle
 */
cycle_t OBCT_get_mode_cycle(const ObcTime* time);

/**
 * @brief 引数で指定した ObcTime の step を返す
 * @param[in] time
 * @return step
 */
step_t  OBCT_get_step(const ObcTime* time);

/**
 * @brief 引数で指定した ObcTime の total_cycle をミリ秒単位で返す
 * @note uint32_t がオーバーフローする可能性があるので注意
 * @note 計算上はstepも考慮
 * @param[in] time
 * @return ミリ秒単位の total_cycle
 */
uint32_t OBCT_get_total_cycle_in_msec(const ObcTime* time);

/**
 * @brief 引数で指定した ObcTime の mode_cycle をミリ秒単位で返す
 * @note uint32_t がオーバーフローする可能性があるので注意
 * @note 計算上はstepも考慮
 * @param[in] time
 * @return ミリ秒単位の mode_cycle
 */
uint32_t OBCT_get_mode_cycle_in_msec(const ObcTime* time);

/**
 * @brief 引数で指定した ObcTime の total_cycle を秒単位で返す
 * @note 計算上はstepも考慮
 * @param[in] time
 * @return 秒単位の total_cycle. 少数点以下も保持
 */
double OBCT_get_total_cycle_in_sec(const ObcTime* time);

/**
 * @brief 引数で指定した ObcTime の mode_cycle を秒単位で返す
 * @note 計算上はstepも考慮
 * @param[in] time
 * @return 秒単位の mode_cycle. 少数点以下も保持
 */
double OBCT_get_mode_cycle_in_sec(const ObcTime* time);

/**
 * @brief ミリ秒を cycle に変換する
 * @param[in] msec
 * @return cycle (端数は切り捨て)
 */
cycle_t OBCT_msec2cycle(uint32_t msec);

/**
 * @brief cycle をミリ秒に変換する
 * @param[in] cycle
 * @return ミリ秒単位に変換された cycle
 */
uint32_t OBCT_cycle2msec(cycle_t cycle);

/**
 * @brief 秒を cycle に変換する
 * @param[in] sec
 * @return cycle
 */
cycle_t OBCT_sec2cycle(uint32_t sec);

/**
 * @brief cycle を秒に変換する
 * @param[in] cycle
 * @return 秒単位に変換されたcycle (端数は切り捨てて整数にする)
 */
uint32_t OBCT_cycle2sec(cycle_t cycle);

/**
 * @brief ObcTime の引き算を行う
 * @param[in] before
 * @param[in] after
 * @retval after >= before の場合: after から before を引いた結果の ObcTime
 * @retval after <  before の場合: {0, 0, 0}
 */
ObcTime OBCT_diff(const ObcTime* before,
                  const ObcTime* after);

/**
 * @brief ObcTime の引き算を step 単位で行う
 * @note オーバーフローに注意
 * @param[in] before
 * @param[in] after
 * @retval after >= before の場合: after - before を step 単位に変換したもの
 * @retval after <  before の場合: 0
 */
step_t OBCT_diff_in_step(const ObcTime* before,
                         const ObcTime* after);

/**
 * @brief ObcTime の引き算をミリ秒単位で行う
 * @param[in] before
 * @param[in] after
 * @retval after >= before の場合: after - before をミリ秒単位に変換したもの
 * @retval after <  before の場合: 0
 */
uint32_t OBCT_diff_in_msec(const ObcTime* before,
                           const ObcTime* after);

/**
 * @brief ObcTime の引き算を秒単位で行う
 * @param[in] before
 * @param[in] after
 * @retval after >= before の場合: after - before を秒単位に変換したもの
 * @retval after <  before の場合: 0
 */
double OBCT_diff_in_sec(const ObcTime* before,
                        const ObcTime* after);

/**
 * @brief ObcTime の足し算を行う
 * @note オーバーフローに注意
 * @param[in] left  一項目
 * @param[in] right 二項目
 * @return 引数を足し合わせた結果の ObcTime
 */
ObcTime OBCT_add(const ObcTime* left, const ObcTime* right);

/**
 * @brief ObcTime の比較
 * @note  mode_cycle は見ない
 * @param[in] t1: 比較対象
 * @param[in] t2: 比較対象
 * @retval 1  : t1 < t2
 * @retval 0  : t1 == t2
 * @retval -1 : t2 > t1
 */
int OBCT_compare(const ObcTime* t1, const ObcTime* t2);

/**
 * @brief デバッグ出力に ObcTime を表示する
 * @param[in] time
 * @return void
 */
void OBCT_print(const ObcTime* time);

#endif