Dynamic invocation client object. More...

Detailed Description

Dynamic invocation client object.

Inheritance diagram for DynamicInvocationClientObject:

Public Member Methods
bool	OpenMetaData ()
	Opens the meta data. More...

void	CloseMetaData ()
	Closes the meta data. More...

Int32	GetMetaDataCount ()
	Gets the meta data count. More...

MemberType	GetMetaDataMemberType (Int32 index)
	Gets a meta data member type. More...

PCChar8	GetMetaDataMemberDefinition (Int32 index)
	Gets a meta data member definition. More...

DynamicInvocationClientChannel &	GetChannel ()
	Gets the channel. More...

bool	OpenEvaluation (PCChar8 memberName, PCChar8 parameter0=0, PCChar8 parameter1=0, PCChar8 parameter2=0, PCChar8 parameter3=0, PCChar8 parameter4=0, PCChar8 parameter5=0, PCChar8 parameter6=0, PCChar8 parameter7=0, PCChar8 parameter8=0, PCChar8 parameter9=0)
	Opens an evaluation. More...

InvocationResultType	GetResultType ()
	Gets the result type. More...

Int32	GetResultCount ()
	Gets the result count. More...

PCChar8	GetResult (Int32 index)
	Gets a result. More...

void	CloseEvaluation ()
	Closes the evaluation. More...

Variant	Evaluate (PCChar8 memberName, const Variant &parameter0=Variant::GetVariantNull(), const Variant &parameter1=Variant::GetVariantNull(), const Variant &parameter2=Variant::GetVariantNull(), const Variant &parameter3=Variant::GetVariantNull(), const Variant &parameter4=Variant::GetVariantNull(), const Variant &parameter5=Variant::GetVariantNull(), const Variant &parameter6=Variant::GetVariantNull(), const Variant &parameter7=Variant::GetVariantNull(), const Variant &parameter8=Variant::GetVariantNull(), const Variant &parameter9=Variant::GetVariantNull())
	Evaluates. Evaluation helper. More...

void	Execute (PCChar8 memberName, const Variant &parameter0=Variant::GetVariantNull(), const Variant &parameter1=Variant::GetVariantNull(), const Variant &parameter2=Variant::GetVariantNull(), const Variant &parameter3=Variant::GetVariantNull(), const Variant &parameter4=Variant::GetVariantNull(), const Variant &parameter5=Variant::GetVariantNull(), const Variant &parameter6=Variant::GetVariantNull(), const Variant &parameter7=Variant::GetVariantNull(), const Variant &parameter8=Variant::GetVariantNull(), const Variant &parameter9=Variant::GetVariantNull())
	Executes. More...

bool	TryGetChild (PCChar8 childName, DynamicInvocationClientObjectChild &child, bool forceBind)
	Try get child. More...

void	GetChild (PCChar8 childName, DynamicInvocationClientObjectChild &child, bool forceBind)
	Gets a child of this item. More...

void	SetValue (PCChar8 memberName, const Variant &value)
	Sets a value. More...

void	SetValue (PCChar8 memberName, const BaseStaticString &value)
	Sets a value. More...

void	SetValue (PCChar8 memberName, PCChar8 value)
	Sets a value. More...

virtual TimeSpan	GetTimeout () const =0
	Gets the timeout. More...

Methods Documentation

void CloseEvaluation ( )

Closes the evaluation.

Warning: Call order dependence : OpenEvaluation() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

void CloseMetaData ( )

Closes the meta data.

Warning: Call order dependence : OpenMetaData() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Variant Evaluate	(	PCChar8	memberName,
		const Variant &	parameter0 = `Variant::GetVariantNull()`,
		const Variant &	parameter1 = `Variant::GetVariantNull()`,
		const Variant &	parameter2 = `Variant::GetVariantNull()`,
		const Variant &	parameter3 = `Variant::GetVariantNull()`,
		const Variant &	parameter4 = `Variant::GetVariantNull()`,
		const Variant &	parameter5 = `Variant::GetVariantNull()`,
		const Variant &	parameter6 = `Variant::GetVariantNull()`,
		const Variant &	parameter7 = `Variant::GetVariantNull()`,
		const Variant &	parameter8 = `Variant::GetVariantNull()`,
		const Variant &	parameter9 = `Variant::GetVariantNull()`
	)

Evaluates. Evaluation helper.

Parameters

memberName	Name of the member.
parameter0	(optional) the parameter 0.
parameter1	(optional) the first parameter.
parameter2	(optional) the second parameter.
parameter3	(optional) the third parameter.
parameter4	(optional) the fourth parameter.
parameter5	(optional) the fifth parameter.
parameter6	(optional) the parameter 6.
parameter7	(optional) the parameter 7.
parameter8	(optional) the parameter 8.
parameter9	(optional) the parameter 9.

Returns: Variant result.

RT Exceptions:

RT_ERROR_EVALUATION_FAILD

RT_ERROR_BAD_CALL_ORDER

Examples:: DynamicInvocation/1.Client/main.cpp.

void Execute	(	PCChar8	memberName,
		const Variant &	parameter0 = `Variant::GetVariantNull()`,
		const Variant &	parameter1 = `Variant::GetVariantNull()`,
		const Variant &	parameter2 = `Variant::GetVariantNull()`,
		const Variant &	parameter3 = `Variant::GetVariantNull()`,
		const Variant &	parameter4 = `Variant::GetVariantNull()`,
		const Variant &	parameter5 = `Variant::GetVariantNull()`,
		const Variant &	parameter6 = `Variant::GetVariantNull()`,
		const Variant &	parameter7 = `Variant::GetVariantNull()`,
		const Variant &	parameter8 = `Variant::GetVariantNull()`,
		const Variant &	parameter9 = `Variant::GetVariantNull()`
	)

