IKlv2CoTConv Class Reference

IKlv2CoTConv interface More...

List of all members.

Public Types
enum	KLV_MODE { LDS, UDS }
	KLV_MODE defines an operational mode. More...
enum	COT_MODE { PLATFORM_POSITION = 1, SPI = 2, PLATFORM_POSITION_AND_SPI = 3 }
	COT_MODE defines an operational mode More...
enum	BattleDimension {   BD_Space, BD_Air, BD_Ground, BD_Sea_Surface,   BD_Sea_Subsurface, BD_Other }
	BattleDimension enum More...
enum	Affiliation {   AF_Pending, AF_Unknown, AF_Assumed_friend, AF_Friend,   AF_Neutral, AF_Suspect, AF_Hostile, AF_Joker,   AF_Faker, AF_None_specified, AF_Other }
	Affiliation enum More...
Public Member Functions
virtual bool	Process (char *klv_buf, size_t len, string &xmlStrPP, string &xmlStrSPI)=0
	Process. Processes the Klv data buffer.
virtual bool	Process (list< IKlvItem * > *klvList, string &xmlStrPP, string &xmlStrSPI)=0
	Process. Processes the Klv items list.
virtual void	SetBattleDimensionInfo (const BattleDimension bd)=0
	SetBattleDimension. Sets BattleDimension.
virtual void	SetAffiliationInfo (const Affiliation af)=0
	SetAffiliationInfo. Sets Affiliation.
virtual void	SetFunctionTypeInfo (const char *finfo)=0
	SetFunctionTypeInfo. Sets FunctionInfo.
virtual void	SetCoTMode (const COT_MODE cot_mode)=0
	SetCoTMode. Sets COT operational mode
virtual const COT_MODE	GetCoTMode ()=0
	GetCoTMode. Gets COT operational mode

---

Detailed Description

IKlv2CoTConv interface definition

• LDS Local Data Set (1 byte key)
• UDS Universal Data Set (16 byte key)

Examples:

Klv2CoTListTest.cpp, and Klv2CoTTest.cpp.

---

Member Enumeration Documentation

enum IKlv2CoTConv::Affiliation

CoT affiliation of atoms The "Atoms" portion of the "type" tree contains fields taken from MIL-STD-2525.

Enumerator:

AF_Pending	p - Pending
AF_Unknown	u - Unknown
AF_Assumed_friend	a - Assumed friend
AF_Friend	f - Friend
AF_Neutral	n - Neutral
AF_Suspect	s - Suspect
AF_Hostile	h - Hostile
AF_Joker	j - Joker
AF_Faker	k - Faker
AF_None_specified	o - None specified
AF_Other	x - Other

enum IKlv2CoTConv::BattleDimension

BattleDimension enumeration The "Atoms" portion of the "type" tree contains the "Battle Dimension" fields taken from MIL-STD-2525. "Battle Dimension" is a single character taken from MIL-STD-2525.

Enumerator:

BD_Space	P - Space.
BD_Air	A - Air.
BD_Ground	G - Ground.
BD_Sea_Surface	S - Sea Surface.
BD_Sea_Subsurface	U - Sea Subsurface.
BD_Other	X - Other.

enum IKlv2CoTConv::COT_MODE

COT_MODE specifies the Situational Awareness COT message type generated by the Converter Generally, the Converter may either produce one type of the messages or both, depending on the mode set.

Enumerator:

PLATFORM_POSITION	Situational Awareness Platform Position message.
SPI	Situational Awareness Sensor Point of Interest message.
PLATFORM_POSITION_AND_SPI	Both Situational Awareness Platform Position and Sensor Point of Interest messages.

enum IKlv2CoTConv::KLV_MODE

KLV_MODE defines the incoming Klv format.

Enumerator:

LDS	Local Data Set (1 byte key)
UDS	Universal Data Set (16 byte key)

---

Member Function Documentation

virtual const COT_MODE IKlv2CoTConv::GetCoTMode

(

)

[pure virtual]

Converter may either produce one type of the messages or both, depending on the mode set.

Returns:

COT_MODE.

virtual bool IKlv2CoTConv::Process	(	list< IKlvItem * > *	klvList,
		string &	xmlStrPP,
		string &	xmlStrSPI
	)		[pure virtual]

Process method receives a pointer to the KLV items list, processes it and fills the supplied buffer with the CoT message.

Parameters:

klvList	a list<IKlvItem>. Pointer to the list of IKlvItems [in].
xmlStrPP	a string. Platform Position message string [out].
xmlStrSPI	a string. Sensor Point of Interest message string [out].

Returns:

bool.

virtual bool IKlv2CoTConv::Process	(	char *	klv_buf,
		size_t	len,
		string &	xmlStrPP,
		string &	xmlStrSPI
	)		[pure virtual]

Process method receives a pointer to the data buffer containing Klv metadata, processes it and fills the supplied buffer with the CoT message.

Parameters:

klv_buf	a const char*. Pointer to KLV buffer [in].
len	a size_t. Defines klv_buf length [in].
xmlStrPP	a string. Platform Position message string [out].
xmlStrSPI	a string. Sensor Point of Interest message string [out].

Returns:

bool.

Examples:

Klv2CoTListTest.cpp, and Klv2CoTTest.cpp.

virtual void IKlv2CoTConv::SetAffiliationInfo

(

const Affiliation

af

)

[pure virtual]

Sets CoT affiliation of the atoms

Parameters:

af	the Affiliation. Defines Affiliation field.

Returns:

void.

Note:

Affiliation may be changed on the fly. After it is changed, the next Process method will generate corresponding metadata.

Examples:

Klv2CoTListTest.cpp.

virtual void IKlv2CoTConv::SetBattleDimensionInfo

(

const BattleDimension

bd

)

[pure virtual]

Sets CoT BattleDimension of the atoms

Parameters:

bd	the BattleDimension. Defines BattleDimension field.

Returns:

void.

Note:

BattleDimension may be changed on the fly. After it is changed, the next Process method will generate corresponding metadata.

Examples:

Klv2CoTListTest.cpp.

virtual void IKlv2CoTConv::SetCoTMode

(

const COT_MODE

cot_mode

)

[pure virtual]

Converter may either produce one type of the messages or both, depending on the mode set.

Parameters:

cot_mode

a COT_MODE. Defines COT operational mode.

Returns:

void.

Note:

COT_MODE operational mode may be changed on the fly. After mode is changed, the next Process method will generate corresponding metadata.

Examples:

Klv2CoTListTest.cpp.

virtual void IKlv2CoTConv::SetFunctionTypeInfo

(

const char *

finfo

)

[pure virtual]

Sets dimension specific Function (taken from MIL-STD-2525 function fields (upper case))

Parameters:

finfo

a const char*. Defines Function field.

Returns:

void.

Note:

FunctionTypeInfo may be changed on the fly. After it is changed, the next Process method will generate corresponding metadata.

Examples:

Klv2CoTListTest.cpp.