CTCP 関連基本関数の宣言 [詳解]

#include <stdint.h>
#include <src_user/Settings/TlmCmd/common_tlm_cmd_packet_define.h>
#include "./common_tlm_packet.h"
#include "./common_cmd_packet.h"
#include <src_user/Settings/TlmCmd/Ccsds/apid_define.h>

common_tlm_cmd_packet.h の依存先関係図:

被依存関係図:

[ソースコード]

列挙型
enum	CTCP_PACKET_TYPE { CTCP_PACKET_TYPE_CMD , CTCP_PACKET_TYPE_TLM , CTCP_PACKET_TYPE_UNKNOWN }
	tlm (CTP) or cmd (CCP) を規定 [詳解]

関数
int	CTCP_is_valid_packet (const CommonTlmCmdPacket *packet)
	有効なパケットかチェックする [詳解]

CTCP_PACKET_TYPE	CTCP_get_packet_type (const CommonTlmCmdPacket *packet)
	tlm か cmd かを判断 [詳解]

uint16_t	CTCP_get_packet_len (const CommonTlmCmdPacket *packet)
	パケット長を取得 [詳解]

APID	CTCP_get_apid (const CommonTlmCmdPacket *packet)
	APID を取得 [詳解]

void	CTCP_set_apid (CommonTlmCmdPacket *packet, APID apid)
	APID を設定 [詳解]

void	CTCP_copy_packet (CommonTlmCmdPacket dest, const CommonTlmCmdPacket src)
	CommonTlmCmdPacket をコピー [詳解]

const CommonTlmPacket *	CTCP_convert_to_ctp (const CommonTlmCmdPacket *ctcp)
	CTCP を CTP に変換（キャスト） [詳解]

const CommonTlmCmdPacket *	CTCP_convert_from_ctp (const CommonTlmPacket *ctp)
	CTP を CTCP に変換（キャスト） [詳解]

const CommonCmdPacket *	CTCP_convert_to_ccp (const CommonTlmCmdPacket *ctcp)
	CTCP を CCP に変換（キャスト） [詳解]

const CommonTlmCmdPacket *	CTCP_convert_from_ccp (const CommonCmdPacket *ccp)
	CCP を CTCP に変換（キャスト） [詳解]

詳解

CTCP 関連基本関数の宣言

覚え書き: CTCP: CommonTlmCmdPacket; CTP: CommonTlmPacket; CCP: CommonCmdPacket

common_tlm_cmd_packet.h に定義があります。

列挙型詳解

◆ CTCP_PACKET_TYPE

enum CTCP_PACKET_TYPE

tlm (CTP) or cmd (CCP) を規定

覚え書き: uint8_tを想定

列挙値
CTCP_PACKET_TYPE_CMD
CTCP_PACKET_TYPE_TLM
CTCP_PACKET_TYPE_UNKNOWN

common_tlm_cmd_packet.h の 44 行目に定義があります。

関数詳解

◆ CTCP_convert_from_ccp()

const CommonTlmCmdPacket* CTCP_convert_from_ccp ( const CommonCmdPacket * ccp )

CCP を CTCP に変換（キャスト）

覚え書き: NULL が返る可能性があるので，呼び出し元でしっかりアサーションすること！

引数

[in] ctcp CCP

戻り値

CTCP	変換成功時
NULL	エラー時

common_tlm_cmd_packet.c の 75 行目に定義があります。

被呼び出し関係図:

◆ CTCP_convert_from_ctp()

const CommonTlmCmdPacket* CTCP_convert_from_ctp ( const CommonTlmPacket * ctp )

CTP を CTCP に変換（キャスト）

覚え書き: NULL が返る可能性があるので，呼び出し元でしっかりアサーションすること！

引数

[in] ctcp CTP

戻り値

CTCP	変換成功時
NULL	エラー時

common_tlm_cmd_packet.c の 64 行目に定義があります。

被呼び出し関係図:

◆ CTCP_convert_to_ccp()

const CommonCmdPacket* CTCP_convert_to_ccp ( const CommonTlmCmdPacket * ctcp )

CTCP を CCP に変換（キャスト）

覚え書き: NULL が返る可能性があるので，呼び出し元でしっかりアサーションすること！

引数

[in] ctcp CTCP

戻り値

CCP	変換成功時
NULL	エラー時

common_tlm_cmd_packet.c の 69 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CTCP_convert_to_ctp()

const CommonTlmPacket* CTCP_convert_to_ctp ( const CommonTlmCmdPacket * ctcp )

CTCP を CTP に変換（キャスト）

覚え書き: NULL が返る可能性があるので，呼び出し元でしっかりアサーションすること！

引数

[in] ctcp CTCP

戻り値

CTP	変換成功時
NULL	エラー時

common_tlm_cmd_packet.c の 58 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CTCP_copy_packet()

void CTCP_copy_packet	(	CommonTlmCmdPacket *	dest,
		const CommonTlmCmdPacket *	src
	)

CommonTlmCmdPacket をコピー

覚え書き: user 実装次第だが，高速化のためすすべてではなく必要最低限しかコピーしない場合もある

引数

[in,out]	dest	コピー先 CTCP
[in]	src	コピー元 CTCP

戻り値: void

common_tlm_cmd_packet.c の 52 行目に定義があります。

呼び出し関係図:

◆ CTCP_get_apid()

APID CTCP_get_apid ( const CommonTlmCmdPacket * packet )

APID を取得

引数

packet CTCP

戻り値: APID

common_tlm_cmd_packet.c の 42 行目に定義があります。

呼び出し関係図:

◆ CTCP_get_packet_len()

uint16_t CTCP_get_packet_len ( const CommonTlmCmdPacket * packet )

パケット長を取得

引数

packet CTCP

戻り値: packet len

common_tlm_cmd_packet.c の 37 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CTCP_get_packet_type()

CTCP_PACKET_TYPE CTCP_get_packet_type ( const CommonTlmCmdPacket * packet )

tlm か cmd かを判断

引数

packet CTCP

戻り値: CTCP_PACKET_TYPE

common_tlm_cmd_packet.c の 22 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CTCP_is_valid_packet()

int CTCP_is_valid_packet ( const CommonTlmCmdPacket * packet )

有効なパケットかチェックする

覚え書き: NULL チェックも行う; OBC の外から来たパケットな可能性もあるので，このC2Aで扱えるサイズかもチェックする

引数

packet CTCP

戻り値

1	True
0	False

common_tlm_cmd_packet.c の 14 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CTCP_set_apid()

void CTCP_set_apid	(	CommonTlmCmdPacket *	packet,
		APID	apid
	)

APID を設定

引数

[in,out]	packet	CTCP
[in]	apid	APID

戻り値: void

common_tlm_cmd_packet.c の 47 行目に定義があります。

呼び出し関係図: