Teamcenter C++ API Reference  2312
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
Teamcenter::OperationDispatcher Class Reference

#include <OperationDispatcher.hxx>

Inheritance diagram for Teamcenter::OperationDispatcher:
Teamcenter::Object pgp0::pgp0awprgplanning::Prg0AbsEventGenImpl::pgp0CanDeleteEventObjectOperationDispatcher pgp0::pgp0awprgplanning::Prg0AbsEventGenImpl::pgp0IsContentSecurityEnabledOperationDispatcher pgp0::pgp0awprgplanning::Prg0AbsPlanGenImpl::pgp0CanAddEventObjectOperationDispatcher pgp0::pgp0awprgplanning::Prg0AbsPlanGenImpl::pgp0CanAddPlanLevelObjectOperationDispatcher pgp0::pgp0awprgplanning::Prg0AbsPlanGenImpl::pgp0IsContentSecurityEnabledOperationDispatcher Teamcenter::PropOperationDispatcher Teamcenter::getCharArrayOperationDispatcher Teamcenter::getCharOperationDispatcher Teamcenter::getDateArrayOperationDispatcher Teamcenter::getDateOperationDispatcher Teamcenter::getDisplayableValuesOperationDispatcher Teamcenter::getDoubleArrayOperationDispatcher Teamcenter::getDoubleOperationDispatcher Teamcenter::getIntArrayOperationDispatcher Teamcenter::getIntOperationDispatcher Teamcenter::getLogicalArrayOperationDispatcher Teamcenter::getLogicalOperationDispatcher Teamcenter::getStringArrayOperationDispatcher Teamcenter::getStringOperationDispatcher Teamcenter::getTagArrayOperationDispatcher Teamcenter::getTagOperationDispatcher Teamcenter::setCharArrayOperationDispatcher Teamcenter::setCharOperationDispatcher Teamcenter::setDateArrayOperationDispatcher Teamcenter::setDateOperationDispatcher Teamcenter::setDoubleArrayOperationDispatcher Teamcenter::setDoubleOperationDispatcher Teamcenter::setIntArrayOperationDispatcher Teamcenter::setIntOperationDispatcher Teamcenter::setLogicalArrayOperationDispatcher Teamcenter::setLogicalOperationDispatcher Teamcenter::setStringArrayOperationDispatcher Teamcenter::setStringOperationDispatcher Teamcenter::setTagArrayOperationDispatcher Teamcenter::setTagOperationDispatcher

Public Types

typedef logical(* METHOD_user_arg_compare_t )(TC_argument_list_t *firstArg, TC_argument_list_t *secondArg)
 

Public Member Functions

void addPostAction (METHOD_function_t fnPtr, TC_argument_list_t *userArgs, bool functionInvokerRequired=true, bool auto_dispatched=true)
 
void addPostAction2 (METHOD_function_t fnPtr, TC_argument_list_t *userArgs, EXTENSIONFRAMEWORK_extension_category_t extnCategory, bool functionInvokerRequired=true, bool auto_dispatched=true)
 
void addPostActionAt (int pos, METHOD_function_t fnPtr, TC_argument_list_t *userArgs)
 
void addPostActionInternal (METHOD_function_t fnPtr, TC_argument_list_t *userArgs, bool functionInvokerRequired=true, bool auto_dispatched=true)
 
void addPreAction (METHOD_function_t fnPtr, TC_argument_list_t *userArgs, bool functionInvokerRequired=true)
 
void addPreAction2 (METHOD_function_t fnPtr, TC_argument_list_t *userArgs, EXTENSIONFRAMEWORK_extension_category_t extnCategory, bool functionInvokerRequired=true)
 
void addPreActionAt (int pos, METHOD_function_t fnPtr, TC_argument_list_t *userArgs)
 
void addPreCondition (METHOD_function_t fnPtr, TC_argument_list_t *userArgs, bool functionInvokerRequired=true)
 
void addPreCondition2 (METHOD_function_t fnPtr, TC_argument_list_t *userArgs, EXTENSIONFRAMEWORK_extension_category_t extnCategory, bool functionInvokerRequired=true)
 
void addPreConditionAt (int pos, METHOD_function_t fnPtr, TC_argument_list_t *userArgs)
 
int addRuntimeUserArguments (const char *extensionName, ExtensionPointType_t extType, int argCount, const TC_argument_t *args)
 
bool anyPostActions () const
 
bool anyPreActions () const
 
bool anyPreConditions () const
 
const char * askBMOperationName () const
 
void askBMOperationtag (tag_t *bmoptag) const
 
const BulkOperation_bulk_loader_t askBulkOperationFuncPtr () const
 
bool baseFunctionExists () const
 
void copyBaseFnDataFromExistingOperationDispatcher (OperationDispatcher *opDispatcher)
 
void copyPreBasePostFromExistingOperationDispatcher (OperationDispatcher *opDispatcher)
 
ExtensionSet * createExtensionSetObject (ExtensionPointType_t extType)
 
void dumpFunction ()
 
int exeBaseAction (METHOD_message_t *msg,...) const
 
virtual void execute (tag_t object_tag, va_list args) const
 
virtual void execute (Teamcenter::BusinessObject *obj, va_list args) const
 
virtual void execute (Teamcenter::BusinessObject *obj, std::vector< void * > &args) const
 
virtual void executeBaseAction (METHOD_message_t &msg, va_list args, bool userExitBase=false) const
 
virtual void executeBaseAction (tag_t object_tag, va_list args, bool userExitBase=false) const
 
virtual void executeBaseAction (Teamcenter::BusinessObject *obj, va_list args) const
 
int executeBaseAction2 (METHOD_message_t &msg, va_list args) const
 
