API Guides > ConceptRT 3.x
DynamicInvocationRequest Class Referenceabstract

Dynamic invocation request. More...

Detailed Description

Dynamic invocation request.

+ Inheritance diagram for DynamicInvocationRequest:

Public Member Methods

 DynamicInvocationRequest ()
 Default constructor. More...
 
virtual void Clear ()=0
 Clears this object to its blank/initial state. More...
 
virtual bool IsClear () const =0
 Query if this object is clear. More...
 
bool IsFormatValid () const
 Query if this object is format valid. More...
 
Int32 GetInvocationId () const
 Gets the invocation identifier. More...
 
InvocationType GetInvocationType () const
 Gets the invocation type. More...
 
bool GetReferencedObject (IInvocable *&object) const
 Gets the referenced object. More...
 
bool IsSessionIdValid () const
 Query if the session identifier is valid. More...
 
PCChar8 GetMemberName () const
 Gets the member name. More...
 
const StringsGetParameters () const
 Gets the parameters. More...
 
Int32 GetParametersCount () const
 Gets the parameters count. More...
 
bool IsMemberName (PCChar8 name) const
 Query if 'name' is the same than the member name. More...
 
void SetInvocation (Int32 invocationId, DynamicInvocationObjectReference objectReference, InvocationType invocationType, PCChar8 memberName)
 Sets an invocation. More...
 
void AppendParameter (PCChar8 parameter)
 Appends a parameter. More...
 

Constructor & Destructor Documentation

Default constructor.

Methods Documentation

void AppendParameter ( PCChar8  parameter)

Appends a parameter.

Parameters
parameterThe parameter.
virtual void Clear ( )
pure virtual

Clears this object to its blank/initial state.

Implemented in DynamicInvocationRequestPackedStrings.

Int32 GetInvocationId ( ) const

Gets the invocation identifier.

Returns
The invocation identifier.
InvocationType GetInvocationType ( ) const

Gets the invocation type.

Returns
The invocation type.
RT Exceptions:
RT_ERROR_INTERNAL_INVALID_TYPE
PCChar8 GetMemberName ( ) const

Gets the member name.

Returns
The member name.
const Strings& GetParameters ( ) const

Gets the parameters.

Returns
The parameters.
Int32 GetParametersCount ( ) const

Gets the parameters count.

Returns
The parameters count.
bool GetReferencedObject ( IInvocable *&  object) const

Gets the referenced object.

Parameters
object[in,out] [in,out] The referenced object.
Returns
true if it succeeds, false if session invalid.
virtual bool IsClear ( ) const
pure virtual

Query if this object is clear.

Returns
true if clear, false if not.

Implemented in DynamicInvocationRequestPackedStrings.

bool IsFormatValid ( ) const

Query if this object is format valid.

Returns
true if format valid, false if not.
bool IsMemberName ( PCChar8  name) const

Query if 'name' is the same than the member name.

Parameters
nameThe name.
Returns
true if the member name is the same, false if not.
bool IsSessionIdValid ( ) const

Query if the session identifier is valid.

Returns
true if session valid, false if not.
void SetInvocation ( Int32  invocationId,
DynamicInvocationObjectReference  objectReference,
InvocationType  invocationType,
PCChar8  memberName 
)

Sets an invocation.

Parameters
invocationIdIdentifier for the invocation.
objectReferenceThe object reference.
invocationTypeType of the invocation.
memberNameName of the member.