Executes.

Parameters

memberName	Name of the member.
parameter0	(optional) the parameter 0.
parameter1	(optional) the first parameter.
parameter2	(optional) the second parameter.
parameter3	(optional) the third parameter.
parameter4	(optional) the fourth parameter.
parameter5	(optional) the fifth parameter.
parameter6	(optional) the parameter 6.
parameter7	(optional) the parameter 7.
parameter8	(optional) the parameter 8.
parameter9	(optional) the parameter 9.

RT Exceptions:

RT_ERROR_EVALUATION_FAILD

RT_ERROR_BAD_CALL_ORDER

DynamicInvocationClientChannel& GetChannel ( )

Gets the channel.

Returns: The channel.

RT Exceptions:: RT_ERROR_OBJECT_NOT_DEFINED_PROPERLY

void GetChild	(	PCChar8	childName,
		DynamicInvocationClientObjectChild &	child,
		bool	forceBind
	)

Gets a child of this item.

Parameters

childName	Name of the child.
child	[in,out] The child.
forceBind	true to force bind.

RT Exceptions:

RT_ERROR_BAD_CALL_ORDER

RT_ERROR_GET_CHILD_FAILD

Examples:: DynamicInvocation/1.Client/main.cpp.

Int32 GetMetaDataCount ( )

Gets the meta data count.

Returns: The meta data count.

Warning: Call order dependence : OpenMetaData() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

PCChar8 GetMetaDataMemberDefinition ( Int32 index )

Gets a meta data member definition.

Parameters

index Zero-based index of the.

Returns: The meta data member definition.

Warning: Call order dependence : OpenMetaData() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

MemberType GetMetaDataMemberType ( Int32 index )

Gets a meta data member type.

Parameters

index Zero-based index of the.

Returns: The meta data member type.

Warning: Call order dependence : OpenMetaData() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

PCChar8 GetResult ( Int32 index )

Gets a result.

Parameters

index Zero-based index of the.

Returns: The result.

Warning: Call order dependence : OpenEvaluation() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Int32 GetResultCount ( )

Gets the result count.

Returns: The result count.

Warning: Call order dependence : OpenEvaluation() must be called first.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

InvocationResultType GetResultType ( )

Gets the result type.

Returns: The result type.

Warning: Call order dependence : OpenEvaluation() must be called first.

virtual TimeSpan GetTimeout ( ) const

pure virtual

Gets the timeout.

Returns: The timeout.

Implemented in DynamicInvocationClientObjectChild, and DynamicInvocationClientObjectRoot.

bool OpenEvaluation	(	PCChar8	memberName,
		PCChar8	parameter0 = `0`,
		PCChar8	parameter1 = `0`,
		PCChar8	parameter2 = `0`,
		PCChar8	parameter3 = `0`,
		PCChar8	parameter4 = `0`,
		PCChar8	parameter5 = `0`,
		PCChar8	parameter6 = `0`,
		PCChar8	parameter7 = `0`,
		PCChar8	parameter8 = `0`,
		PCChar8	parameter9 = `0`
	)

Opens an evaluation.

Parameters

memberName	Name of the member.
parameter0	(optional) the parameter 0.
parameter1	(optional) the first parameter.
parameter2	(optional) the second parameter.
parameter3	(optional) the third parameter.
parameter4	(optional) the fourth parameter.
parameter5	(optional) the fifth parameter.
parameter6	(optional) the parameter 6.
parameter7	(optional) the parameter 7.
parameter8	(optional) the parameter 8.
parameter9	(optional) the parameter 9.

Returns: true if it succeeds, false if it fails.

Evaluation.

Warning: Call order dependence : CloseEvaluation() must be called at the end of evaluation.

RT Exceptions:

RT_ERROR_BAD_CALL_ORDER

RT_ERROR_UNEXPECTED_NULL_POINTER

bool OpenMetaData ( )

Opens the meta data.

Returns: true if it succeeds, false if it fails.

Explore metadata.

Warning: Call order dependence : CloseMetaData() must be called when the exploration is finished.

RT Exceptions:

RT_ERROR_BAD_CALL_ORDER

RT_ERROR_UNEXPECTED_NULL_POINTER

void SetValue	(	PCChar8	memberName,
		const Variant &	value
	)

Sets a value.

Parameters

memberName	Name of the member.
value	The value.

RT Exceptions:

RT_ERROR_BAD_CALL_ORDER

RT_ERROR_EVALUATION_FAILD

RT_ERROR_UNEXPECTED_NULL_POINTER

void SetValue	(	PCChar8	memberName,
		const BaseStaticString &	value
	)

Sets a value.

Parameters

memberName	Name of the member.
value	The value.

RT Exceptions:

RT_ERROR_BAD_CALL_ORDER

RT_ERROR_EVALUATION_FAILD

RT_ERROR_UNEXPECTED_NULL_POINTER

void SetValue	(	PCChar8	memberName,
		PCChar8	value
	)

Sets a value.

Parameters

memberName	Name of the member.
value	The value.

RT Exceptions:

RT_ERROR_BAD_CALL_ORDER

RT_ERROR_EVALUATION_FAILD

RT_ERROR_UNEXPECTED_NULL_POINTER

bool TryGetChild	(	PCChar8	childName,
		DynamicInvocationClientObjectChild &	child,
		bool	forceBind
	)

Try get child.

Parameters

childName	Name of the child.
child	[in,out] The child.
forceBind	true to force bind.

Returns: true if it succeeds, false if it fails.

RT Exceptions:: RT_ERROR_BAD_CALL_ORDER

Detailed Description

Public Member Methods

Methods Documentation