All Frameworks Class Hierarchy This Framework Indexes Previous Next

System Interface CATIScriptJournal

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIScriptJournal

Interface to represent the journal of method calls used for the macros generation.
Role: CATIScriptJournal is used to store a list of method calls in a scripting language independent fashion. The CATIScriptJournal also maintains a reference table for all the objects that are manipulated by the script.

See also:: ,

Method Index

o AddMethodCall(CATIScriptMethodCall*): Adds the method call to the list of recorded method calls.
o CountMethodCalls(int&): Retrieves the count of recorded method calls.
o CreateMethodCall(CATIScriptMethodCall*&): Instantiates a new empty method call.
o GetMethodCall(int,CATIScriptMethodCall*&): Retrieves the i-th method call.
o RegisterObject(CATBaseDispatch*,CATUnicodeString&): Registers an object using a given name for the macros generation.

Methods

o AddMethodCall

public virtual AddMethodCall( iMethodCall)

Adds the method call to the list of recorded method calls.

Parameters:

iMethodCall: The method call to add.

Returns:

S_OK if the operation succeeded, E_FAIL otherwise.

o CountMethodCalls

public virtual CountMethodCalls( oCount)

Retrieves the count of recorded method calls.

Parameters:

oCount: The returned count of recorded method calls.

Returns:

S_OK if the operation succeeded, E_FAIL otherwise.

o CreateMethodCall

public virtual CreateMethodCall( oMethodCall)

Instantiates a new empty method call.
The method call is not recorded while it is not added to the journal.

Parameters:

oMethodCall: The returned empty method call.

Returns:

S_OK if the operation succeeded, E_FAIL otherwise.

o GetMethodCall

public virtual GetMethodCall(		`iIndex`,
		`oMethodCall`)

Retrieves the i-th method call.

Parameters:

iIndex: The specified index of the method call to retrieve.
Caution : the first method call has an index equal to 1.
oMethodCall: The returned method call.

Returns:

S_OK if the operation succeeded, E_FAIL otherwise.

See also:

o RegisterObject

public virtual RegisterObject(	const	`iObject`,
	const	`iName`)

Registers an object using a given name for the macros generation.
Role: The registered object which will be referenced as 'iName' in the scripts generated by the script manager.

Parameters:

iObject: The object to register.
iName: The registered name for the object.

Returns:

S_OK if the operation succeeded, E_FAIL otherwise.

This object is included in the file: CATIScriptJournal.h
If needed, your Imakefile.mk should include the module: JS0GROUP