void executeHighPriorityPostActions (METHOD_message_t &msg, va_list args) const
 
virtual void executePostActions (METHOD_message_t &msg, va_list args) const
 
virtual void executePostActions (tag_t object_tag, va_list args) const
 
virtual void executePostActions (Teamcenter::BusinessObject *obj, va_list args) const
 
virtual void executePreActions (METHOD_message_t &msg, va_list args) const
 
virtual void executePreActions (tag_t object_tag, va_list args) const
 
virtual void executePreActions (Teamcenter::BusinessObject *obj, va_list args) const
 
virtual void executePreConditions (METHOD_message_t &msg, va_list args) const
 
virtual void executePreConditions (tag_t object_tag, va_list args) const
 
virtual void executePreConditions (Teamcenter::BusinessObject *obj, va_list args) const
 
int exeHighPriorityPostActions (METHOD_message_t *msg,...) const
 
int exePostActions (METHOD_message_t *msg,...) const
 
int exePreActions (METHOD_message_t *msg,...) const
 
int exePreConditions (METHOD_message_t *msg,...) const
 
extn_fn getBaseAction () const
 
EXTENSIONFRAMEWORK_extension_category_t getBaseActionCategory () const
 
ExtensionSet * getBaseActionSet () const
 
std::string getBOName () const
 
bool getIsObjectBasedBaseActionMergedToSetBased () const
 
bool getOarEnabled () const
 
int getOpIdInt () const
 
ExtensionFunctionSet * getPostActionExtensionFunctions () const
 
ExtensionSet * getPostActionSet () const
 
int getPostActionUserArgPosition (TC_argument_list_t *user_arg_to_compare, METHOD_user_arg_compare_t compareFunc, int *positionFound)
 
ExtensionFunctionSet * getPreActionExtensionFunctions () const
 
ExtensionSet * getPreActionSet () const
 
int getPreActionUserArgPosition (TC_argument_list_t *user_arg_to_compare, METHOD_user_arg_compare_t compareFunc, int *positionFound)
 
ExtensionFunctionSet * getPreConditionExtensionFunctions () const
 
ExtensionSet * getPreConditionSet () const
 
int getPreConditionUserArgPosition (TC_argument_list_t *user_arg_to_compare, METHOD_user_arg_compare_t compareFunc, int *positionFound)
 
void getSizeOfPostActions (int *size) const
 
void getSizeOfPreActions (int *size) const
 
void getSizeOfPreConditions (int *size) const
 
bool hasPreOrPostAction () const
 
bool isOperation () const
 
bool isPropagateInheritedDone () const
 
bool isSetBased () const
 
int movePostAction (int oldPosition, int newPosition)
 
int movePreAction (int oldPosition, int newPosition)
 
int movePreCondition (int oldPosition, int newPosition)
 
 OperationDispatcher ()
 
void propagatedInheritedDone (bool done)
 
void propagateInherited (OperationDispatcher *parentOpDispatcher)
 
void propagateInherited2 (OperationDispatcher *sourceOpDispatcher, EXTENSIONFRAMEWORK_operation_extn_propagation_context_t opPropagationContext=DEFAULT_PROPAGATION)
 
void propagateInherited3 (OperationDispatcher *sourceOpDispatcher, EXTENSIONFRAMEWORK_operation_extn_propagation_context_t opPropagationContext=DEFAULT_PROPAGATION, bool baseActionMergeRequired=true)
 
int reattachExtensions (ImanTypeCache *imanType)
 
int reattachPostActionExtensions (OperationDispatcher *tarOpDispatcher)
 
int removePostActionAt (int position)
 
int removePreActionAt (int position)
 
int removePreConditionAt (int position)
 
FunctionInvoker * resetFunctionInvoker (Teamcenter::FunctionInvoker *functionInvokerObj)
 
bool sameBaseAction (const OperationDispatcher *dispatcher) const
 
void setAsSetBased (bool value)
 
void setBaseAction (METHOD_function_t baseActionFnPtr, TC_argument_list_t *baseActionUserArgs)
 
void setBaseActionCategory (EXTENSIONFRAMEWORK_extension_category_t extnCategory)
 
void setBaseActionFunctionInvokerRequired (bool functionInvokerRequired)
 
int setBMOperationName (const char *opName)
 
void setBMOperationtag (tag_t bmoptag)
 
void setBOName (const std::string &boName)
 
void setBulkOperationFuncPtr (BulkOperation_bulk_loader_t bulkOperationFuncPtr)
 
int setExtensionRefactoredAsSetBased (const std::string &extensionName, ExtensionPointType_t extensionType)
 
void setFunctionInvoker (Teamcenter::FunctionInvoker *functionInvokerObj)
 
void setMetaOperation (bool isMetaOperation)
 
virtual void setName (const std::string &)
 
void setOarEnabled (bool value)
 
void setOpIdInt (const int opIdInt)
 
int setPostExtensionToBeReattached (const std::string &extensionName)
 
virtual void setupMessageData (tag_t object_tag, METHOD_message_t &msgData) const
 
bool validateAutoDispatch () const
 
virtual ~OperationDispatcher ()
 

Static Public Member Functions

static int executeObjectBasedSuperBaseAction2 (tag_t objectType, const std::string &operationID, int &oprnInt, tag_t object,...)
 
static int executeSetBasedSuperBaseAction2 (const std::string &typeName, const std::string &operationID, int *pOprnInt,...)
 
static int executeUserExit (const char *typeName, const char *propName, const char *msgName, bool *customActionExecuted,...)
 
static int executeUserExit (const char *typeName, const char *propName, const char *msgName, va_list args)
 
