CigiSOFV2 Class Reference

#include <CigiSOFV2.h>

Inheritance diagram for CigiSOFV2:

List of all members.

Public Member Functions
	CigiSOFV2 ()
virtual	~CigiSOFV2 ()
virtual int	Pack (CigiBasePacket *Base, Cigi_uint8 *Buff, void *Spec) const
virtual int	Unpack (Cigi_uint8 *Buff, bool Swap, void *Spec)
Cigi_uint32	GetFrameCntr (void) const
int	SetFrameCntr (const Cigi_uint32 FrameCntrIn, bool bndchk=true)
float	GetTimeStamp (void) const
int	SetTimeStamp (const float TimeStamp, bool bndchk=true)

---

Detailed Description

The class for the Start Of Frame packet for CIGI version 2

Definition at line 66 of file CigiSOFV2.h.

---

Constructor & Destructor Documentation

CigiSOFV2::CigiSOFV2

(

)

Definition at line 84 of file CigiSOFV2.cpp.

References CigiBaseSOF::BSwapEn, CigiBaseSOF::ByteSwap, CIGI_SOF_PACKET_ID_V2, CIGI_SOF_PACKET_SIZE_V2, CigiBaseSOF::DatabaseID, CigiBaseSOF::EarthRefModel, CigiBaseSOF::FrameCntr, CigiBaseSOF::IGMode, CigiBaseSOF::LastRcvdHostFrame, CigiBasePacket::MinorVersion, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, CigiBaseSOF::Standby, CigiBaseSOF::TimeStampV2, CigiBaseSOF::TimeStampV3, CigiBaseSOF::TimestampValid, CigiBasePacket::Version, and CigiBaseSOF::WGS84.

{

   PacketID = CIGI_SOF_PACKET_ID_V2;
   PacketSize = CIGI_SOF_PACKET_SIZE_V2;
   Version = 2;
   MinorVersion = 0;

   BSwapEn = false;
   DatabaseID = 0;
   FrameCntr = 0;
   TimeStampV2 = 0.0f;
   TimeStampV3 = 0;
   ByteSwap = 0x8000;
   IGMode = Standby;
   TimestampValid = false;
   EarthRefModel = WGS84;
   LastRcvdHostFrame = 0;

}

CigiSOFV2::~CigiSOFV2

(

)

[virtual]

Definition at line 108 of file CigiSOFV2.cpp.

{

}

---

Member Function Documentation

Cigi_uint32 CigiSOFV2::GetFrameCntr

(

void

)

const [inline]

Gets the Frame Counter value

Returns:

Current frame this data represents

Reimplemented from CigiBaseSOF.

Definition at line 111 of file CigiSOFV2.h.

{ return(FrameCntr); }

float CigiSOFV2::GetTimeStamp

(

void

)

const [inline]

Gets the V2 timestamp.

Returns:

The timestamp in microseconds.

Definition at line 136 of file CigiSOFV2.h.

{ return(TimeStampV2); }

int CigiSOFV2::Pack	(	CigiBasePacket *	Base,
		Cigi_uint8 *	Buff,
		void *	Spec
	)			const [virtual]

The virtual Pack function for CIGI 1

Parameters:

	Base	- A pointer to the instance of the packet to be packed. (Downcast to CigiBasePacket)
	Buff	- A pointer to the current pack point.
	Spec	- A pointer to special data - This is not used in this class.

Returns:

This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBaseSOF.

Definition at line 123 of file CigiSOFV2.cpp.

References PackPointerUnion::b, PackPointerUnion::c, CIGI_SCOPY4, CigiBaseSOF::DatabaseID, PackPointerUnion::f, CigiBaseSOF::FrameCntr, CigiBaseSOF::IGMode, CigiBaseSOF::IGStatus, PackPointerUnion::l, CigiBasePacket::PacketID, CigiBasePacket::PacketSize, CigiBaseSOF::TimeStampV2, and CigiBasePacket::Version.

