hBaseEntEnc.h File Reference

This file provides a declaration of the class DtBaseEntityEncoder. More...

Go to the source code of this file.

Classes
class	DtBaseEntityEncoder
	class DtBaseEntityEncoder: More...
Defines
#define	DtDECLARE_ENTITY_ATTR_CHECKER(attrName)   DtDECLARE_ATTR_CHECKER(DtEntityStateRepository, attrName)
	This is used to declare static member functions for determining whether or not an attribute needs to be encoded.
#define	DtDECLARE_ENTITY_ATTR_ENCODER(attrName)   DtDECLARE_ATTR_ENCODER(DtEntityStateRepository, attrName)
	This is used to declare attribute encoding functions which are members of the class.
#define	DtDECLARE_AGGREGATE_ATTR_CHECKER(attrName)   DtDECLARE_ATTR_CHECKER(DtAggregateStateRepository, attrName)
	This is used to declare static member functions for determining whether or not an attribute needs to be encoded.
#define	DtDECLARE_AGGREGATE_ATTR_ENCODER(attrName)   DtDECLARE_ATTR_ENCODER(DtAggregateStateRepository, attrName)
	This is used to declare attribute encoding functions which are members of the class.
#define	DtDECLARE_BASE_ENTITY_ATTR_CHECKER(attrName)   DtDECLARE_ATTR_CHECKER(DtBaseEntityStateRepository, attrName)
	This is used to declare static member functions for determining whether or not an attribute needs to be encoded.
#define	DtDECLARE_BASE_ENTITY_ATTR_ENCODER(attrName)   DtDECLARE_ATTR_ENCODER(DtBaseEntityStateRepository, attrName)
	This is used to declare attribute encoding functions which are members of the class.
#define	DtDEFINE_SIMPLE_BASE_ENTITY_ATTR_ENCODER(attrName, netType, inspector)
	This macro is used to define simple attribute encoder functions (members of a derived DtHlaStateEncoder that encode individual attributes).
#define	DtDEFINE_SIMPLE_BASE_ENTITY_ATTR_CHECKER(attrName, inspector)
	This macro is used to define simple attribute checker functions (members of a derived DtHlaStateEncoder that check whether a particular attribute is out of date.) The simple implementation is to just compare the values returned by the two StateReps' inspector functions.

---

Detailed Description

This file provides a declaration of the class DtBaseEntityEncoder.

---

Define Documentation

#define DtDECLARE_AGGREGATE_ATTR_CHECKER

(

attrName

)

DtDECLARE_ATTR_CHECKER(DtAggregateStateRepository, attrName)

This is used to declare static member functions for determining whether or not an attribute needs to be encoded.

#define DtDECLARE_AGGREGATE_ATTR_ENCODER

(

attrName

)

DtDECLARE_ATTR_ENCODER(DtAggregateStateRepository, attrName)

This is used to declare attribute encoding functions which are members of the class.

#define DtDECLARE_BASE_ENTITY_ATTR_CHECKER

(

attrName

)

DtDECLARE_ATTR_CHECKER(DtBaseEntityStateRepository, attrName)

This is used to declare static member functions for determining whether or not an attribute needs to be encoded.

#define DtDECLARE_BASE_ENTITY_ATTR_ENCODER

(

attrName

)

DtDECLARE_ATTR_ENCODER(DtBaseEntityStateRepository, attrName)

This is used to declare attribute encoding functions which are members of the class.

#define DtDECLARE_ENTITY_ATTR_CHECKER

(

attrName

)

DtDECLARE_ATTR_CHECKER(DtEntityStateRepository, attrName)

This is used to declare static member functions for determining whether or not an attribute needs to be encoded.

#define DtDECLARE_ENTITY_ATTR_ENCODER

(

attrName

)

DtDECLARE_ATTR_ENCODER(DtEntityStateRepository, attrName)

This is used to declare attribute encoding functions which are members of the class.

#define DtDEFINE_SIMPLE_BASE_ENTITY_ATTR_CHECKER	(		attrName,
			inspector
	)

Value:

DtDEFINE_SIMPLE_ATTR_CHECKER(DtBaseEntityEncoder, \
      DtBaseEntityStateRepository, \
      attrName, inspector)

This macro is used to define simple attribute checker functions (members of a derived DtHlaStateEncoder that check whether a particular attribute is out of date.) The simple implementation is to just compare the values returned by the two StateReps' inspector functions.

#define DtDEFINE_SIMPLE_BASE_ENTITY_ATTR_ENCODER	(		attrName,
			netType,
			inspector
	)

Value:

DtDEFINE_SIMPLE_ATTR_ENCODER(DtBaseEntityEncoder, \
      DtBaseEntityStateRepository, \
      attrName, netType, inspector)

This macro is used to define simple attribute encoder functions (members of a derived DtHlaStateEncoder that encode individual attributes).

The simple encoding is just to implicitly convert the value returned by the inspector to a netType, and add it to the ahvps.