static bool hasAction (const std::string &typeName, const std::string &operationName, ExtensionPointType_t extType)
 
static bool isExtensionValid (const std::string &typeName, const std::string &operationName, const std::string &extensionName, ExtensionPointType_t extType)
 
static int lookupUserExit (const char *typeName, const char *propName, const char *msgName, OperationDispatcher **opDispatcher)
 
static int reattachCreateToSavePostAction (ImanTypeCache *imanType, OperationDispatcher *srcOpDispatcher, const std::string &tarMsgName)
 

Public Attributes

extn_fn m_baseAction
 

Private Member Functions

ExtensionFunctionSet * createFunctionSetObject (ExtensionPointType_t extType)
 
bool isBaseActionExtensionsetEmpty () const
 

Static Private Member Functions

static int evaluateObjectBasedSuperNeedsToExecuteParentSetBasedBaseAction (tag_t objectType, const std::string &objectBasedOperationID, int &oprnInt, bool &oObjBasedSuperDelegToSetBasedParent, OperationDispatcher *&opParentOprnDisp)
 
static int evaluateParentBusinessObjectOverrideOperation (tag_t objectType, const std::string &operationID, int &oprnInt, EXTENSIONFRAMEWORK_extension_category_t opCategory, tag_t &parentWithOpOverriden, OperationDispatcher *&opParentOprnDisp)
 
static int executeSetBasedSuperBaseAction (const std::string &typeName, const std::string &operationID, int &oprnInt, va_list args)
 

Private Attributes

ExtensionSet * m_baseActionExtensionSet
 
tag_t m_bmoperationTag
 
std::string m_boName
 
BulkOperation_bulk_loader_t m_bulkOperationFuncPtr
 
FunctionInvoker * m_functionInvokerObj
 
bool m_isOperation
 
bool m_oarEnabled
 
char * m_operationName
 
int m_opIdInt
 
bool m_populateInheritedDone
 
ExtensionSet * m_postActionExtensionSet
 
ExtensionFunctionSet * m_postActionSet
 
ExtensionSet * m_preActionExtensionSet
 
ExtensionFunctionSet * m_preActionSet
 
ExtensionSet * m_preConditionExtensionSet
 
ExtensionFunctionSet * m_preConditionSet
 
bool m_setBased
 

Detailed Description

Definition at line 112 of file OperationDispatcher.hxx.

Member Typedef Documentation

typedef logical(* Teamcenter::OperationDispatcher::METHOD_user_arg_compare_t)(TC_argument_list_t *firstArg, TC_argument_list_t *secondArg)

Definition at line 206 of file OperationDispatcher.hxx.

Constructor & Destructor Documentation

Teamcenter::OperationDispatcher::OperationDispatcher ( )
virtual Teamcenter::OperationDispatcher::~OperationDispatcher ( )
virtual

Member Function Documentation

void Teamcenter::OperationDispatcher::addPostAction ( METHOD_function_t  fnPtr,
TC_argument_list_t *  userArgs,
bool  functionInvokerRequired = true,
bool  auto_dispatched = true 
)

The method to add post action extension to the legacy operation

void Teamcenter::OperationDispatcher::addPostAction2 ( METHOD_function_t  fnPtr,
TC_argument_list_t *  userArgs,
EXTENSIONFRAMEWORK_extension_category_t  extnCategory,
bool  functionInvokerRequired = true,
bool  auto_dispatched = true 
)

The method to add post action extension to the meta model operation

void Teamcenter::OperationDispatcher::addPostActionAt ( int  pos,
METHOD_function_t  fnPtr,
TC_argument_list_t *  userArgs 
)
void Teamcenter::OperationDispatcher::addPostActionInternal ( METHOD_function_t  fnPtr,
TC_argument_list_t *  userArgs,
bool  functionInvokerRequired = true,
bool  auto_dispatched = true 
)

The method to add high priority post action extension to the set based meta model operation

void Teamcenter::OperationDispatcher::addPreAction ( METHOD_function_t  fnPtr,
TC_argument_list_t *  userArgs,
bool  functionInvokerRequired = true 
)

The method to add pre action extension to the legacy operation

void Teamcenter::OperationDispatcher::addPreAction2 ( METHOD_function_t  fnPtr,
TC_argument_list_t *  userArgs,
EXTENSIONFRAMEWORK_extension_category_t  extnCategory,
bool  functionInvokerRequired = true 
)

The method to add pre action extension to the meta model operation

void Teamcenter::OperationDispatcher::addPreActionAt ( int  pos,
METHOD_function_t  fnPtr,
TC_argument_list_t *  userArgs 
)
void Teamcenter::OperationDispatcher::addPreCondition ( METHOD_function_t  fnPtr,
TC_argument_list_t *  userArgs,
bool  functionInvokerRequired = true 
)

The method to add pre condition extension to the legacy operation

void Teamcenter::OperationDispatcher::addPreCondition2 ( METHOD_function_t  fnPtr,
TC_argument_list_t *  userArgs,
EXTENSIONFRAMEWORK_extension_category_t  extnCategory,
bool  functionInvokerRequired = true 
)

The method to add pre condition extension to the meta model operation

