CigiBaseSymbolClone Class Reference

#include <CigiBaseSymbolClone.h>

Inheritance diagram for CigiBaseSymbolClone:

CigiBasePacket CigiSymbolCloneV3_3 List of all members.

Public Types

 SymbolSrc = 0
 SymbolTemplateSrc = 1
enum  SymbolSourceGrp { SymbolSrc = 0, SymbolTemplateSrc = 1 }

Public Member Functions

 CigiBaseSymbolClone (void)
virtual ~CigiBaseSymbolClone (void)
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)
int SetSymbolID (const Cigi_uint16 SymbolIDIn, bool bndchk=true)
Cigi_uint16 GetSymbolID (void) const
int SetSourceType (const SymbolSourceGrp SourceTypeIn, bool bndchk=true)
SymbolSourceGrp GetSourceType (void) const
int SetSourceID (const Cigi_uint16 SourceIDIn, bool bndchk=true)
Cigi_uint16 GetSourceID (void) const

Protected Attributes

Cigi_uint16 SymbolID
SymbolSourceGrp SourceType
Cigi_uint16 SourceID

Friends

class CigiSymbolCloneV3_3

Detailed Description

The base class for all packets.

Definition at line 59 of file CigiBaseSymbolClone.h.

Member Enumeration Documentation

enum CigiBaseSymbolClone::SymbolSourceGrp

The enumeration for the CigiBaseSymbolClone Symbol Source Group

Enumerator:
SymbolSrc 
SymbolTemplateSrc 

Definition at line 72 of file CigiBaseSymbolClone.h.

00073    {
00074       SymbolSrc=0,
00075       SymbolTemplateSrc=1
00076    };

Constructor & Destructor Documentation

CigiBaseSymbolClone::CigiBaseSymbolClone ( void   ) 

General Constructor

Definition at line 54 of file CigiBaseSymbolClone.cpp.

00055 {
00056 }

CigiBaseSymbolClone::~CigiBaseSymbolClone ( void   )  [virtual]

General Destructor

Definition at line 61 of file CigiBaseSymbolClone.cpp.

00062 {
00063 }

Member Function Documentation

int CigiBaseSymbolClone::GetCnvt ( CigiVersionID &  CnvtVersion,
CigiCnvtInfoType::Type &  CnvtInfo 
) [virtual]

A virtual Conversion Information function. This function provides conversion information for this packet.

Parameters:
CnvtVersion - The CIGI version to which this packet is being converted.
CnvtInfo - The information needed for conversion
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Reimplemented from CigiBasePacket.

Definition at line 69 of file CigiBaseSymbolClone.cpp.

References CIGI_SUCCESS, CIGI_SYMBOL_CLONE_PACKET_ID_V3_3, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiVersionID::GetCombinedCigiVersion(), CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, CigiProcessType::ProcNone, and CigiProcessType::ProcStd.

00071 {
00072    if(CnvtVersion.GetCombinedCigiVersion() < 0x303)
00073    {
00074       CnvtInfo.ProcID = CigiProcessType::ProcNone;
00075       CnvtInfo.CnvtPacketID = 0;
00076    }
00077    else
00078    {
00079       CnvtInfo.ProcID = CigiProcessType::ProcStd;
00080       CnvtInfo.CnvtPacketID = CIGI_SYMBOL_CLONE_PACKET_ID_V3_3;
00081    }
00082 
00083    return(CIGI_SUCCESS);
00084 }

Cigi_uint16 CigiBaseSymbolClone::GetSourceID ( void   )  const [inline]

Gets the SourceID with bound checking control

Returns:
The ID number of the source symbol or symbol template.

Definition at line 202 of file CigiBaseSymbolClone.h.

References SourceID.

00202 { return(SourceID); }

SymbolSourceGrp CigiBaseSymbolClone::GetSourceType ( void   )  const [inline]

Gets the SourceType with bound checking control

Returns:
The State of this symbol.

Definition at line 178 of file CigiBaseSymbolClone.h.

References SourceType.

00178 { return(SourceType); }

Cigi_uint16 CigiBaseSymbolClone::GetSymbolID ( void   )  const [inline]

Gets the SymbolID

Returns:
The ID number of this symbol.

