INVADER 衛星を操作する機能を提供するクラス [詳細]

ofxInvaderSATに対する継承グラフ

ofxInvaderSATのコラボレーション図

Public 型
enum	SensorEnum { SENSOR_TIME_OBC = super::SENSOR_LIMIT, SENSOR_POWER_SOLARPX, SENSOR_POWER_SOLARMX, SENSOR_POWER_SOLARPY, SENSOR_POWER_SOLARMY, SENSOR_POWER_SOLARPZ, SENSOR_POWER_SOLARMZ, SENSOR_POWER_BATTERY, SENSOR_TEMPERATURE_SOLARPX, SENSOR_TEMPERATURE_SOLARMX, SENSOR_TEMPERATURE_SOLARPY, SENSOR_TEMPERATURE_SOLARMY, SENSOR_TEMPERATURE_SOLARPZ, SENSOR_TEMPERATURE_SOLARMZ, SENSOR_TEMPERATURE_BATTERY, SENSOR_GYRO_X, SENSOR_GYRO_Y, SENSOR_GYRO_Z, SENSOR_MAGNETOMETER_X, SENSOR_MAGNETOMETER_Y, SENSOR_MAGNETOMETER_Z, SENSOR_LIMIT }

typedef ofxInvaderSAT	self

typedef ofxSATRemoteDB	super

enum	FormatEnum { FORMAT_BOOL, FORMAT_INT, FORMAT_DOUBLE, FORMAT_STRING, FORMAT_OFXSATTIME, FORMAT_LIMIT }

enum	UnitEnum { UNIT_NONE, UNIT_UNDEFINED, UNIT_GV, UNIT_MV, UNIT_kV, UNIT_V, UNIT_mV, UNIT_uV, UNIT_nV, UNIT_GA, UNIT_MA, UNIT_kA, UNIT_A, UNIT_mA, UNIT_uA, UNIT_nA, UNIT_GW, UNIT_MW, UNIT_kW, UNIT_W, UNIT_mW, UNIT_uW, UNIT_nW, UNIT_GWh, UNIT_MWh, UNIT_kWh, UNIT_Wh, UNIT_mWh, UNIT_uWh, UNIT_nWh, UNIT_GJ, UNIT_MJ, UNIT_kJ, UNIT_J, UNIT_mJ, UNIT_uJ, UNIT_nJ, UNIT_Gm, UNIT_Mm, UNIT_km, UNIT_m, UNIT_mm, UNIT_um, UNIT_nm, UNIT_rad, UNIT_deg, UNIT_Gm_s, UNIT_Mm_s, UNIT_km_s, UNIT_m_s, UNIT_mm_s, UNIT_um_s, UNIT_nm_s, UNIT_rad_s, UNIT_deg_s, UNIT_Gm_ss, UNIT_Mm_ss, UNIT_km_ss, UNIT_m_ss, UNIT_mm_ss, UNIT_um_ss, UNIT_nm_ss, UNIT_rad_ss, UNIT_deg_ss, UNIT_GK, UNIT_MK, UNIT_kK, UNIT_K, UNIT_mK, UNIT_uK, UNIT_nK, UNIT_degC, UNIT_degF, UNIT_GT, UNIT_MT, UNIT_kT, UNIT_T, UNIT_mT, UNIT_uT, UNIT_nT, UNIT_LIMIT }

typedef int	SensorType

Public メソッド
	ofxInvaderSAT (void)

virtual	~ofxInvaderSAT (void)

ofxSATError	setUpdateInterval (ofxSATTimeDiff const &param)

ofxSATTimeDiff const &	getUpdateInterval (void) const

ofxSATError	setRetryInterval (ofxSATTimeDiff const &param)

ofxSATTimeDiff const &	getRetryInterval (void) const

virtual ofxSATError	getAvailableCount (int *result) const

virtual ofxSATError	getAvailableCount (ofxSATTime const &begin, ofxSATTime const &end, int *result) const

virtual ofxSATError	getAvailableTime (std::vector< ofxSATTime > *result) const

virtual ofxSATError	getAvailableTime (ofxSATTime const &begin, ofxSATTime const &end, std::vector< ofxSATTime > *result) const

virtual ofxSATError	getSensorFormat (SensorType sensor, FormatEnum *result) const

virtual ofxSATError	getSensorUnit (SensorType sensor, UnitEnum *result) const

