STD0903ConvWr::ISTD0903ConverterWr Interface Reference

ISTD0903ConverterWr interface. More...

Public Member Functions
bool	Activate (String^ appName, String^ licPath, String^ Key)
	Activate STD0903Converter license. More...
void	ConfigureEncoder (const char vmtiTag, bool fAddChecksum)
	ConfigureEncoder method sets VMTI encoder properties. More...
array< byte >	EncodeVmtiPacket (VMTI_PacketWr^ packet)
	Encode method encodes the VMTI packet. More...
array< byte >	EncodeVmtiPacketPayload (VMTI_PacketWr^ packet)
	Encode method encodes the VMTI packet(payload only) More...
VMTI_PacketWr	DecodeVmtiPacket (array< byte >^ buffer)
	DecodeVmtiPacket method decodes the supplied buffer and fills the Video Moving Target Indicator and Track Metadatastructure as defined in the MISB 00903 spec. More...
VMTI_PacketWr	DecodeVmtiPacketPayload (array< byte >^ buffer)
	DecodeVmtiPacketPayload method decodes the supplied buffer and fills the Video Moving Target Indicator and Track Metadatastructure as defined in the MISB 00903 spec. More...
String	TargetLocalDataTagToString (VTargetLocalDataTagWr tag)
	TargetLocalDataTagToString method returns a text representation of the Local Data tag. More...
String	TargetPackTagToString (VTargetPackTagWr tag)
	TargetPackTag method returns a text representation of the TargetPack tag. More...
String	TrackerLocalDataTagToString (VTrackerLDSTagWr tag)
	TrackerLocalDataTagToString method returns a text representation of the Local Data tag. More...
String	TargetLocalDataToHRString (VTargetLocalDataTagWr tag, Object^ vt)
	TargetLocalDataToHRString method returns a human readable text representation of the LocalData value. More...
String	TargetPackValueToHRString (VTargetPackTagWr tag, Object^ vt)
	TargetPackValueToHRString method returns a human readable text representation of the Target Pack value. More...
String	TrackerLocalDataToHRString (VTrackerLDSTagWr tag, Object^ vt)
	TrackerLocalDataToHRString method returns a human readable text representation of the Tracker LocalData value. More...
String	VmtiPacketToJson (VMTI_PacketWr^ pckt, bool useTags)
	VmtiPacketToJson method returns a json formated representation of the VMTI_PacketWr. More...

Detailed Description

ISTD0903ConverterWr interface represents the abstract base class from which STD0903ConverterWr class can inherit. ISTD0903ConverterWr defines a VMTI encoder / decoder interface. The derived STD0903ConverterWr implements encoding and decoding methods that operate on the VMTI_PacketWr objects

Member Function Documentation

Activate()

bool STD0903ConvWr::ISTD0903ConverterWr::Activate	(	String^	appName,
		String^	licPath,
		String^	Key
	)

Activates STD0903Converter features according to the license

Parameters

appName	a String^. Application name.
licPath	a String^. License file path.
Key	a String^. License Key.

Returns

bool.

ConfigureEncoder()

void STD0903ConvWr::ISTD0903ConverterWr::ConfigureEncoder	(	const char	vmtiTag,
		bool	fAddChecksum
	)

ConfigureEncoder method sets VMTI encoder properties - 'outer tag' and an optional checksum that can be calculated and added.

Parameters

vmtiTag	a const char. 'Outer' VMTI Tag to assign (Tag 74 for MISB0601.X)
fAddChecksum	a bool. Calculate and add a checksum.

Returns

void

DecodeVmtiPacket()

VMTI_PacketWr STD0903ConvWr::ISTD0903ConverterWr::DecodeVmtiPacket

(

array< byte >^

buffer

)

DecodeVmtiPacket method decodes the supplied buffer and fills the Video Moving Target Indicator and Track Metadatastructure as defined in the MISB 00903 spec. The buffer must be a complete Klv triplet - including Key, Length and value. If you need to decode a Klv payload only, please use DecodeVmtiPacketPayload instead.

Parameters

buffer

a array<byte>^. Data buffer

Returns

VMTI_PacketWr^.

DecodeVmtiPacketPayload()