void Teamcenter::OperationDispatcher::addPreConditionAt ( int  pos,
METHOD_function_t  fnPtr,
TC_argument_list_t *  userArgs 
)
int Teamcenter::OperationDispatcher::addRuntimeUserArguments ( const char *  extensionName,
ExtensionPointType_t  extType,
int  argCount,
const TC_argument_t *  args 
)
bool Teamcenter::OperationDispatcher::anyPostActions ( ) const
bool Teamcenter::OperationDispatcher::anyPreActions ( ) const
bool Teamcenter::OperationDispatcher::anyPreConditions ( ) const
const char* Teamcenter::OperationDispatcher::askBMOperationName ( ) const
void Teamcenter::OperationDispatcher::askBMOperationtag ( tag_t *  bmoptag) const
const BulkOperation_bulk_loader_t Teamcenter::OperationDispatcher::askBulkOperationFuncPtr ( ) const
bool Teamcenter::OperationDispatcher::baseFunctionExists ( ) const
void Teamcenter::OperationDispatcher::copyBaseFnDataFromExistingOperationDispatcher ( OperationDispatcher *  opDispatcher)

Used to copy base function data from existing operation dispatcher

void Teamcenter::OperationDispatcher::copyPreBasePostFromExistingOperationDispatcher ( OperationDispatcher *  opDispatcher)
ExtensionSet* Teamcenter::OperationDispatcher::createExtensionSetObject ( ExtensionPointType_t  extType)
ExtensionFunctionSet* Teamcenter::OperationDispatcher::createFunctionSetObject ( ExtensionPointType_t  extType)
private
void Teamcenter::OperationDispatcher::dumpFunction ( )

Dump function to display all member variables

static int Teamcenter::OperationDispatcher::evaluateObjectBasedSuperNeedsToExecuteParentSetBasedBaseAction ( tag_t  objectType,
const std::string &  objectBasedOperationID,
int &  oprnInt,
bool &  oObjBasedSuperDelegToSetBasedParent,
OperationDispatcher *&  opParentOprnDisp 
)
staticprivate

Determine if the object based super needs to execute set based base action at parent business object. It is meant for internal use only.

Parameters
objectType(I) The type.
objectBasedOperationID(I) The object based operation identifier.
oprnInt(IO) The operation identifier as an integer. It is meant for internal use only.
oObjBasedSuperDelegToSetBasedParent(O) Flag indicating if object based operation can be delegated to set based operation on the parent business object.
opParentOprnDisp(O) The evaluated operation dispatcher.
static int Teamcenter::OperationDispatcher::evaluateParentBusinessObjectOverrideOperation ( tag_t  objectType,
const std::string &  operationID,
int &  oprnInt,
EXTENSIONFRAMEWORK_extension_category_t  opCategory,
tag_t &  parentWithOpOverriden,
OperationDispatcher *&  opParentOprnDisp 
)
staticprivate

Retrieves the first parent in the type hierarchy that has a base action implementation different than the one present on input type. It is meant for internal use only.

Parameters
objectType(I) The type.
operationID(I) The object based operation identifier.
oprnInt(IO) The operation identifier as an integer. It is meant for internal use only.
opCategory(O) The extension category.
parentWithOpOverriden(O) The first parent type having a base action implementation different than the one present on the input type.
opParentOprnDisp(O) The evaluated operation dispatcher.
int Teamcenter::OperationDispatcher::exeBaseAction ( METHOD_message_t *  msg,
  ... 
) const
virtual void Teamcenter::OperationDispatcher::execute ( tag_t  object_tag,
va_list  args 
) const
virtual

Reimplemented in Teamcenter::getDisplayableValuesOperationDispatcher, Teamcenter::getCharArrayOperationDispatcher, Teamcenter::getLogicalArrayOperationDispatcher, Teamcenter::getTagArrayOperationDispatcher, Teamcenter::getCharOperationDispatcher, Teamcenter::getDateArrayOperationDispatcher, Teamcenter::getDateOperationDispatcher, Teamcenter::getDoubleArrayOperationDispatcher, Teamcenter::getDoubleOperationDispatcher, Teamcenter::getIntArrayOperationDispatcher, Teamcenter::getIntOperationDispatcher, Teamcenter::getLogicalOperationDispatcher, Teamcenter::getStringArrayOperationDispatcher, Teamcenter::getStringOperationDispatcher, Teamcenter::getTagOperationDispatcher, Teamcenter::setCharArrayOperationDispatcher, Teamcenter::setDoubleOperationDispatcher, Teamcenter::setStringOperationDispatcher, Teamcenter::setTagOperationDispatcher, Teamcenter::setCharOperationDispatcher, Teamcenter::setDateArrayOperationDispatcher, Teamcenter::setDateOperationDispatcher, Teamcenter::setDoubleArrayOperationDispatcher, Teamcenter::setIntArrayOperationDispatcher, Teamcenter::setIntOperationDispatcher, Teamcenter::setLogicalArrayOperationDispatcher, Teamcenter::setLogicalOperationDispatcher, Teamcenter::setStringArrayOperationDispatcher, and Teamcenter::setTagArrayOperationDispatcher.

virtual void Teamcenter::OperationDispatcher::execute ( Teamcenter::BusinessObject *  obj,
va_list  args 
) const
virtual

Reimplemented in Teamcenter::getDisplayableValuesOperationDispatcher, Teamcenter::getCharArrayOperationDispatcher, Teamcenter::getLogicalArrayOperationDispatcher, Teamcenter::getTagArrayOperationDispatcher, Teamcenter::getCharOperationDispatcher, Teamcenter::getDateArrayOperationDispatcher, Teamcenter::getDateOperationDispatcher, Teamcenter::getDoubleArrayOperationDispatcher, Teamcenter::getDoubleOperationDispatcher, Teamcenter::getIntArrayOperationDispatcher, Teamcenter::getIntOperationDispatcher, Teamcenter::getLogicalOperationDispatcher, Teamcenter::getStringArrayOperationDispatcher, Teamcenter::getStringOperationDispatcher, Teamcenter::getTagOperationDispatcher, Teamcenter::setCharArrayOperationDispatcher, Teamcenter::setDoubleOperationDispatcher, Teamcenter::setStringOperationDispatcher, Teamcenter::setTagOperationDispatcher, Teamcenter::setCharOperationDispatcher, Teamcenter::setDateArrayOperationDispatcher, Teamcenter::setDateOperationDispatcher, Teamcenter::setDoubleArrayOperationDispatcher, Teamcenter::setIntArrayOperationDispatcher, Teamcenter::setIntOperationDispatcher, Teamcenter::setLogicalArrayOperationDispatcher, Teamcenter::setLogicalOperationDispatcher, Teamcenter::setStringArrayOperationDispatcher, and Teamcenter::setTagArrayOperationDispatcher.

