All Categories  Class Hierarchy  This Category  Previous  Next  Indexes

ActionFlow Class CATVpmUsrActionObject

CATVpmUsrActionObject

public class CATVpmUsrActionObject

Constructor and Destructor Index

o CATVpmUsrActionObject(): Creates an action affected object The affected objects are VPM objects, such as parts, clashes, models, documents, instances and features.
o CATVpmUsrActionObject(CATVpmUsrActionObject&): Copies the action affected object
o ~CATVpmUsrActionObject()

Method Index

o GetCOID(): Gets the COID of the action affected object
o GetCOMPID(): Gets the COMPID of the action affected object
o GetCaenv(): Gets the environment of the action affected object
o GetCatab(): Gets the table of the action affected object
o GetDescription(): Gets the description of the action affected object
o GetFlow(): Gets the flow of the action affected object
o GetName(): Gets the name of the action affected object
o GetOIDR(): Gets the OIDR of the action affected object The OIDR identifies the object within the action
o GetType(): Gets the type of the action affected object
o SetCOID(CATUnicodeString&): Sets the COID of the action affected object
o SetCOMPID(CATUnicodeString&): Sets the COMPID of the action affected object
o SetCaenv(CATUnicodeString&): Sets the environment of the action affected object
o SetCatab(CATUnicodeString&): Sets the table of the action affected object
o SetDescription(CATUnicodeString&): Sets the description of the action affected object
o SetFlow(char): Sets the flow of the action affected object param iFlow 'I' (input) or 'O' (output)
o SetName(CATUnicodeString&): Sets the name of the action affected object

Constructor and Destructor

o CATVpmUsrActionObject

public CATVpmUsrActionObject(

)

Creates an action affected object The affected objects are VPM objects, such as parts, clashes, models, documents, instances and features.

o CATVpmUsrActionObject

public CATVpmUsrActionObject( const CATVpmUsrActionObject& iObj)

Copies the action affected object

Parameters:

iObj: object to copy

o ~CATVpmUsrActionObject

public ~CATVpmUsrActionObject(

)

Methods

o GetCOID

public CATUnicodeString GetCOID(

)

Gets the COID of the action affected object

Returns:: The COID of the object

o GetCOMPID

public CATUnicodeString GetCOMPID(

)

Gets the COMPID of the action affected object

Returns:: The COMPID of the object

o GetCaenv

public CATUnicodeString GetCaenv(

)

Gets the environment of the action affected object

Returns:: The environment of the object

o GetCatab

public CATUnicodeString GetCatab(

)

Gets the table of the action affected object

Returns:: The table of the object

o GetDescription

public CATUnicodeString GetDescription(

)

Gets the description of the action affected object

Returns:: The description of the object

o GetFlow

public char GetFlow(

)

Gets the flow of the action affected object

Returns:: 'I' (input) or 'O' (output)

o GetName

public CATUnicodeString GetName(

)

Gets the name of the action affected object

Returns:: The name of the object

o GetOIDR

public CATUnicodeString GetOIDR(

)

Gets the OIDR of the action affected object The OIDR identifies the object within the action

Returns:: The OIDR of the object

o GetType

public CATUnicodeString GetType(

)

Gets the type of the action affected object

Returns:: The type of the action affected object (see CATVpmActionObjectTypes)

o SetCOID

public void SetCOID( const CATUnicodeString& iCOID)

Sets the COID of the action affected object

Parameters:

iCOID: The COID of the action affected object

o SetCOMPID

public void SetCOMPID( const CATUnicodeString& iCOMPID)

Sets the COMPID of the action affected object

Parameters:

iCOMPID: The COMPID of the action affected object

o SetCaenv

public void SetCaenv( const CATUnicodeString& iCaenv)

Sets the environment of the action affected object

Parameters:

iCaenv: The environment of the action affected object

o SetCatab

public void SetCatab( const CATUnicodeString& iCatab)

Sets the table of the action affected object

Parameters:

iCatab: The table of the action affected object

o SetDescription

public void SetDescription( const CATUnicodeString& iDesc)

Sets the description of the action affected object

Parameters:

iDescription: The description of the action affected object

o SetFlow

public void SetFlow( const char iFlow)

Sets the flow of the action affected object param iFlow 'I' (input) or 'O' (output)

o SetName

public void SetName( const CATUnicodeString& iName)

Sets the name of the action affected object

Parameters:

iName: The name of the action affected object, for the 'import copy' files, otherwise it is automaticaly generated

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