VMTI_PacketWr STD0903ConvWr::ISTD0903ConverterWr::DecodeVmtiPacketPayload

(

array< byte >^

buffer

)

Decode method decodes the supplied buffer and fills the Video Moving Target Indicator and Track Metadatastructure as defined in the MISB 00903 spec. The buffer must contain a Klv triplet's payload only (value). If you need to decode a complete Klv triplet, including Key, Length and value, please use DecodeVmtiPacket method instead.

Parameters

buffer

a array<byte>^. Data buffer

Returns

VMTI_PacketWr^.

EncodeVmtiPacket()

array<byte> STD0903ConvWr::ISTD0903ConverterWr::EncodeVmtiPacket

(

VMTI_PacketWr^

packet

)

Encode method encodes the VMTI packet and returns a byte array with encoded data. An optional checksum can be calculated and added (tag 0x01).

Parameters

pPacket

a VMTI_PacketWr^. VMTI packet to encode

Returns

array<byte>^ . Encoded buffer

EncodeVmtiPacketPayload()

array<byte> STD0903ConvWr::ISTD0903ConverterWr::EncodeVmtiPacketPayload

(

VMTI_PacketWr^

packet

)

Encode method encodes the VMTI packet and returns a byte array with encoded data.

Parameters

pPacket

a VMTI_PacketWr^. VMTI packet to encode

Returns

array<byte>^ . Encoded buffer

TargetLocalDataTagToString()

String STD0903ConvWr::ISTD0903ConverterWr::TargetLocalDataTagToString

(

VTargetLocalDataTagWr

tag

)

TargetLocalDataTagToString method returns a text representation of the Local Data tag.

Parameters

tag	a VTargetLocalDataTagWr. LocalData Tag

Returns

String^.

TargetLocalDataToHRString()

String STD0903ConvWr::ISTD0903ConverterWr::TargetLocalDataToHRString	(	VTargetLocalDataTagWr	tag,
		Object^	vt
	)

TargetLocalDataToHRString method returns a human readable text representation of the LocalData value.

Parameters

tag	a VTargetLocalDataTag. VTargetLocalDataTag Tag
vt	a Object^. Value to translate

Returns

String^.

TargetPackTagToString()

String STD0903ConvWr::ISTD0903ConverterWr::TargetPackTagToString

(

VTargetPackTagWr

tag

)

TargetPackTag method returns a text representation of the TargetPack tag.

Parameters

tag	a VTargetPackTagWr. VTargetPackTagWr Tag

Returns

String^.

TargetPackValueToHRString()

String STD0903ConvWr::ISTD0903ConverterWr::TargetPackValueToHRString	(	VTargetPackTagWr	tag,
		Object^	vt
	)

TargetPackValueToHRString method returns a human readable text representation of the Target Pack value.

Parameters

tag	a VTargetPackTag. VTargetPackTag Tag
vt	a Object^. Value to translate

Returns

String^.

TrackerLocalDataTagToString()

String STD0903ConvWr::ISTD0903ConverterWr::TrackerLocalDataTagToString

(

VTrackerLDSTagWr

tag

)

TrackerLocalDataTagToString method returns a text representation of the Local Data tag.

Parameters

tag	a VTrackerLDSTagWr. VTrackerLDSTagWr Tag

Returns

String^.

TrackerLocalDataToHRString()

String STD0903ConvWr::ISTD0903ConverterWr::TrackerLocalDataToHRString	(	VTrackerLDSTagWr	tag,
		Object^	vt
	)

TrackerLocalDataToHRString method returns a human readable text representation of the Tracker LocalData value.

Parameters

tag	a VTrackerLDSTagWr. VTrackerLDSTagWr Tag
vt	a Object^. Value to translate

Returns

String^.

VmtiPacketToJson()

String STD0903ConvWr::ISTD0903ConverterWr::VmtiPacketToJson	(	VMTI_PacketWr^	pckt,
		bool	useTags
	)

VmtiPacketToJson method returns a JSON formated representation of the VMTI_PacketWr.

Parameters

pckt	a VMTI_PacketWr^. VMTI_PacketWr packet
useTags	a bool. If useTags set to true, a shoter form (where tags used instead of names) will be used

Returns

String^.