virtual void Teamcenter::OperationDispatcher::execute ( Teamcenter::BusinessObject *  obj,
std::vector< void * > &  args 
) const
virtual

Reimplemented in Teamcenter::getDisplayableValuesOperationDispatcher, Teamcenter::getCharArrayOperationDispatcher, Teamcenter::getLogicalArrayOperationDispatcher, Teamcenter::getTagArrayOperationDispatcher, Teamcenter::getCharOperationDispatcher, Teamcenter::getDateArrayOperationDispatcher, Teamcenter::getDateOperationDispatcher, Teamcenter::getDoubleArrayOperationDispatcher, Teamcenter::getDoubleOperationDispatcher, Teamcenter::getIntArrayOperationDispatcher, Teamcenter::getIntOperationDispatcher, Teamcenter::getLogicalOperationDispatcher, Teamcenter::getStringArrayOperationDispatcher, Teamcenter::getStringOperationDispatcher, Teamcenter::getTagOperationDispatcher, Teamcenter::setCharArrayOperationDispatcher, Teamcenter::setDoubleOperationDispatcher, Teamcenter::setStringOperationDispatcher, Teamcenter::setTagOperationDispatcher, Teamcenter::setCharOperationDispatcher, Teamcenter::setDateArrayOperationDispatcher, Teamcenter::setDateOperationDispatcher, Teamcenter::setDoubleArrayOperationDispatcher, Teamcenter::setIntArrayOperationDispatcher, Teamcenter::setIntOperationDispatcher, Teamcenter::setLogicalArrayOperationDispatcher, Teamcenter::setLogicalOperationDispatcher, Teamcenter::setStringArrayOperationDispatcher, and Teamcenter::setTagArrayOperationDispatcher.

virtual void Teamcenter::OperationDispatcher::executeBaseAction ( METHOD_message_t &  msg,
va_list  args,
bool  userExitBase = false 
) const
virtual

when overriding, never change the default arguments

virtual void Teamcenter::OperationDispatcher::executeBaseAction ( tag_t  object_tag,
va_list  args,
bool  userExitBase = false 
) const
virtual

when overriding, never change the default arguments

virtual void Teamcenter::OperationDispatcher::executeBaseAction ( Teamcenter::BusinessObject *  obj,
va_list  args 
) const
virtual
int Teamcenter::OperationDispatcher::executeBaseAction2 ( METHOD_message_t &  msg,
va_list  args 
) const

Executes set based base action with object based input. Function invoker adapts object based input to the set based input

void Teamcenter::OperationDispatcher::executeHighPriorityPostActions ( METHOD_message_t &  msg,
va_list  args 
) const
static int Teamcenter::OperationDispatcher::executeObjectBasedSuperBaseAction2 ( tag_t  objectType,
const std::string &  operationID,
int &  oprnInt,
tag_t  object,
  ... 
)
static

Executes the base action during a super call for an object based operation based on dynamic lookup. This is used in auto code generation. It is meant for internal use only.

Parameters
objectType(I) The type.
operationID(I) The operation identifier.
oprnInt(IO) The operation identifier as an integer. It is meant for internal use only.
object(I) The object.
virtual void Teamcenter::OperationDispatcher::executePostActions ( METHOD_message_t &  msg,
va_list  args 
) const
virtual

Reimplemented in Teamcenter::setStringOperationDispatcher, Teamcenter::getCharArrayOperationDispatcher, Teamcenter::getCharOperationDispatcher, Teamcenter::getDateArrayOperationDispatcher, Teamcenter::getDateOperationDispatcher, Teamcenter::getDisplayableValuesOperationDispatcher, Teamcenter::getDoubleArrayOperationDispatcher, Teamcenter::getDoubleOperationDispatcher, Teamcenter::getIntArrayOperationDispatcher, Teamcenter::getIntOperationDispatcher, Teamcenter::getLogicalArrayOperationDispatcher, Teamcenter::getLogicalOperationDispatcher, Teamcenter::getStringArrayOperationDispatcher, Teamcenter::getStringOperationDispatcher, Teamcenter::getTagArrayOperationDispatcher, Teamcenter::getTagOperationDispatcher, Teamcenter::setCharArrayOperationDispatcher, Teamcenter::setCharOperationDispatcher, Teamcenter::setDateArrayOperationDispatcher, Teamcenter::setDateOperationDispatcher, Teamcenter::setDoubleArrayOperationDispatcher, Teamcenter::setDoubleOperationDispatcher, Teamcenter::setIntArrayOperationDispatcher, Teamcenter::setIntOperationDispatcher, Teamcenter::setLogicalArrayOperationDispatcher, Teamcenter::setLogicalOperationDispatcher, Teamcenter::setStringArrayOperationDispatcher, Teamcenter::setTagArrayOperationDispatcher, and Teamcenter::setTagOperationDispatcher.

