FBConstructionOperation Class Reference

FBConstructionOperation Class Reference

#include <fbconstructionhistory.h>

Class 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.

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...
 

Friends

class FBConstructionHistory
 

Constructor & Destructor Documentation

Constructor.

Member Function Documentation

int GetCommandId ( )
bool GetExecuteAsLocalOperation ( )
const char* GetLanguage ( )
int GetLanguageVersion ( )
const char* GetOrigin ( )
const char* GetScript ( )
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
commandIdCommand Id. Defaults to -1.
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
bIsLocalDefaults to true (local).
void SetLanguage ( const char *  language)

SetLanguage Set the script language for this operation.

Currently only "python" is supported.

Parameters
languageLangugage string. Default to construction history's code generator's language (Currently "python").
void SetLanguageVersion ( int  version)

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

Parameters
versionVersion number. Defaults to construction history's code generator's version (Currently 1).
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
originOperation's Origin. Defaults to "localhost".
void SetScript ( const char *  script)

SetScript Set the script content for this operation.

Parameters
scriptScript content as a string. Defaults to empty.

Friends And Related Function Documentation

friend class FBConstructionHistory
friend

Definition at line 78 of file fbconstructionhistory.h.


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