関数determine_filename_from_pattern マニュアル

(The documentation of function determine_filename_from_pattern)
Last Update: 2023/11/29


◆機能・用途(Purpose)

日時や観測点・成分コードをパターンとして含む文字列 に対して具体的な値を代入した文字列を作成する。
Create a string by substituting a specific date, time, station and component codes into a string that includes them as a pattern.
この文字列はファイル名として用いることを想定している。
This string is supposed to be used for a file name.

◆形式(Format)

#include <mystring.h>
inline char ∗determine_filename_from_pattern
(const char ∗string_with_pattern,const struct humanTime dateTime,
 const char ∗station,const char ∗component)


◆引数(Arguments)

string_with_pattern 元々の文字列。以下をパターンとして含んでいて良い。
The original string, which may consist of the following patterns.
  • %YYYY
    年(西暦、4桁)
    Year (A.D., 4-digits)

  • %YY
    年(西暦、下2桁)
    Year (A.D., lowest 2-digits)

  • %MM
    月(2桁)
    Month (2-digits)

  • %DD
    日(2桁)
    Day (2-digits)

  • %hh
    時(2桁)
    Hour (2-digits)

  • %mm
    分(2桁)
    Minute (2-digits)

  • %ss
    秒(2桁)
    Second (2-digits)

  • %STATION
    観測点コード
    Station code

  • %COMPONENT
    成分コード
    Component code

dateTime 代入する日付・時刻。 引数string_with_patternが 日付・時刻に関するパターン文字列を含まない場合は 無視されるので適当な値を与えれば良い。
The date and time to substitute. If the argument string_with_pattern does not have a pattern string for the date and time, give an arbitrary value as it is ignored.
station 代入する観測点コード。 引数string_with_patternが 観測点コードのパターン文字列を含まない場合は 無視されるので適当な値を与えれば良い。
The station code to substitute. If the argument string_with_pattern does not have a pattern string for the station code, give an arbitrary value as it is ignored.
component 代入する成分コード。 引数string_with_patternが 成分コードのパターン文字列を含まない場合は 無視されるので適当な値を与えれば良い。
The component code to substitute. If the argument string_with_pattern does not have a pattern string for the component code, give an arbitrary value as it is ignored.


◆戻り値(Return value)

引数string_with_patternにおける 日付・時刻に関するパターン文字列(%YYYY等)を引数dateTimeの値で、 観測点コードのパターン文字列(%STATION)を引数stationの値で、 成分コードのパターン文字列(%COMPONENT)を引数componentの値で 置き換えて得られる文字列。
A string obtained by replacing pattern strings for the date and time (e.g., %YYYY) in the argument string_with_pattern by the value of the argument dateTime, a pattern string for the station code (%STATION) by the value of the argument station, and a pattern string for the component code (%COMPONENT) by the value of the argument component.

◆使用例(Example)

struct humanTime dateTime={2023,11,1,0,0,0.0};
char ∗filename=determine_filename_from_pattern ("data_%STATION/%YYYY-%MM/%YY%MM%DD%hh.dat",dateTime,"NU.STN1","");

この例では filename=data_NU.STN1/2023-11/23110100.dat となる。
This example gives filename=data_NU.STN1/2023-11/23110100.dat.