planUtil.h File Reference

Go to the source code of this file.

Functions
DT_DLL_vrfobjcore bool	DtSendPlanMessage (const DtUUID &sendTo, const DtPlan &plan, bool isGlobal, const DtSimulationAddress &destAddress, DtVrfMessageInterface *messageIf, bool isAssigned=false, bool abandonCurrentPlan=true)
DT_DLL_vrfobjcore bool	DtFillInPlanMsg (DtIfPlan &planMsg, const DtPlan &plan, bool isGlobal=false, DtVrfMessageInterface *messageIf=0, bool isAssigned=false, bool abandonCurrentPlan=true)
DT_DLL_vrfobjcore bool	DtSendPlanStatementMessage (const DtPlan &plan, bool isGlobal, int statementId, const DtSimulationAddress &destAddress, DtVrfMessageInterface *messageIf)

Function Documentation

DT_DLL_vrfobjcore bool DtSendPlanMessage	(	const DtUUID &	sendTo,
		const DtPlan &	plan,
		bool	isGlobal,
		const DtSimulationAddress &	destAddress,
		DtVrfMessageInterface *	messageIf,
		bool	isAssigned = false,
		bool	abandonCurrentPlan = true
	)

Sends the specified plan onto the network inside one or more interface messages. If plans are long, they are split into multiple messages and sent that way. Messages are not sent immediately, but rather registered with a postDrainCallback on the exercise connection, so that they won't be sent from inside a drain input call. (For DMSO RTI compatibility). The plan message includes a isGlobal bool to specify whether the message is for a global plan or not. isAssigned is another bool in the plan message that specifies whether the plan should replace/append to the entity's plan or if false means we just want to get the current plan i.e. requestPlan messages. Set to false by default, just sending current plan.

DT_DLL_vrfobjcore bool DtFillInPlanMsg	(	DtIfPlan &	planMsg,
		const DtPlan &	plan,
		bool	isGlobal = false,
		DtVrfMessageInterface *	messageIf = 0,
		bool	isAssigned = false,
		bool	abandonCurrentPlan = true
	)

Fills in the plan message and sets the contents ready to send over the network. Called from DtSendPlanMessage.

DT_DLL_vrfobjcore bool DtSendPlanStatementMessage	(	const DtPlan &	plan,
		bool	isGlobal,
		int	statementId,
		const DtSimulationAddress &	destAddress,
		DtVrfMessageInterface *	messageIf
	)

Sends a DtIfPlanStatement with the indicated statement of the plan. Messages are not sent immediately, but rather registered with a postDrainCallback on the exercise connection, so that they won't be sent from inside a drain input call. (For DMSO RTI compatibility).