virtual ofxSATError	getSensorMinimum (SensorType sensor, void *result, int size) const

virtual ofxSATError	getSensorMaximum (SensorType sensor, void *result, int size) const

virtual ofxSATError	getSensorData (SensorType sensor, ofxSATTime const &time, void result, int size, bool simulation=NULL) const

ofxSATError	getSensorTimeOBC (ofxSATTime const &time, int result, bool simulation=NULL) const

ofxSATError	getSensorPowerSolarPX (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorPowerSolarMX (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorPowerSolarPY (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorPowerSolarMY (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorPowerSolarPZ (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorPowerSolarMZ (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorPowerBattery (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorTemperatureSolarPX (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorTemperatureSolarMX (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorTemperatureSolarPY (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorTemperatureSolarMY (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorTemperatureSolarPZ (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorTemperatureSolarMZ (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorTemperatureBattery (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorGyroX (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorGyroY (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorGyroZ (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorMagnetometerX (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorMagnetometerY (ofxSATTime const &time, double result, bool simulation=NULL) const

ofxSATError	getSensorMagnetometerZ (ofxSATTime const &time, double result, bool simulation=NULL) const

virtual ofxSATError	setup (void)

virtual void	cleanup (void)

virtual ofxSATError	update (ofxSATTime const &time=ofxSATTime::currentTime())

std::string const &	getID (void) const

ofxSATError	getTLE (TLERec tle, ofxSATTime time=NULL) const

ofxSATError	setNotifier (Notifier *param)

Notifier *	getNotifier (void) const

bool	isValid (void) const

Protected メソッド
void	setID (std::string const &param)

void	setTLE (TLERec const &tle, ofxSATTime const &time)

void	notifyData (ofxSATTime const &time) const

void	notifyFinish (ofxSATError const &error) const

Static Protected メソッド
static std::string	trimSpace (std::string const &param)

static std::string	trimNonNumeric (std::string const &param)

static std::string	replaceString (std::string const &string, std::string const &from, std::string const &to)

static ofxSATError	checkSize (FormatEnum format, int size)

説明

INVADER 衛星を操作する機能を提供するクラス

ofxInvaderSAT クラスは INVADER 衛星からデータを取得したり INVADER 衛星にコマンドを送信したりする機能を提供します。 INVADER 衛星を操作するには、このクラスのインスタンスを作成して利用します。

覚え書き: 現在のバージョンでは、INVADER 衛星のシミュレーションモデルから計算されたデータを取得する機能のみが実装されています。

ofxInvaderSAT クラスの代表的な使い方

#include "ofMain.h"
#include "ofxARTSATAPI.h"
// クラスの定義
class testApp : public ofBaseApp, private ofxSAT::Notifier {
    private:
        // ofxInvaderSAT クラスのインスタンス
        ofxInvaderSAT _invader;
    public:
        void setup(void);
        void exit(void);
        void draw(void);
    private:
        // 通知を受け取るための関数
        virtual void onNotifyTLE(ofxSAT::TLERec const& tle, ofxSATTime const& time);
        virtual void onNotifyData(ofxSATTime const& time);
};
// クラスの実装
void testApp::setup(void)
{
    // 通知を受け取るために通知先を設定
    if (_invader.setNotifier(this) == SATERROR_OK) {
        // 初期化して開始
        if (_invader.setup() == SATERROR_OK) {
            cout << "Hello ARTSAT." << endl;
        }
    }
    return;
}
void testApp::exit(void)
{
    // リソースを解放して終了
    _invader.cleanup();
    return;
}
void testApp::draw(void)
{
    ofxSATTime begin;
    ofxSATTime end;
    std::vector<ofxSATTime> available;
    double value;
    int i;
    // １時間前から現在の時刻までを計算
    end = ofxSATTime::currentTime();
    begin = ofxSATTime(end).subHour(1);
    // １時間前から現在の時刻までの間でデータを取得可能な時刻のリストを取得
    if (_invader.getAvailableTime(begin, end, &available) == SATERROR_OK) {
        for (i = 0; i < available.size(); ++i) {
            // データが存在する時刻の「+X 面の太陽電池の温度」を取得
            if (_invader.getSensorTemperatureSolarPX(available[i], &value) == SATERROR_OK) {
                cout << "the temperature of solar panel +X is " << value << " degC." << endl;
            }
        }
    }
    return;
}
// TLE 情報が更新されたときに呼び出される関数
void testApp::onNotifyTLE(ofxSAT::TLERec const& tle, ofxSATTime const& time)
{
    // 親クラスの実装を呼び出して情報を出力（オプション）
    ofxSAT::Notifier::onNotifyTLE(tle, time);
    cout << "new TLE received." << endl;
    return;
}
// センサデータが更新されたときに呼び出される関数
void testApp::onNotifyData(ofxSATTime const& time)
{
    // 親クラスの実装を呼び出して情報を出力（オプション）
    ofxSAT::Notifier::onNotifyData(time);
    cout << "new telemetry data received." << endl;
    return;
}

型定義

typedef ofxInvaderSAT ofxInvaderSAT::self

自クラスを表す型の別名です。

typedef ofxSATRemoteDB ofxInvaderSAT::super

親クラスを表す型の別名です。

typedef int ofxSAT::SensorType

inherited

センサを表す型です。 ofxSAT::SensorEnum 型は直接使用されることはなくセンサを表すには ofxSAT::SensorType 型を使用します。 ofxSAT::SensorType 型の変数には ofxSAT::SensorEnum 型の定数を代入します。

列挙型

enum ofxInvaderSAT::SensorEnum

衛星がサポートしているセンサを表す定数です。 ofxInvaderSAT::SENSOR_LIMIT は具体的なセンサを表す値ではなくセンサ定数の最大値を表します。

列挙型の値:

SENSOR_TIME_OBC	衛星の内部時刻
SENSOR_POWER_SOLARPX	+X 面の太陽電池の発電電力量
SENSOR_POWER_SOLARMX	-X 面の太陽電池の発電電力量
SENSOR_POWER_SOLARPY	+Y 面の太陽電池の発電電力量
SENSOR_POWER_SOLARMY	-Y 面の太陽電池の発電電力量
SENSOR_POWER_SOLARPZ	+Z 面の太陽電池の発電電力量
SENSOR_POWER_SOLARMZ	-Z 面の太陽電池の発電電力量
SENSOR_POWER_BATTERY	内蔵蓄電池の放電電力量
SENSOR_TEMPERATURE_SOLARPX	+X 面の太陽電池の温度
SENSOR_TEMPERATURE_SOLARMX	-X 面の太陽電池の温度
SENSOR_TEMPERATURE_SOLARPY	+Y 面の太陽電池の温度
SENSOR_TEMPERATURE_SOLARMY	-Y 面の太陽電池の温度
SENSOR_TEMPERATURE_SOLARPZ	+Z 面の太陽電池の温度
SENSOR_TEMPERATURE_SOLARMZ	-Z 面の太陽電池の温度
SENSOR_TEMPERATURE_BATTERY	内蔵蓄電池の温度
SENSOR_GYRO_X	X 軸の角速度
SENSOR_GYRO_Y	Y 軸の角速度
SENSOR_GYRO_Z	Z 軸の角速度
SENSOR_MAGNETOMETER_X	X 軸の磁力
SENSOR_MAGNETOMETER_Y	Y 軸の磁力
SENSOR_MAGNETOMETER_Z	Z 軸の磁力
SENSOR_LIMIT	センサ定数の最大値

enum ofxSAT::FormatEnum

inherited

センサの値の書式を表す定数です。 ofxSAT::FORMAT_LIMIT は具体的な書式を表す値ではなく書式定数の最大値を表します。

列挙型の値:

FORMAT_BOOL	bool 型
FORMAT_INT	int 型
FORMAT_DOUBLE	double 型
FORMAT_STRING	std::string 型
FORMAT_OFXSATTIME	ofxSATTime 型
FORMAT_LIMIT	書式定数の最大値

enum ofxSAT::UnitEnum

inherited

センサの値の単位を表す定数です。 ofxSAT::UNIT_LIMIT は具体的な単位を表す値ではなく単位定数の最大値を表します。

列挙型の値:

UNIT_NONE	単位なし
UNIT_UNDEFINED	定義されていない
UNIT_GV	ギガボルト
UNIT_MV	メガボルト
UNIT_kV	キロボルト
UNIT_V	ボルト
UNIT_mV	ミリボルト
UNIT_uV	マイクロボルト
UNIT_nV	ナノボルト
UNIT_GA	ギガアンペア
UNIT_MA	メガアンペア
UNIT_kA	キロアンペア
UNIT_A	アンペア
UNIT_mA	ミリアンペア
UNIT_uA	マイクロアンペア
UNIT_nA	ナノアンペア
UNIT_GW	ギガワット
UNIT_MW	メガワット
UNIT_kW	キロワット
UNIT_W	ワット
UNIT_mW	ミリワット
UNIT_uW	マイクロワット
UNIT_nW	ナノワット
UNIT_GWh	ギガワット時
UNIT_MWh	メガワット時
UNIT_kWh	キロワット時
UNIT_Wh	ワット時
UNIT_mWh	ミリワット時
UNIT_uWh	マイクロワット時
UNIT_nWh	ナノワット時
UNIT_GJ	ギガジュール
UNIT_MJ	メガジュール
UNIT_kJ	キロジュール
UNIT_J	ジュール
UNIT_mJ	ミリジュール
UNIT_uJ	マイクロジュール
UNIT_nJ	ナノジュール
UNIT_Gm	ギガメートル
UNIT_Mm	メガメートル
UNIT_km	キロメートル
UNIT_m	メートル
UNIT_mm	ミリメートル
UNIT_um	マイクロメートル
UNIT_nm	ナノメートル
UNIT_rad	ラジアン
UNIT_deg	角度
UNIT_Gm_s	ギガメートル毎秒
UNIT_Mm_s	メガメートル毎秒
UNIT_km_s	キロメートル毎秒
UNIT_m_s	メートル毎秒
UNIT_mm_s	ミリメートル毎秒
UNIT_um_s	マイクロメートル毎秒
UNIT_nm_s	ナノメートル毎秒
UNIT_rad_s	ラジアン毎秒
UNIT_deg_s	角度毎秒
UNIT_Gm_ss	ギガメートル毎秒毎秒
UNIT_Mm_ss	メガメートル毎秒毎秒
UNIT_km_ss	キロメートル毎秒毎秒
UNIT_m_ss	メートル毎秒毎秒
UNIT_mm_ss	ミリメートル毎秒毎秒
UNIT_um_ss	マイクロメートル毎秒毎秒
UNIT_nm_ss	ナノメートル毎秒毎秒
UNIT_rad_ss	ラジアン毎秒毎秒
UNIT_deg_ss	角度毎秒毎秒
UNIT_GK	ギガケルビン
UNIT_MK	メガケルビン
UNIT_kK	キロケルビン
UNIT_K	ケルビン
UNIT_mK	ミリケルビン
UNIT_uK	マイクロケルビン
UNIT_nK	ナノケルビン
UNIT_degC	摂氏度
UNIT_degF	華氏度
UNIT_GT	ギガテスラ
UNIT_MT	メガテスラ
UNIT_kT	キロテスラ
UNIT_T	テスラ
UNIT_mT	ミリテスラ
UNIT_uT	マイクロテスラ
UNIT_nT	ナノテスラ
UNIT_LIMIT	単位定数の最大値

コンストラクタとデストラクタ

ofxInvaderSAT::ofxInvaderSAT ( void )

explicit

コンストラクタです。初期化に必要な最低限の処理をおこないます。

ofxInvaderSAT::~ofxInvaderSAT ( void )

virtual

デストラクタです。管理しているリソースを解放します。

関数

ofxSATError ofxInvaderSAT::setUpdateInterval ( ofxSATTimeDiff const & param )

自動アップデートの間隔を設定します。デフォルト値は５秒です。

引数

[in] param 設定する時間間隔

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正

ofxSATTimeDiff const & ofxInvaderSAT::getUpdateInterval ( void ) const

自動アップデートの間隔を取得します。

戻り値: 現在の時間間隔

ofxSATError ofxInvaderSAT::setRetryInterval ( ofxSATTimeDiff const & param )

エラー発生時の自動リトライの間隔を設定します。デフォルト値は６０秒です。

引数

[in] param 設定する時間間隔

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正

ofxSATTimeDiff const & ofxInvaderSAT::getRetryInterval ( void ) const

エラー発生時の自動リトライの間隔を取得します。

戻り値: 現在の時間間隔

ofxSATError ofxInvaderSAT::getAvailableCount ( int * result ) const

virtual

センサデータを取得可能な時刻の数を取得します。

引数

[out] result 取得結果

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	データの解析に失敗

ofxSATを再定義しています。

ofxSATError ofxInvaderSAT::getAvailableCount	(	ofxSATTime const &	begin,
		ofxSATTime const &	end,
		int *	result
	)		const

virtual

引数に指定した時間範囲の中でセンサデータを取得可能な時刻の数を取得します。時間範囲は [begin, end) で指定します。

引数

[in]	begin	開始時刻（以上）
[in]	end	終了時刻（未満）
[out]	result	取得結果

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	データの解析に失敗

ofxSATを再定義しています。

ofxSATError ofxInvaderSAT::getAvailableTime ( std::vector< ofxSATTime > * result ) const

virtual

センサデータを取得可能な時刻のリストを取得します。

std::vector<ofxSATTime> result;
ofxSATError error;
error = _invader.getAvailableTime(&result);
if (error == SATERROR_OK) {
    for (i = 0; i < result.size(); ++i) {
        cout << "result = " << result[i].format("%YYYY/%MM/%DD %hh:%mm:%ss") << endl;
    }
}
else {
    cout << "error = " << error.print() << endl;
}

引数

[out] result 取得結果

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	データの解析に失敗

ofxSATを再定義しています。

ofxSATError ofxInvaderSAT::getAvailableTime	(	ofxSATTime const &	begin,
		ofxSATTime const &	end,
		std::vector< ofxSATTime > *	result
	)		const

virtual

引数に指定した時間範囲の中でセンサデータを取得可能な時刻のリストを取得します。時間範囲は [begin, end) で指定します。

ofxSATTime begin;
ofxSATTime end;
std::vector<ofxSATTime> result;
ofxSATError error;
// 現在の時刻から１日前までの範囲を計算
end = ofxSATTime::currentTime();
begin = ofxSATTime(end).subDay(1);
error = _invader.getAvailableTime(begin, end, &result);
if (error == SATERROR_OK) {
    for (i = 0; i < result.size(); ++i) {
        cout << "result = " << result[i].format("%YYYY/%MM/%DD %hh:%mm:%ss") << endl;
    }
}
else {
    cout << "error = " << error.print() << endl;
}

引数

[in]	begin	開始時刻（以上）
[in]	end	終了時刻（未満）
[out]	result	取得結果

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	データの解析に失敗

ofxSATを再定義しています。

ofxSATError ofxInvaderSAT::getSensorFormat	(	SensorType	sensor,
		FormatEnum *	result
	)		const

virtual

センサの種類に応じた書式を取得します。

引数

[in]	sensor	ofxInvaderSAT::SensorEnum 型のセンサ定数
[out]	result	取得結果

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正

ofxSATを再定義しています。

ofxSATError ofxInvaderSAT::getSensorUnit	(	SensorType	sensor,
		UnitEnum *	result
	)		const

virtual

センサの種類に応じた単位を取得します。

引数

[in]	sensor	ofxInvaderSAT::SensorEnum 型のセンサ定数
[out]	result	取得結果

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正

ofxSATを再定義しています。

ofxSATError ofxInvaderSAT::getSensorMinimum	(	SensorType	sensor,
		void *	result,
		int	size
	)		const

virtual

センサの種類に応じた最小値を取得します。

引数

[in]	sensor	ofxInvaderSAT::SensorEnum 型のセンサ定数
[out]	result	取得結果
[in]	size	result に指定した変数のバイト数

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATを再定義しています。

ofxSATError ofxInvaderSAT::getSensorMaximum	(	SensorType	sensor,
		void *	result,
		int	size
	)		const

virtual

センサの種類に応じた最大値を取得します。

引数

[in]	sensor	ofxInvaderSAT::SensorEnum 型のセンサ定数
[out]	result	取得結果
[in]	size	result に指定した変数のバイト数

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATを再定義しています。

ofxSATError ofxInvaderSAT::getSensorData	(	SensorType	sensor,
		ofxSATTime const &	time,
		void *	result,
		int	size,
		bool *	simulation = `NULL`
	)		const

virtual

センサの種類に応じた指定された時刻のデータを取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

使い方１：データとシミュレーション結果を取得するとき

ofxSATTime time;
double value;
bool simulation;
ofxSATError error;
time = ofxSATTime::currentTime();
error = _invader.getSensorData(ofxInvaderSAT::SENSOR_POWER_SOLARPX, time, &value, sizeof(value), &simulation);
if (error == SATERROR_OK) {
    cout << "value = " << value << endl;
}
else {
    cout << "error = " << error.print() << endl;
}

使い方２：データのみを取得するとき

ofxSATTime time;
double value;
ofxSATError error;
time = ofxSATTime::currentTime();
error = _invader.getSensorData(ofxInvaderSAT::SENSOR_POWER_SOLARPX, time, &value, sizeof(value), NULL);
if (error == SATERROR_OK) {
    cout << "value = " << value << endl;
}
else {
    cout << "error = " << error.print() << endl;
}

引数

[in]	sensor	ofxInvaderSAT::SensorEnum 型のセンサ定数
[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[in]	size	result に指定した変数のバイト数
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATを再定義しています。

ofxSATError ofxInvaderSAT::getSensorTimeOBC	(	ofxSATTime const &	time,
		int *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「衛星の内部時刻」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorPowerSolarPX	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「+X 面の太陽電池の発電電力量」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorPowerSolarMX	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「-X 面の太陽電池の発電電力量」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorPowerSolarPY	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「+Y 面の太陽電池の発電電力量」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorPowerSolarMY	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「-Y 面の太陽電池の発電電力量」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorPowerSolarPZ	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「+Z 面の太陽電池の発電電力量」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorPowerSolarMZ	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「-Z 面の太陽電池の発電電力量」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorPowerBattery	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「内蔵蓄電池の放電電力量」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorTemperatureSolarPX	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「+X 面の太陽電池の温度」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorTemperatureSolarMX	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「-X 面の太陽電池の温度」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorTemperatureSolarPY	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「+Y 面の太陽電池の温度」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorTemperatureSolarMY	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「-Y 面の太陽電池の温度」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorTemperatureSolarPZ	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「+Z 面の太陽電池の温度」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorTemperatureSolarMZ	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「-Z 面の太陽電池の温度」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorTemperatureBattery	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「内蔵蓄電池の温度」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorGyroX	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「X 軸の角速度」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorGyroY	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「Y 軸の角速度」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorGyroZ	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「Z 軸の角速度」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorMagnetometerX	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「X 軸の磁力」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorMagnetometerY	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「Y 軸の磁力」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::getSensorMagnetometerZ	(	ofxSATTime const &	time,
		double *	result,
		bool *	simulation = `NULL`
	)		const

指定された時刻の「Z 軸の磁力」を取得します。データ自体を取得する必要がないときは result 引数に NULL を、シミュレーションか否かを取得する必要がないときには simulation 引数に NULL を指定することができます。

引数

[in]	time	データを取得する時刻
[out]	result	取得結果 NULL : 結果を返さないその他
[out]	simulation	取得結果はシミュレーション NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正
SATERROR_INVALID_PARAM	パラメータが不正
SATERROR_NETWORK_DOWN	ネットワークが未接続
SATERROR_NETWORK_CODE	HTTP ステータスが不正
SATERROR_INVALID_FORMAT	データのフォーマットが不正
SATERROR_NO_RESULT	データが存在しない
SATERROR_FAILED	内部エラー

ofxSATError ofxInvaderSAT::setup ( void )

virtual

データの取得やさまざまな機能を利用できるように初期化をおこないます。

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正

ofxSATRemoteDBを再定義しています。

void ofxInvaderSAT::cleanup ( void )

virtual

データの取得やさまざまな機能を利用するために確保したリソースを解放します。

戻り値: なし

ofxSATRemoteDBを再定義しています。

ofxSATError ofxInvaderSAT::update ( ofxSATTime const & time = ofxSATTime::currentTime() )

virtual

希望する時刻のデータを更新するように要求します。

引数

[in] time 希望する時刻

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正

ofxSATを再定義しています。

std::string const & ofxSAT::getID ( void ) const

inherited

ID を取得します。

戻り値: 現在の ID

ofxSATError ofxSAT::getTLE	(	TLERec *	tle,
		ofxSATTime *	time = `NULL`
	)		const

inherited

TLE 情報と TLE を取得した時刻を取得します。 tle パラメータは NULL を指定できませんが、time パラメータは NULL を指定してもかまいません。

引数

[out]	tle	TLE 情報
[out]	time	TLE を取得した時刻 NULL : 結果を返さないその他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	TLE 情報が設定されていない
SATERROR_INVALID_PARAM	tle パラメータが不正

ofxSATError ofxSAT::setNotifier ( Notifier * param )

inherited

通知先クラスを設定します。 setup() 関数を呼び出す前に通知先を設定します。引数に NULL を指定すると通知されなくなります。

引数

[in]

param

通知先クラスのインスタンスへのポインタ

NULL : 通知しない
その他

戻り値: エラー情報

戻り値

SATERROR_OK	正常終了
SATERROR_INVALID_STATE	呼び出すタイミングが不正

ofxSAT::Notifier * ofxSAT::getNotifier ( void ) const

inherited

通知先クラスを取得します。

戻り値: 現在の通知先クラスのインスタンスへのポインタ

戻り値

NULL	通知先クラスは設定されていない
その他

bool ofxSAT::isValid ( void ) const

inherited

setup() が正常におこなわれ、データの取得が可能かどうかを検証します。

戻り値: 検証結果

戻り値

true	可能
false	不可能

void ofxSAT::setID ( std::string const & param )

protectedinherited

ID を設定します。

引数

[in] param 設定する ID

戻り値: なし

void ofxSAT::setTLE	(	TLERec const &	tle,
		ofxSATTime const &	time
	)

protectedinherited

TLE 情報と TLE を取得した時刻を設定します。通知先クラスが設定されていて TLE 情報もしくは時刻が更新されたときには、通知先クラスの Notifier::onNotifyTLE() 関数を ofEvent を利用してスレッドセーフに呼び出します。

引数

[in]	tle	TLE 情報
[in]	time	TLE を取得した時刻

戻り値: なし

void ofxSAT::notifyData ( ofxSATTime const & time ) const

protectedinherited

通知先クラスが設定されているときには、通知先クラスの Notifier::onNotifyData() 関数を ofEvent を利用してスレッドセーフに呼び出します。

引数

[in] time 新しいデータの時刻

戻り値: なし

void ofxSAT::notifyFinish ( ofxSATError const & error ) const

protectedinherited

通知先クラスが設定されているときには、通知先クラスの Notifier::onNotifyFinish() 関数を ofEvent を利用してスレッドセーフに呼び出します。

引数

[in] error エラー情報

戻り値: なし

std::string ofxSAT::trimSpace ( std::string const & param )

staticprotectedinherited

引数に指定した文字列から半角スペースをすべて削除します。

覚え書き: この関数は ofxSAT クラスを継承した具象クラスを作成するときに利用できるユーティリティー関数です。

引数

[in] param 文字列

戻り値: 新しい文字列

std::string ofxSAT::trimNonNumeric ( std::string const & param )

staticprotectedinherited

引数に指定した文字列から半角数字と '+', '-', '.' 以外の文字をすべて削除します。

覚え書き: この関数は ofxSAT クラスを継承した具象クラスを作成するときに利用できるユーティリティー関数です。

引数

[in] param 文字列

戻り値: 新しい文字列

std::string ofxSAT::replaceString	(	std::string const &	string,
		std::string const &	from,
		std::string const &	to
	)

staticprotectedinherited

引数に指定した文字列の中の特定の文字列を新しい文字列にすべて置換します。

覚え書き: この関数は ofxSAT クラスを継承した具象クラスを作成するときに利用できるユーティリティー関数です。

引数

[in]	string	処理対象の文字列
[in]	from	置換される文字列
[in]	to	置換する文字列

戻り値: 新しい文字列

ofxSATError ofxSAT::checkSize	(	FormatEnum	format,
		int	size
	)

staticprotectedinherited

format 引数に指定した書式のデータを表現するのに必要なバイト数よりも size 引数に指定した値が大きいかどうかを検証します。

覚え書き: この関数は ofxSAT クラスを継承した具象クラスを作成するときに利用できるユーティリティー関数です。

引数

[in]	format	書式
[in]	size	バイト数

戻り値: エラー情報

戻り値

SATERROR_OK	size >= 必要なバイト数
SATERROR_FAILED	書式が不正
SATERROR_INVALID_PARAM	size < 必要なバイト数

Public 型

Public メソッド

Protected メソッド

Static Protected メソッド

説明

型定義

列挙型

コンストラクタとデストラクタ

関数