virtual void Teamcenter::OperationDispatcher::executePostActions ( tag_t  object_tag,
va_list  args 
) const
virtual
virtual void Teamcenter::OperationDispatcher::executePostActions ( Teamcenter::BusinessObject *  obj,
va_list  args 
) const
virtual
virtual void Teamcenter::OperationDispatcher::executePreActions ( METHOD_message_t &  msg,
va_list  args 
) const
virtual

Reimplemented in Teamcenter::setStringOperationDispatcher, Teamcenter::getCharArrayOperationDispatcher, Teamcenter::getCharOperationDispatcher, Teamcenter::getDateArrayOperationDispatcher, Teamcenter::getDateOperationDispatcher, Teamcenter::getDisplayableValuesOperationDispatcher, Teamcenter::getDoubleArrayOperationDispatcher, Teamcenter::getDoubleOperationDispatcher, Teamcenter::getIntArrayOperationDispatcher, Teamcenter::getIntOperationDispatcher, Teamcenter::getLogicalArrayOperationDispatcher, Teamcenter::getLogicalOperationDispatcher, Teamcenter::getStringArrayOperationDispatcher, Teamcenter::getStringOperationDispatcher, Teamcenter::getTagArrayOperationDispatcher, Teamcenter::getTagOperationDispatcher, Teamcenter::setCharArrayOperationDispatcher, Teamcenter::setCharOperationDispatcher, Teamcenter::setDateArrayOperationDispatcher, Teamcenter::setDateOperationDispatcher, Teamcenter::setDoubleArrayOperationDispatcher, Teamcenter::setDoubleOperationDispatcher, Teamcenter::setIntArrayOperationDispatcher, Teamcenter::setIntOperationDispatcher, Teamcenter::setLogicalArrayOperationDispatcher, Teamcenter::setLogicalOperationDispatcher, Teamcenter::setStringArrayOperationDispatcher, Teamcenter::setTagArrayOperationDispatcher, and Teamcenter::setTagOperationDispatcher.

virtual void Teamcenter::OperationDispatcher::executePreActions ( tag_t  object_tag,
va_list  args 
) const
virtual
virtual void Teamcenter::OperationDispatcher::executePreActions ( Teamcenter::BusinessObject *  obj,
va_list  args 
) const
virtual
virtual void Teamcenter::OperationDispatcher::executePreConditions ( METHOD_message_t &  msg,
va_list  args 
) const
virtual

overridable methods

Reimplemented in Teamcenter::setStringOperationDispatcher, Teamcenter::getCharArrayOperationDispatcher, Teamcenter::getCharOperationDispatcher, Teamcenter::getDateArrayOperationDispatcher, Teamcenter::getDateOperationDispatcher, Teamcenter::getDisplayableValuesOperationDispatcher, Teamcenter::getDoubleArrayOperationDispatcher, Teamcenter::getDoubleOperationDispatcher, Teamcenter::getIntArrayOperationDispatcher, Teamcenter::getIntOperationDispatcher, Teamcenter::getLogicalArrayOperationDispatcher, Teamcenter::getLogicalOperationDispatcher, Teamcenter::getStringArrayOperationDispatcher, Teamcenter::getStringOperationDispatcher, Teamcenter::getTagArrayOperationDispatcher, Teamcenter::getTagOperationDispatcher, Teamcenter::setCharArrayOperationDispatcher, Teamcenter::setCharOperationDispatcher, Teamcenter::setDateArrayOperationDispatcher, Teamcenter::setDateOperationDispatcher, Teamcenter::setDoubleArrayOperationDispatcher, Teamcenter::setDoubleOperationDispatcher, Teamcenter::setIntArrayOperationDispatcher, Teamcenter::setIntOperationDispatcher, Teamcenter::setLogicalArrayOperationDispatcher, Teamcenter::setLogicalOperationDispatcher, Teamcenter::setStringArrayOperationDispatcher, Teamcenter::setTagArrayOperationDispatcher, and Teamcenter::setTagOperationDispatcher.

virtual void Teamcenter::OperationDispatcher::executePreConditions ( tag_t  object_tag,
va_list  args 
) const
virtual
virtual void Teamcenter::OperationDispatcher::executePreConditions ( Teamcenter::BusinessObject *  obj,
va_list  args 
) const
virtual

BusinessObject related methods

static int Teamcenter::OperationDispatcher::executeSetBasedSuperBaseAction ( const std::string &  typeName,
const std::string &  operationID,
int &  oprnInt,
va_list  args 
)
staticprivate

Executes the base action during a super call for a set based operation based on dynamic lookup. It is meant for internal use only.

Parameters
typeName(I) The type name.
operationID(I) The operation identifier.
oprnInt(IO) The operation identifier as an integer. It is meant for internal use only.
args(I) The variable argument list for the operation. It is meant for internal use only.
static int Teamcenter::OperationDispatcher::executeSetBasedSuperBaseAction2 ( const std::string &  typeName,
const std::string &  operationID,
int *  pOprnInt,
  ... 
)
static

Executes the base action during a super call for a set based operation based on dynamic lookup. This is used in auto code generation. It is meant for internal use only.

Parameters
typeName(I) The type name.
operationID(I) The operation identifier.
pOprnInt(IO) The operation identifier as a pointer to an integer. It is meant for internal use only.
static int Teamcenter::OperationDispatcher::executeUserExit ( const char *  typeName,
const char *  propName,
const char *  msgName,
bool *  customActionExecuted,
  ... 
)
static
static int Teamcenter::OperationDispatcher::executeUserExit ( const char *  typeName,
const char *  propName,
const char *  msgName,
va_list  args 
)
static
int Teamcenter::OperationDispatcher::exeHighPriorityPostActions ( METHOD_message_t *  msg,
  ... 
) const
int Teamcenter::OperationDispatcher::exePostActions ( METHOD_message_t *  msg,
  ... 
) const
int Teamcenter::OperationDispatcher::exePreActions ( METHOD_message_t *  msg,
  ... 
) const
int Teamcenter::OperationDispatcher::exePreConditions ( METHOD_message_t *  msg,
  ... 
) const

