Skip to content

writefunc

Rafka86 edited this page Jul 31, 2017 · 3 revisions

関数の解説

このページでは,BB2Driverで利用できる関数の内,書き込みの関数を対象として,

  • 関数の処理内容
  • 関数の引数
  • 関数の戻り値

をそれぞれ説明していく.

WriteChar関数

int BB2D_WriteChar(const unsigned short addr, const char src);

ビュートバランサーのメモリマップの指定したアドレスに,char型の値を通信で書き込む.

引数は,

  • const unsigned short addr:メモリマップの書き込み対象アドレス.
  • const char src:書き込む値.

戻り値は,関数の実行の成否.

  • EXIT_SUCCESS:処理が問題なく終了した.
  • EXIT_FAILURE:いくつかの原因が考えられるので,同時に出力されるログに注意する.
    • Init関数が実行されていない.
    • 指定したアドレスが領域外参照になっている.
    • 指定したアドレスのデータ型がchar型ではない.
  • その他:USB通信に失敗した.詳細はエラーログを参照せよ.

WriteUChar関数

int BB2D_WriteUChar(const unsigned short addr, const unsigned char src);

ビュートバランサーのメモリマップの指定したアドレスに,unsigned char型の値を通信で書き込む.

引数は,

  • const unsigned short addr:メモリマップの書き込み対象アドレス.
  • const unsigned char src:書き込む値.

戻り値は,関数の実行の成否.

  • EXIT_SUCCESS:処理が問題なく終了した.
  • EXIT_FAILURE:いくつかの原因が考えられるので,同時に出力されるログに注意する.
    • Init関数が実行されていない.
    • 指定したアドレスが領域外参照になっている.
    • 指定したアドレスのデータ型がunsigned char型ではない.
  • その他:USB通信に失敗した.詳細はエラーログを参照せよ.

WriteShort関数

int BB2D_WriteShort(const unsigned short addr, const short src);

ビュートバランサーのメモリマップの指定したアドレスに,short型の値を通信で書き込む.

引数は,

  • const unsigned short addr:メモリマップの書き込み対象アドレス.
  • const short src:書き込む値.

戻り値は,関数の実行の成否.

  • EXIT_SUCCESS:処理が問題なく終了した.
  • EXIT_FAILURE:いくつかの原因が考えられるので,同時に出力されるログに注意する.
    • Init関数が実行されていない.
    • 指定したアドレスが領域外参照になっている.
    • 指定したアドレスのデータ型がshort型ではない.
  • その他:USB通信に失敗した.詳細はエラーログを参照せよ.

WriteUShort関数

int BB2D_WriteUShort(const unsigned short addr, const unsigned short src);

ビュートバランサーのメモリマップの指定したアドレスに,unsigned short型の値を通信で書き込む.

引数は,

  • const unsigned short addr:メモリマップの書き込み対象アドレス.
  • const unsigned short src:書き込む値.

戻り値は,関数の実行の成否.

  • EXIT_SUCCESS:処理が問題なく終了した.
  • EXIT_FAILURE:いくつかの原因が考えられるので,同時に出力されるログに注意する.
    • Init関数が実行されていない.
    • 指定したアドレスが領域外参照になっている.
    • 指定したアドレスのデータ型がunsigned short型ではない.
  • その他:USB通信に失敗した.詳細はエラーログを参照せよ.

WriteLong関数

int BB2D_WriteLong(const unsigned short addr, const long src);

ビュートバランサーのメモリマップの指定したアドレスに,long型の値を通信で書き込む.

引数は,

  • const unsigned short addr:メモリマップの書き込み対象アドレス.
  • const long src:書き込む値.

戻り値は,関数の実行の成否.

  • EXIT_SUCCESS:処理が問題なく終了した.
  • EXIT_FAILURE:いくつかの原因が考えられるので,同時に出力されるログに注意する.
    • Init関数が実行されていない.
    • 指定したアドレスが領域外参照になっている.
    • 指定したアドレスのデータ型がlong型ではない.
  • その他:USB通信に失敗した.詳細はエラーログを参照せよ.

WriteULong関数

int BB2D_WriteULong(const unsigned short addr, const unsigned long src);

ビュートバランサーのメモリマップの指定したアドレスに,unsigned long型の値を通信で書き込む.

引数は,

  • const unsigned short addr:メモリマップの書き込み対象アドレス.
  • const unsgined long src:書き込む値.

戻り値は,関数の実行の成否.

  • EXIT_SUCCESS:処理が問題なく終了した.
  • EXIT_FAILURE:いくつかの原因が考えられるので,同時に出力されるログに注意する.
    • Init関数が実行されていない.
    • 指定したアドレスが領域外参照になっている.
    • 指定したアドレスのデータ型がunsigned long型ではない.
  • その他:USB通信に失敗した.詳細はエラーログを参照せよ.

WriteDouble関数

int BB2D_WriteDouble(const unsigned short addr, const double src);

ビュートバランサーのメモリマップの指定したアドレスに,double型の値を通信で書き込む.

引数は,

  • const unsigned short addr:メモリマップの書き込み対象アドレス.
  • const double out:書き込む値.

戻り値は,関数の実行の成否.

  • EXIT_SUCCESS:処理が問題なく終了した.
  • EXIT_FAILURE:いくつかの原因が考えられるので,同時に出力されるログに注意する.
    • Init関数が実行されていない.
    • 指定したアドレスが領域外参照になっている.
    • 指定したアドレスのデータ型がdouble型ではない.
  • その他:USB通信に失敗した.詳細はエラーログを参照せよ.