rrbIffDecoder.h File Reference

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

Go to the source code of this file.

Classes
class	DtRRBIffDecoder

Macros
#define	DtDECLARE_RRB_IFF_ATTR_DECODER(attrName)   DtDECLARE_ATTR_DECODER(DtIffStateRepository, attrName)
	We define several macros that can be helpful in defining the class, and the individual decoding functions. More...
#define	DtDEFINE_SIMPLE_RRB_IFF_ATTR_DECODER(attrName, netType, inspector)
	This one can be used to define a "simple" attribute decoder. More...
#define	DtDEFINE_SIMPLE_RRB_ATTR_DECODER_WITH_CAST(decClass, stateRepClass, attrName, netType, mutator, castExpr)
	Defines a "simple" attribute decoder. More...
#define	DtDEFINE_SIMPLE_RRB_IFF_ATTR_DECODER_WITH_CAST(attrName, netType, mutator, castExpr)
	This one can be used to define a slightly-less-simple attribute decoder that requires an explicit cast to convert from the FOM representation to the native representation expected by the mutator. More...

Detailed Description

This file provides a declaration of the class DtRRBIffDecoder.

Macro Definition Documentation

#define DtDECLARE_RRB_IFF_ATTR_DECODER

(

attrName

)

DtDECLARE_ATTR_DECODER(DtIffStateRepository, attrName)

We define several macros that can be helpful in defining the class, and the individual decoding functions.

This one can be used to declare the attribute decoding functions, which are static members of DtNatoIffDecoder. This uses a more general macro defined in hStateDecoder.h.

#define DtDEFINE_SIMPLE_RRB_ATTR_DECODER_WITH_CAST	(		decClass,
			stateRepClass,
			attrName,
			netType,
			mutator,
			castExpr
	)

Value:

void decClass::decode##attrName( \
   stateRepClass* stateRep, \
   const RTI::AttributeHandleValuePairSet& attrs, \
   int index) \
{ \
   RTI::ULong length = 0; \
   netType* netValPtr = (netType*)attributeData(attrs, index, length, sizeof(netType), #attrName); \
   if (netValPtr) \
   { \
      stateRep->rrb()->mutator(castExpr *netValPtr); \
   } \
}

Defines a "simple" attribute decoder.

One in which we merely extract the data from the AHVPS into a variable of the named network type, and pass it to a named repository mutator method using the given cast expression. This works when the network type used to store the FOM representation can be converted to the native type expected by the mutator. Arguments are the decoder class, the state repository class, the attribute name, the network type, the mutator, and the cast operation.

#define DtDEFINE_SIMPLE_RRB_IFF_ATTR_DECODER	(		attrName,
			netType,
			inspector
	)

Value:

DtDEFINE_SIMPLE_RRB_IFF_ATTR_DECODER_WITH_CAST( \
      attrName, netType, inspector, (netType))

This one can be used to define a "simple" attribute decoder.

One in which we merely extract the data from the AHVPS, and pass it to a mutator function whose name is set<attrName>. This works when the "net" type used to store the FOM representation can implicitly be converted to the native type expected by the mutator. Arguments are the name of the attribute, the "net" type to use to store the FOM representation, and the name of the mutator function to call.

#define DtDEFINE_SIMPLE_RRB_IFF_ATTR_DECODER_WITH_CAST	(		attrName,
			netType,
			mutator,
			castExpr
	)

Value:

DtDEFINE_SIMPLE_RRB_ATTR_DECODER_WITH_CAST( \
      DtRRBIffDecoder, DtIffStateRepository, \
      attrName, netType, mutator, castExpr)

This one can be used to define a slightly-less-simple attribute decoder that requires an explicit cast to convert from the FOM representation to the native representation expected by the mutator.

Arguments are the same as the macro above, with a fourth argument which is a cast expression to be used to cast the "net" type to the type expected by the mutator.