#include <CigiBaseIGMsg.h>
Inheritance diagram for CigiBaseIGMsg:
Public Member Functions | |
| CigiBaseIGMsg () | |
| virtual | ~CigiBaseIGMsg () |
| virtual int | Pack (CigiBasePacket *Base, Cigi_uint8 *Buff, void *Spec) const =0 |
| virtual int | Unpack (Cigi_uint8 *Buff, bool Swap, void *Spec)=0 |
| virtual int | GetCnvt (CigiVersionID &CnvtVersion, CigiCnvtInfoType::Type &CnvtInfo) |
| virtual int | GetTruePacketSize (CigiBaseVariableSizePckt &refPacket)=0 |
| int | SetMsgID (const Cigi_uint16 MsgIDIn, bool bndchk=true) |
| Cigi_uint16 | GetMsgID (void) const |
| Cigi_int8 * | GetMsg (void) |
| int | GetMsgLen (void) const |
Protected Attributes | |
| Cigi_uint16 | MsgID |
| Cigi_int8 | Msg [100] |
| int | MsgLen |
Friends | |
| class | CigiIGMsgV2 |
| class | CigiIGMsgV3 |
Definition at line 74 of file CigiBaseIGMsg.h.
| CigiBaseIGMsg::CigiBaseIGMsg | ( | ) | [inline] |
| virtual CigiBaseIGMsg::~CigiBaseIGMsg | ( | ) | [inline, virtual] |
| virtual int CigiBaseIGMsg::GetCnvt | ( | CigiVersionID & | CnvtVersion, | |
| CigiCnvtInfoType::Type & | CnvtInfo | |||
| ) | [inline, virtual] |
A virtual Conversion Information function. This function provides conversion information for this packet.
| CnvtVersion | - The CIGI version to which this packet is being converted. | |
| CnvtInfo | - The information needed for conversion |
Reimplemented from CigiBasePacket.
Definition at line 134 of file CigiBaseIGMsg.h.
References CIGI_IG_MSG_PACKET_ID_V2, CIGI_IG_MSG_PACKET_ID_V3, CIGI_SUCCESS, CigiVersionID::CigiMajorVersion, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, CigiProcessType::ProcNone, CigiProcessType::ProcStd, and CigiProcessType::ProcVarSize.
00135 { 00136 CnvtInfo.ProcID = CigiProcessType::ProcStd; 00137 00138 if(CnvtVersion.CigiMajorVersion < 2) 00139 { 00140 CnvtInfo.ProcID = CigiProcessType::ProcNone; 00141 CnvtInfo.CnvtPacketID = 0; 00142 } 00143 else 00144 { 00145 CnvtInfo.ProcID = CigiProcessType::ProcVarSize; 00146 if(CnvtVersion.CigiMajorVersion < 3) 00147 CnvtInfo.CnvtPacketID = CIGI_IG_MSG_PACKET_ID_V2; 00148 else 00149 CnvtInfo.CnvtPacketID = CIGI_IG_MSG_PACKET_ID_V3; 00150 } 00151 00152 return(CIGI_SUCCESS); 00153 }
| Cigi_int8* CigiBaseIGMsg::GetMsg | ( | void | ) | [inline] |
Gets the Msg value.
Definition at line 196 of file CigiBaseIGMsg.h.
References Msg.
00196 { return(Msg); }
| Cigi_uint16 CigiBaseIGMsg::GetMsgID | ( | void | ) | const [inline] |
Gets the MsgID value.
Definition at line 188 of file CigiBaseIGMsg.h.
References MsgID.
00188 { return(MsgID); }
| int CigiBaseIGMsg::GetMsgLen | ( | void | ) | const [inline] |
Gets the Msg Length.
Definition at line 204 of file CigiBaseIGMsg.h.
References MsgLen.
00204 { return(MsgLen); }
| virtual int CigiBaseIGMsg::GetTruePacketSize | ( | CigiBaseVariableSizePckt & | refPacket | ) | [pure virtual] |
A pure virtual function to determine the size that the packet will take up when packed. This function is not implemented in this class.
| refPacket | - A pointer to the current pack point. |
Implements CigiBaseVariableSizePckt.
Implemented in CigiIGMsgV2, and CigiIGMsgV3.
| virtual int CigiBaseIGMsg::Pack | ( | CigiBasePacket * | Base, | |
| Cigi_uint8 * | Buff, | |||
| void * | Spec | |||
| ) | const [pure virtual] |
A pure virtual Pack function. This function is not implemented in this class.
| 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. |
Implements CigiBaseVariableSizePckt.
Implemented in CigiIGMsgV3.
| int CigiBaseIGMsg::SetMsgID | ( | const Cigi_uint16 | MsgIDIn, | |
| bool | bndchk = true | |||
| ) | [inline] |
Sets the MsgID with bound checking control
| MsgIDIn | - Message ID | |
| bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 179 of file CigiBaseIGMsg.h.
References CIGI_SUCCESS, and MsgID.
00180 { 00181 MsgID = MsgIDIn; 00182 return(CIGI_SUCCESS); 00183 }
| virtual int CigiBaseIGMsg::Unpack | ( | Cigi_uint8 * | Buff, | |
| bool | Swap, | |||
| void * | Spec | |||
| ) | [pure virtual] |
A pure virtual Unpack function. This function is not implemented in this class.
| Buff | - A pointer to the current pack point. | |
| Swap | - N/A for V1 & V2 | |
| Spec | - A pointer to special data. |
Implements CigiBaseVariableSizePckt.
Implemented in CigiIGMsgV3.
friend class CigiIGMsgV2 [friend] |
Definition at line 77 of file CigiBaseIGMsg.h.
friend class CigiIGMsgV3 [friend] |
Definition at line 78 of file CigiBaseIGMsg.h.
Cigi_int8 CigiBaseIGMsg::Msg[100] [protected] |
Msg
The message string
Definition at line 222 of file CigiBaseIGMsg.h.
Referenced by CigiIGMsgV2::CigiIGMsgV2(), CigiIGMsgV3::CigiIGMsgV3(), GetMsg(), CigiIGMsgV3::Pack(), CigiIGMsgV3::SetMsg(), CigiIGMsgV2::SetMsg(), and CigiIGMsgV3::Unpack().
Cigi_uint16 CigiBaseIGMsg::MsgID [protected] |
MsgID
The message ID
Definition at line 216 of file CigiBaseIGMsg.h.
Referenced by CigiIGMsgV2::CigiIGMsgV2(), CigiIGMsgV3::CigiIGMsgV3(), GetMsgID(), CigiIGMsgV3::Pack(), SetMsgID(), and CigiIGMsgV3::Unpack().
int CigiBaseIGMsg::MsgLen [protected] |
MsgLen
The message string length
Definition at line 228 of file CigiBaseIGMsg.h.
Referenced by CigiIGMsgV2::CigiIGMsgV2(), CigiIGMsgV3::CigiIGMsgV3(), GetMsgLen(), CigiIGMsgV3::Pack(), CigiIGMsgV3::SetMsg(), and CigiIGMsgV3::Unpack().
1.4.7