1 / 5

TwePacket, spTwePacket

パケットオブジェクト

パケットデータは種別によってデータ構造が違いますが、様々な種類のパケットを一元管理するための基底クラスです。

class TwePacket;
typedef std::shared_ptr<TwePacket> spTwePacket;

spTwePacket はメモリ管理のためのスマートポインタです。std::shared_ptrを用いています。

TwePacketクラスは、パケットデータのパケット種別の管理を行います。また、パケットデータの解釈を行うための仮想関数parse()メソッドを定義しています。パケット特有のデータ構造に基づく解釈やデータの保存等の取り扱いは、派生クラスに実装します。

メソッド

TwePacket() - コンストラクタ

TwePacket(E_PKT ptyp = E_PKT::PKT_ERROR)

デフォルトでは、未解釈状態として E_PKT::PKT_ERROR で初期化します。

~TwePacket() - デストラクタ

virtual ~TwePacket()

get_type()

E_PKT get_type()

パケットの種別をE_PKT型で返します。

parse()

virtual E_PKT parse(uint8_t* p, uint8_t u8len)

パケットデータのバイト列を与えて、パケットデータを解釈する。

派生クラスで、そのパケットに対応するデータ構造を解釈するための実装を行います。

戻り値は E_PKT型で、成功時は解釈されたパケット種別を、エラー時に E_PKT::PKT_ERROR を返します。

E_PKT

パケット種別定義

以下のパケットに対応します。

App_Wings の親機で出力されるアスキー書式に対応します。

idenify_packet_type()

パケット種別判定

パケットデータのバイト列を入力として、パケットの種別を判定します。また既に生成済みのspTwePacketオブジェクトの種別を返します。戻り値はE_PKTです。

E_PKT identify_packet_type(uint8_t* p, uint8_t u8len)
E_PKT identify_packet_type(SmplBuf_Byte& sbuff)

E_PKT identify_packet_type(spTwePacket& sp)

newTwePacket()

パケットデータの解釈とオブジェクト生成

パケットデータのバイト列を入力として、パケット種別の判定と、種別に応じたspTwePacketオブジェクトを生成します。

spTwePacket newTwePacket(
		uint8_t* p,
		uint8_t u8len,
		E_PKT eType = E_PKT::PKT_ERROR)

spTwePacket newTwePacket(
		TWEUTILS::SmplBuf_Byte& sbuff,
		E_PKT eType = E_PKT::PKT_ERROR)

事前にidentify_packet_type()を用いてパケットの種別E_PKTが特定できている場合はeTypeを与えます。

戻り値はspTwePacketです。

refTwePacket()

spTwePacketオブジェクトの参照

本関数はspTwePacketオブジェクトをTwePacket&として参照します。

TwePacket& refTwePacket(spTwePacket& p)

//例
  auto&& pkt = newTwePacket(p, len); // パケットの生成
  
  if (refTwePacket(pkt).get_type() == E_PKT::PKT_TWELITE) {
    // App_Twelite の処理
  }

この関数は、->演算子や*演算子を極力使用しない方針でライブラリを設定しているため、スマートポインタの参照を行うために用意しています。

上記の判定式を(pkt && pkt->get_type() == E_PKT::PKT_TWELITE)と記述しても同じ判定が得られます。

TwePacket, spTwePacket

パケットオブジェクト

パケットデータは種別によってデータ構造が違いますが、様々な種類のパケットを一元管理するための基底クラスです。

class TwePacket;
typedef std::shared_ptr<TwePacket> spTwePacket;

spTwePacket はメモリ管理のためのスマートポインタです。std::shared_ptrを用いています。

メソッド

TwePacket() - コンストラクタ

TwePacket(E_PKT ptyp = E_PKT::PKT_ERROR)

デフォルトでは、未解釈状態として E_PKT::PKT_ERROR で初期化します。

~TwePacket() - デストラクタ

virtual ~TwePacket()

get_type()

E_PKT get_type()

パケットの種別をE_PKT型で返します。

parse()

virtual E_PKT parse(uint8_t* p, uint8_t u8len)

パケットデータのバイト列を与えて、パケットデータを解釈する。

派生クラスで、そのパケットに対応するデータ構造を解釈するための実装を行います。

戻り値は E_PKT型で、成功時は解釈されたパケット種別を、エラー時に E_PKT::PKT_ERROR を返します。