{
   PackPointer CDta;

   CigiBaseSOF *Data = ( CigiBaseSOF *) Base;


   CDta.c = Buff;

   *CDta.c++ = PacketID;
   *CDta.c++ = PacketSize;
   *CDta.c++ = Version;

   *CDta.b++ = Data->DatabaseID;
   *CDta.c++ = Data->IGStatus;

   Cigi_uint8 HDta = (Cigi_uint8)((Data->IGMode << 6) & 0xc0);

   *CDta.c++ = HDta;
   *CDta.c++ = 0;
   *CDta.c++ = 0;

   CIGI_SCOPY4(CDta.l++, &Data->FrameCntr);
   CIGI_SCOPY4(CDta.f++, &Data->TimeStampV2);


   return(PacketSize);

}

int CigiSOFV2::SetFrameCntr	(	const Cigi_uint32	FrameCntrIn,
		bool	bndchk = true
	)			[inline]

Sets the Frame Counter with bound checking control

Parameters:

	FrameCntrIn	- Specifies the frame.
	bndchk	- Enables (true) or disables (false) bounds checking

Returns:

This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Reimplemented from CigiBaseSOF.

Definition at line 121 of file CigiSOFV2.h.

References CIGI_SUCCESS.

   {
      FrameCntr = FrameCntrIn;
      LastRcvdHostFrame = FrameCntrIn;

      return(CIGI_SUCCESS);
   }

int CigiSOFV2::SetTimeStamp	(	const float	TimeStamp,
		bool	bndchk = true
	)

Sets the timestamp V2 value with bound checking control.

Parameters:

	TimeStamp	- Specifies the timestamp in microseconds.
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:

This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 200 of file CigiSOFV2.cpp.

References CIGI_SUCCESS, CigiBaseSOF::TimeStampV2, CigiBaseSOF::TimeStampV3, and CigiBaseSOF::TimestampValid.

{

   TimeStampV2 = TimeStamp;
   TimeStampV3 = ((Cigi_uint32)TimeStampV2) / 10;

   TimestampValid = true;

   return(CIGI_SUCCESS);

}

int CigiSOFV2::Unpack	(	Cigi_uint8 *	Buff,
		bool	Swap,
		void *	Spec
	)			[virtual]

The virtual Unpack function for CIGI 1

Parameters:

	Buff	- A pointer to the current pack point.
	Swap	- Byte swapping required.
	Spec	- A pointer to special data - This is not used in this class.

Returns:

This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBaseSOF.

Definition at line 157 of file CigiSOFV2.cpp.

References PackPointerUnion::b, PackPointerUnion::c, CIGI_SCOPY4, CIGI_SUCCESS, CigiBaseSOF::DatabaseID, PackPointerUnion::f, CigiBaseSOF::FrameCntr, CigiBaseSOF::IGMode, CigiBaseSOF::IGStatus, PackPointerUnion::l, CigiBaseSOF::LastRcvdHostFrame, PackPointerUnion::s, CigiBaseSOF::TimeStampV2, and CigiBaseSOF::TimeStampV3.

{

   PackPointer CDta;

   CDta.c = Buff;

   CDta.c += 3;

   DatabaseID = *CDta.b++;
   IGStatus = *CDta.c++;

   Cigi_uint8 HDta = *CDta.c++;

   IGMode = (IGModeGrp)((HDta >> 6) & 0x03);

   CDta.s++;

   CIGI_SCOPY4(&FrameCntr,CDta.l++);
   CIGI_SCOPY4(&TimeStampV2,CDta.f++);

   TimeStampV3 = ((Cigi_uint32)TimeStampV2) / 10;

   LastRcvdHostFrame = FrameCntr;

   Swap = false;

   return(CIGI_SUCCESS);

}

---

The documentation for this class was generated from the following files:

• ccl/include/CigiSOFV2.h
• ccl/source/CigiSOFV2.cpp

---