Project 011450 changes

extn_fn Teamcenter::OperationDispatcher::getBaseAction ( ) const

get base action

EXTENSIONFRAMEWORK_extension_category_t Teamcenter::OperationDispatcher::getBaseActionCategory ( ) const
ExtensionSet* Teamcenter::OperationDispatcher::getBaseActionSet ( ) const
std::string Teamcenter::OperationDispatcher::getBOName ( ) const
inline

Definition at line 203 of file OperationDispatcher.hxx.

bool Teamcenter::OperationDispatcher::getIsObjectBasedBaseActionMergedToSetBased ( ) const

This method would return true if the set based operation dispatcher contains object based base action after merge of extensions

bool Teamcenter::OperationDispatcher::getOarEnabled ( ) const

Returns the flag indicating access check is required before the operation named on this dispatcher is executed

int Teamcenter::OperationDispatcher::getOpIdInt ( ) const
inline

Definition at line 205 of file OperationDispatcher.hxx.

ExtensionFunctionSet* Teamcenter::OperationDispatcher::getPostActionExtensionFunctions ( ) const
ExtensionSet* Teamcenter::OperationDispatcher::getPostActionSet ( ) const
int Teamcenter::OperationDispatcher::getPostActionUserArgPosition ( TC_argument_list_t *  user_arg_to_compare,
METHOD_user_arg_compare_t  compareFunc,
int *  positionFound 
)
ExtensionFunctionSet* Teamcenter::OperationDispatcher::getPreActionExtensionFunctions ( ) const
ExtensionSet* Teamcenter::OperationDispatcher::getPreActionSet ( ) const
int Teamcenter::OperationDispatcher::getPreActionUserArgPosition ( TC_argument_list_t *  user_arg_to_compare,
METHOD_user_arg_compare_t  compareFunc,
int *  positionFound 
)
ExtensionFunctionSet* Teamcenter::OperationDispatcher::getPreConditionExtensionFunctions ( ) const
ExtensionSet* Teamcenter::OperationDispatcher::getPreConditionSet ( ) const

These methods would be helpfull to verify the extension attribute

int Teamcenter::OperationDispatcher::getPreConditionUserArgPosition ( TC_argument_list_t *  user_arg_to_compare,
METHOD_user_arg_compare_t  compareFunc,
int *  positionFound 
)
void Teamcenter::OperationDispatcher::getSizeOfPostActions ( int *  size) const
void Teamcenter::OperationDispatcher::getSizeOfPreActions ( int *  size) const
void Teamcenter::OperationDispatcher::getSizeOfPreConditions ( int *  size) const
static bool Teamcenter::OperationDispatcher::hasAction ( const std::string &  typeName,
const std::string &  operationName,
ExtensionPointType_t  extType 
)
static
bool Teamcenter::OperationDispatcher::hasPreOrPostAction ( ) const
bool Teamcenter::OperationDispatcher::isBaseActionExtensionsetEmpty ( ) const
private
static bool Teamcenter::OperationDispatcher::isExtensionValid ( const std::string &  typeName,
const std::string &  operationName,
const std::string &  extensionName,
ExtensionPointType_t  extType 
)
static
bool Teamcenter::OperationDispatcher::isOperation ( ) const
inline

Definition at line 186 of file OperationDispatcher.hxx.

bool Teamcenter::OperationDispatcher::isPropagateInheritedDone ( ) const
inline

Definition at line 157 of file OperationDispatcher.hxx.

bool Teamcenter::OperationDispatcher::isSetBased ( ) const

Returns the flag indicating the operation named on this dispatcher is set based.

static int Teamcenter::OperationDispatcher::lookupUserExit ( const char *  typeName,
const char *  propName,
const char *  msgName,
OperationDispatcher **  opDispatcher 
)
static
int Teamcenter::OperationDispatcher::movePostAction ( int  oldPosition,
int  newPosition 
)
int Teamcenter::OperationDispatcher::movePreAction ( int  oldPosition,
int  newPosition 
)
int Teamcenter::OperationDispatcher::movePreCondition ( int  oldPosition,
int  newPosition 
)
void Teamcenter::OperationDispatcher::propagatedInheritedDone ( bool  done)
inline

Definition at line 158 of file OperationDispatcher.hxx.

void Teamcenter::OperationDispatcher::propagateInherited ( OperationDispatcher *  parentOpDispatcher)
void Teamcenter::OperationDispatcher::propagateInherited2 ( OperationDispatcher *  sourceOpDispatcher,
EXTENSIONFRAMEWORK_operation_extn_propagation_context_t  opPropagationContext = DEFAULT_PROPAGATION 
)
void Teamcenter::OperationDispatcher::propagateInherited3 ( OperationDispatcher *  sourceOpDispatcher,
EXTENSIONFRAMEWORK_operation_extn_propagation_context_t  opPropagationContext = DEFAULT_PROPAGATION,
bool  baseActionMergeRequired = true 
)
static int Teamcenter::OperationDispatcher::reattachCreateToSavePostAction ( ImanTypeCache *  imanType,
OperationDispatcher *  srcOpDispatcher,
const std::string &  tarMsgName 
)
static
int Teamcenter::OperationDispatcher::reattachExtensions ( ImanTypeCache *  imanType)
int Teamcenter::OperationDispatcher::reattachPostActionExtensions ( OperationDispatcher *  tarOpDispatcher)
int Teamcenter::OperationDispatcher::removePostActionAt ( int  position)
int Teamcenter::OperationDispatcher::removePreActionAt ( int  position)
int Teamcenter::OperationDispatcher::removePreConditionAt ( int  position)
FunctionInvoker* Teamcenter::OperationDispatcher::resetFunctionInvoker ( Teamcenter::FunctionInvoker *  functionInvokerObj)
bool Teamcenter::OperationDispatcher::sameBaseAction ( const OperationDispatcher *  dispatcher) const

