FBConstructionOperation Class Reference

FBConstructionOperation is used to represent an operation in the construction history. More...

#include <fbconstructionhistory.h>

Public Member Functions
	FBConstructionOperation ()
	Constructor. More...
	FBConstructionOperation (const FBConstructionOperation *pOperation)
const char *	GetLanguage ()
int	GetLanguageVersion ()
const char *	GetScript ()
const char *	GetOrigin ()
int	GetCommandId ()
bool	GetExecuteAsLocalOperation ()
void	SetLanguage (const char *language)
	SetLanguage Set the script language for this operation. More...
void	SetLanguageVersion (int version)
	SetLanguageVersion Set the script language interpreter's version that this operation should be interpreted with. More...
void	SetScript (const char *script)
	SetScript Set the script content for this operation. More...
void	SetCommandId (int commandId)
	SetCommandId Set the operation's Id so that operation transactions can be resolved properly (eg: command 1 should go before command 2). More...
void	SetOrigin (const char *origin)
	SetOrigin Set operation's original creator. More...
void	SetExecuteAsLocalOperation (bool bIsLocal)
	SetExecuteAsLocalOperation Whether to execute this operation as local or remote. More...

Detailed Description

FBConstructionOperation is used to represent an operation in the construction history.

The operation can be any valid script. Currently, only python scripts are supported.

An instance of this class defaults to the correct value in order to add a new construction history. If the workgroup plugin is loaded, the operation will be replicated on all machine within a session.

Definition at line 76 of file fbconstructionhistory.h.

Constructor & Destructor Documentation

FBConstructionOperation()

FBConstructionOperation

(

)

Constructor.

Member Function Documentation

SetCommandId()

void SetCommandId

(

int

commandId

)

SetCommandId Set the operation's Id so that operation transactions can be resolved properly (eg: command 1 should go before command 2).

Set this to -1 for new operations.

Parameters

commandId

Command Id. Defaults to -1.

SetExecuteAsLocalOperation()

void SetExecuteAsLocalOperation

(

bool

bIsLocal

)

SetExecuteAsLocalOperation Whether to execute this operation as local or remote.

If this is set to false (remote) and an operation is sent to the construction history, it will also execute locally on this motionbuilder.

Parameters

bIsLocal

Defaults to true (local).

SetLanguage()

void SetLanguage

(

const char *

language

)

SetLanguage Set the script language for this operation.

Currently only "python" is supported.

Parameters

language

Langugage string. Default to construction history's code generator's language (Currently "python").

SetLanguageVersion()

void SetLanguageVersion

(

int

version

)

SetLanguageVersion Set the script language interpreter's version that this operation should be interpreted with.

Parameters

version

Version number. Defaults to construction history's code generator's version (Currently 1).

SetOrigin()

void SetOrigin

(

const char *

origin

)

SetOrigin Set operation's original creator.

For instance "localhost" or http://192.0.0.1:9000. Should mostly be "localhost" for new operations.

Parameters

origin

Operation's Origin. Defaults to "localhost".

SetScript()

void SetScript

(

const char *

script

)

SetScript Set the script content for this operation.

Parameters

script

Script content as a string. Defaults to empty.

---

The documentation for this class was generated from the following file:

• fbconstructionhistory.h