Definition at line 158 of file CigiBaseSymbolClone.h.

References SymbolID.

00158 { return(SymbolID); }

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

A pure virtual Pack function. This function is not implemented in this class.

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.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBasePacket.

Implemented in CigiSymbolCloneV3_3.

int CigiBaseSymbolClone::SetSourceID ( const Cigi_uint16  SourceIDIn,
bool  bndchk = true 
) [inline]

Sets the SourceID with bound checking control

Parameters:
SourceIDIn - Specifies the ID number of the source to be cloned. Either another symbol or a symbol template.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 191 of file CigiBaseSymbolClone.h.

References CIGI_SUCCESS, and SourceID.

00192    {
00193       SourceID = SourceIDIn;
00194       return(CIGI_SUCCESS);
00195    }

int CigiBaseSymbolClone::SetSourceType ( const SymbolSourceGrp  SourceTypeIn,
bool  bndchk = true 
)

Sets the SourceType with bound checking control

Parameters:
SourceTypeIn - Specifies the type of object from which this symbol is being cloned. (SymbolSrc, SymbolTemplateSrc)
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 94 of file CigiBaseSymbolClone.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and SourceType.

00095 {
00096 
00097 #ifndef CIGI_NO_BND_CHK
00098    if(bndchk && ((SourceTypeIn < 0)||(SourceTypeIn > 1)))
00099    {
00100 #ifndef CIGI_NO_EXCEPT
00101       throw CigiValueOutOfRangeException("SymbolSourceType", (int)SourceTypeIn,0,1);
00102 #endif
00103       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00104    }
00105 #endif
00106 
00107    SourceType = SourceTypeIn;
00108 
00109    return(CIGI_SUCCESS);
00110 
00111 }

int CigiBaseSymbolClone::SetSymbolID ( const Cigi_uint16  SymbolIDIn,
bool  bndchk = true 
) [inline]

Sets the SymbolID with bound checking control

Parameters:
SymbolIDIn - Specifies the ID number of this symbol.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 148 of file CigiBaseSymbolClone.h.

References CIGI_SUCCESS, and SymbolID.

00149    {
00150       SymbolID = SymbolIDIn;
00151       return(CIGI_SUCCESS);
00152    }

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

A pure virtual Unpack function. This function is not implemented in this class.

Parameters:
Buff - A pointer to the current pack point.
Swap - N/A for V1 & V2
Spec - A pointer to special data.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBasePacket.

Implemented in CigiSymbolCloneV3_3.

Friends And Related Function Documentation

friend class CigiSymbolCloneV3_3 [friend]

Definition at line 63 of file CigiBaseSymbolClone.h.

Member Data Documentation

Cigi_uint16 CigiBaseSymbolClone::SourceID [protected]

SourceID
The ID number of the Source symbol or symbol template.

Definition at line 229 of file CigiBaseSymbolClone.h.

Referenced by CigiSymbolCloneV3_3::CigiSymbolCloneV3_3(), GetSourceID(), CigiSymbolCloneV3_3::Pack(), SetSourceID(), and CigiSymbolCloneV3_3::Unpack().

SymbolSourceGrp CigiBaseSymbolClone::SourceType [protected]

SymbolState
Specifies the type of object from which this symbol is being cloned.
SymbolSrc
SymbolTemplateSrc

Definition at line 223 of file CigiBaseSymbolClone.h.

Referenced by CigiSymbolCloneV3_3::CigiSymbolCloneV3_3(), GetSourceType(), CigiSymbolCloneV3_3::Pack(), SetSourceType(), and CigiSymbolCloneV3_3::Unpack().

Cigi_uint16 CigiBaseSymbolClone::SymbolID [protected]

SymbolID
The ID number of this symbol

Definition at line 214 of file CigiBaseSymbolClone.h.

Referenced by CigiSymbolCloneV3_3::CigiSymbolCloneV3_3(), GetSymbolID(), CigiSymbolCloneV3_3::Pack(), SetSymbolID(), and CigiSymbolCloneV3_3::Unpack().

The documentation for this class was generated from the following files:
Generated on Wed Apr 29 09:00:06 2009 for CCL by  doxygen 1.4.7