KnowledgeInterfaces CATInstanciationContext
Usage: you must use this class as is. You should never derive it.
public class CATInstanciationContext
Class dedicated to instanciation management.
Role: When instanciating an object through CATIDelegateInstanciation, this class is used to pass some arguments.
- See also:
- , ,
Constructor and Destructor Index
- o
CATInstanciationContext(CATCkeListOfParm,CATICkeObject_var&,CATBoolean,CATLISTV(CATICkeObject_var)*)
- Constructor.
- o
~CATInstanciationContext()
- Destructor.
Method Index
- o
LongTransaction()
- Indicates if we require a short/long transaction creation for PLM objects.
- o
PrefixToUseForParametersAddedOnProxy()
- Returns a prefix used to add parameter on a proxy in order to avoid conflicts
- o
RetrieveAdditionalProxies(CATLISTV(CATICkeObject_var)&)
- Retrieving additional proxies if any.
- o
RetrieveArgument(int,CATUnicodeString&,CATIValue_var&)
- Retrieves the additional arguments to be passed to the implementation.
- o
RetrieveArguments()
- Retrieves the list of parameters passed as argument of the new.
- o
RetrieveContainer()
- Retrieves the container where the object has been created.
- o
RetrieveProxy()
- Retrieves the proxy that must be used to copy attributes.
- o
RetrieveReferenceToInsert()
- Retrieves the reference (or representation) to instanciate if any.
- o
SetContainer(CATICkeParmFactory_var&)
- Useless in CAA.
- o
StringInfo()
- Useless in CAA.
Constructor and Destructor
o CATInstanciationContext
| public CATInstanciationContext( | const | plist | = NULL, |
| const | iProxy | =NULL_var, |
| const | iLongTransaction | = TRUE, |
| const | ipAdditionalProxies | = NULL) |
-
Constructor.
- Parameters:
-
- plist
- list of parameters (potentially passed by the new function in EKL.
- ipAdditionalProxies
- list of additional proxies passed by the PLM New. Usually NULL. Additional proxies...
o ~CATInstanciationContext
| public virtual ~CATInstanciationContext( | ) |
-
Destructor.
Methods
o LongTransaction
| public virtual LongTransaction( | ) |
-
Indicates if we require a short/long transaction creation for PLM objects.
- Returns:
- TRUE if long transaction
o PrefixToUseForParametersAddedOnProxy
| public static PrefixToUseForParametersAddedOnProxy( | ) |
-
Returns a prefix used to add parameter on a proxy in order to avoid conflicts
o RetrieveAdditionalProxies
| public RetrieveAdditionalProxies( | | iListToBeFilled) |
-
Retrieving additional proxies if any.
- Parameters:
-
- iListToBeFilled
- List to be filled with proxies
o RetrieveArgument
| public RetrieveArgument( | const | iRank, |
| const | iName, |
| | oValue) |
-
Retrieves the additional arguments to be passed to the implementation.
Must pass a rank (1 to N) AND a Name (in any case).
When called from the Knowledge language, the rank correspond to the additional arguments (in reality from 4 to N)
When called from the PLM New UI, the name is used and it correspond to the name of the parameter added to the proxy.
- Parameters:
-
- iRank
- Rank of the argument in the Knowledge language function
- iName
- Name of the parameter on the proxy
- oValue
- Value found
- Returns:
-
- E_INVALIDARG if called without rank in Knowledge language context, or without name in PLM New context.
- S_FALSE if the argument has not been found
- S_OK if the argument has been found
o RetrieveArguments
| public RetrieveArguments( | ) |
-
Retrieves the list of parameters passed as argument of the new.
Note that for performance purpose, the arguments starts at rank 4 if any
- Returns:
- liste of arguments
o RetrieveContainer
| public RetrieveContainer( | ) |
-
Retrieves the container where the object has been created.
- Returns:
- current container retrieved
o RetrieveProxy
-
Retrieves the proxy that must be used to copy attributes.
Can be NULL when called from the Knowledge language.
Is not NULL when called from the PLM New UI. In this case, it contains a proxy.
- Returns:
- proxy
o RetrieveReferenceToInsert
| public RetrieveReferenceToInsert( | ) |
-
Retrieves the reference (or representation) to instanciate if any.
Can be NULL
- Returns:
- proxy
o SetContainer
| public SetContainer( | const | iCont) |
-
Useless in CAA.
Positions the container where the object is created.
- Parameters:
-
- iCont
- becomes the current container
o StringInfo
| public virtual StringInfo( | ) |
-
Useless in CAA.
Returns a string information.
- Returns:
- parameters converted as a string
This object is included in the file: CATInstanciationContext.h
If needed, your Imakefile.mk should include the module: KnowledgeItf
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.