testInter/testDec.h File Reference

Go to the source code of this file.

Classes
class	TestDecoder
	This class decodes the Test interaction into the TestInteraction class. More...

Macros
#define	DtDECLARE_TEST_PARAM_DECODER(paramName)   DtDECLARE_PARAM_DECODER(TestInteraction, paramName)
	We define several macros that can be helpful in defining the class, and the individual decoding functions.
#define	DtDEFINE_SIMPLE_TEST_PARAM_DECODER(paramName, netType, mutator)
	This one can be used to define a "simple" parameter decoder.
#define	DtDEFINE_SIMPLE_TEST_PARAM_DECODER_WITH_CAST(paramName, netType, mutator, castExpr)
	This one can be used to define a slightly-less-simple parameter decoder that requires an explicit cast to convert from the FOM representation to the native representation expected by the mutator.

Macro Definition Documentation

#define DtDECLARE_TEST_PARAM_DECODER

(

paramName

)

DtDECLARE_PARAM_DECODER(TestInteraction, paramName)

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 parameter decoding functions, which are static members of TestDecoder. Just pass the name of the parameter. It uses a more general macro defined in interDecoder.h.

#define DtDEFINE_SIMPLE_TEST_PARAM_DECODER	(		paramName,
			netType,
			mutator
	)

Value:

DtDEFINE_SIMPLE_PARAM_DECODER(TestDecoder, TestInteraction, \
      paramName, netType, mutator)

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

One in which we merely extract the data from the PHVPS, and pass it to a mutator function whose name is set<paramName>. 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 parameter, the "net" type to use to store the FOM representation, and the name of the mutator function to call.

#define DtDEFINE_SIMPLE_TEST_PARAM_DECODER_WITH_CAST	(		paramName,
			netType,
			mutator,
			castExpr
	)

Value:

DtDEFINE_SIMPLE_PARAM_DECODER_WITH_CAST( \
      TestDecoder, TestInteraction, \
      paramName, netType, mutator, castExpr)

This one can be used to define a slightly-less-simple parameter 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.