check if the base action of an operation dispatcher is the same as this'

void Teamcenter::OperationDispatcher::setAsSetBased ( bool  value)

Sets a flag indicating the operation named on this dispatcher is set based.

void Teamcenter::OperationDispatcher::setBaseAction ( METHOD_function_t  baseActionFnPtr,
TC_argument_list_t *  baseActionUserArgs 
)
void Teamcenter::OperationDispatcher::setBaseActionCategory ( EXTENSIONFRAMEWORK_extension_category_t  extnCategory)
void Teamcenter::OperationDispatcher::setBaseActionFunctionInvokerRequired ( bool  functionInvokerRequired)
int Teamcenter::OperationDispatcher::setBMOperationName ( const char *  opName)
void Teamcenter::OperationDispatcher::setBMOperationtag ( tag_t  bmoptag)

bmf related methods

void Teamcenter::OperationDispatcher::setBOName ( const std::string &  boName)
void Teamcenter::OperationDispatcher::setBulkOperationFuncPtr ( BulkOperation_bulk_loader_t  bulkOperationFuncPtr)
int Teamcenter::OperationDispatcher::setExtensionRefactoredAsSetBased ( const std::string &  extensionName,
ExtensionPointType_t  extensionType 
)

Set the specified extension refactored as set based. The refactored object based or message based extension would not be merged to the set based dispatcher. If the specified extension is a set based extension, then the same would not be merged to the object based dispatcher.

void Teamcenter::OperationDispatcher::setFunctionInvoker ( Teamcenter::FunctionInvoker *  functionInvokerObj)

function invoker related stuff

void Teamcenter::OperationDispatcher::setMetaOperation ( bool  isMetaOperation)

meta operation related stuff

virtual void Teamcenter::OperationDispatcher::setName ( const std::string &  )
virtual

Reimplemented in Teamcenter::PropOperationDispatcher.

void Teamcenter::OperationDispatcher::setOarEnabled ( bool  value)

Sets a flag to require access check before the operation named on this dispatcher is executed.

void Teamcenter::OperationDispatcher::setOpIdInt ( const int  opIdInt)
int Teamcenter::OperationDispatcher::setPostExtensionToBeReattached ( const std::string &  extensionName)
virtual void Teamcenter::OperationDispatcher::setupMessageData ( tag_t  object_tag,
METHOD_message_t &  msgData 
) const
virtual

Reimplemented in Teamcenter::PropOperationDispatcher.

bool Teamcenter::OperationDispatcher::validateAutoDispatch ( ) const

Member Data Documentation

extn_fn Teamcenter::OperationDispatcher::m_baseAction

Definition at line 360 of file OperationDispatcher.hxx.

ExtensionSet* Teamcenter::OperationDispatcher::m_baseActionExtensionSet
private

Definition at line 430 of file OperationDispatcher.hxx.

tag_t Teamcenter::OperationDispatcher::m_bmoperationTag
private

bmf operation for now

Definition at line 439 of file OperationDispatcher.hxx.

std::string Teamcenter::OperationDispatcher::m_boName
private

Definition at line 442 of file OperationDispatcher.hxx.

BulkOperation_bulk_loader_t Teamcenter::OperationDispatcher::m_bulkOperationFuncPtr
private

Definition at line 447 of file OperationDispatcher.hxx.

FunctionInvoker* Teamcenter::OperationDispatcher::m_functionInvokerObj
private

Definition at line 440 of file OperationDispatcher.hxx.

bool Teamcenter::OperationDispatcher::m_isOperation
private

Definition at line 433 of file OperationDispatcher.hxx.

bool Teamcenter::OperationDispatcher::m_oarEnabled
private

Definition at line 443 of file OperationDispatcher.hxx.

char* Teamcenter::OperationDispatcher::m_operationName
private

Definition at line 446 of file OperationDispatcher.hxx.

int Teamcenter::OperationDispatcher::m_opIdInt
private

Definition at line 445 of file OperationDispatcher.hxx.

bool Teamcenter::OperationDispatcher::m_populateInheritedDone
private

Definition at line 434 of file OperationDispatcher.hxx.

ExtensionSet* Teamcenter::OperationDispatcher::m_postActionExtensionSet
private

Definition at line 431 of file OperationDispatcher.hxx.

ExtensionFunctionSet* Teamcenter::OperationDispatcher::m_postActionSet
private

Definition at line 427 of file OperationDispatcher.hxx.

ExtensionSet* Teamcenter::OperationDispatcher::m_preActionExtensionSet
private

Definition at line 429 of file OperationDispatcher.hxx.

ExtensionFunctionSet* Teamcenter::OperationDispatcher::m_preActionSet
private

Definition at line 426 of file OperationDispatcher.hxx.

ExtensionSet* Teamcenter::OperationDispatcher::m_preConditionExtensionSet
private

Definition at line 428 of file OperationDispatcher.hxx.

ExtensionFunctionSet* Teamcenter::OperationDispatcher::m_preConditionSet
private

Definition at line 425 of file OperationDispatcher.hxx.

bool Teamcenter::OperationDispatcher::m_setBased
private

Definition at line 444 of file OperationDispatcher.hxx.

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