All Frameworks Class Hierarchy This Framework Previous Indexes
CATOBMInterfaces Interface CATIVariableManagement
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIVariableManagement
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIVariableManagement
Interface to manage the variables of behaviors and Dynamic Types (Tecnological Objects).
The variables are defined by several properties :
- a name.
- a quality
: Input, output or neutral as defined via TCIO.
- a Knowledgeware Type describing the type of the variable
. In the following methods, it is refered as "VarType".
ex : Volume, Length, Pointer, List, ...
- a Knowledgeware Type for the pointed object by the variable
. In the following methods, it is refered as "PointedVarType"
This type is necessary only for the list and pointer variables. In that case, you can specify the Knowledware type of the objects pointed by the Pointer or stored in the List. The default value is "ObjectType" and it can be overloaded by using
SetVariableType.
For other variables, this notion is not used and "PointedVarType" should be set to NULL.
see
CATIType
Method Index
- o
GetLinkedVariable(CATUnicodeString*,TCIO,CATBaseUnknown**)
- Retrieves the variable or the feature pointed via the link.
- o
GetUserAccess(CATUnicodeString*,TCIO,CATIVariableManagement::UserAccessMode&)
- Retreives the user acces mode of a variable of a given quality.
- o
GetVariable(CATUnicodeString*,TCIO,CATBaseUnknown**)
- Retreives a variable of a given quality.
- o
GetVariableAccess(CATBaseUnknown*,CATUnicodeString&,TCIO&)
- Retreives the name and quality of a variable.
- o
GetVariableInfos(CATUnicodeString*,TCIO,CATIType**,CATIType**,CATIVariableManagement::UserAccessMode&,CATBoolean&)
- Retreives the characteristics of a variable of a given quality.
- o
GetVariableType(CATUnicodeString*,TCIO,CATIType**,CATIType**)
- Retreives the Knowledgeware type of the object pointed by a variable of a given quality.
- o
GetVariableValue(CATUnicodeString*,TCIO,CATIValue**)
- Retreives the value of a variable of a given quality.
- o
GetVariablesNames(TCIO,CATIType*,CATIType*,CATListOfCATUnicodeString**)
- Returns the variables names matching given criterion.
- o
IsLocalVariable(CATUnicodeString*,TCIO,CATBoolean&)
- Indicates if a variable of a given quality is local to this object.
- o
LinkVariables(CATUnicodeString*,TCIO,CATBaseUnknown*)
- Creates a link between two variables.
- o
SetVariableType(CATUnicodeString*,TCIO,CATIType*)
- Sets the expected knowledgeware type of the object pointed by a variable of a given quality.
- o
SetVariableValue(CATUnicodeString*,TCIO,CATIValue*)
- Valuates a variable of a given quality.
- o
Unset(CATUnicodeString*,TCIO)
- Unsets a variable.
Enumerated Type Index
- o
UserAccessMode
- Rights defined on a variable.
Methods
o GetLinkedVariable
-
Retrieves the variable or the feature pointed via the link.
- Parameters:
-
- iName
- Name of the pointing variable. Must belong to this object.
- iQuality
- Quality of variable.
- oVariable
- The variable or the feature linked with the one, of name iName, belonging to this behavior.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The method has been executed successfully.
- E_FAIL
- An error has been encountered during the execution of the method.
o GetUserAccess
public virtual HRESULT GetUserAccess( | const CATUnicodeString* | iName, |
| const TCIO | iQuality, |
| CATIVariableManagement::UserAccessMode& | oUserAccess)=0 |
-
Retreives the user acces mode of a variable of a given quality.
- Parameters:
-
- iName
- Name of the variable.
- iQuality
- Quality of the variable.
- oUserAccessMode
- User Access Mode of the variable
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The method has been executed successfully.
- E_FAIL
- An error has been encountered during the execution of the method.
o GetVariable
-
Retreives a variable of a given quality.
- Parameters:
-
- iName
- Name of the variable.
- iQuality
- Quality of the variable.
- oVariable
- The variable of the given name and quality found on the behavior. It can be a literal, a list or a pointer.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The method has been executed successfully.
- E_FAIL
- An error has been encountered during the execution of the method.
o GetVariableAccess
-
Retreives the name and quality of a variable.
- Parameters:
-
- iVariable
- Pointer to a variable
- oName
- Name of the variable
- oQuality
- Quality of the variable
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The method has been executed successfully.
- E_FAIL
- An error has been encountered during the execution of the method.
o GetVariableInfos
-
Retreives the characteristics of a variable of a given quality.
- Parameters:
-
- iName
- name of the variable.
- iQuality
- Quality of the required variable.
- oVarType
- Knowledgeware type of the retreived variable.
- oPointedVarType
- if any, Knowledgeware type of the object pointed by the variable.
- oUserAccessMode
- User Access Mode retreived.
- oIsLocal
- CATTrue if the variable iName is local.
CATFalse if not.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The method has been executed successfully.
- E_FAIL
- An error has been encountered during the execution of the method.
o GetVariableType
-
Retreives the Knowledgeware type of the object pointed by a variable of a given quality.
- Parameters:
-
- iName
- Name of the variable.
- iQuality
- Quality of the variable.
- oVarType
- Knowledgeware type of the retreived variable.
- oPointedVarType
- if any, Knowledgeware type of the object pointed by the variable.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The method has been executed successfully.
- E_FAIL
- An error has been encountered during the execution of the method.
o GetVariableValue
-
Retreives the value of a variable of a given quality.
- Parameters:
-
- iName
- Name of the variable.
- iQuality
- Quality of the required variable.
- oValue
- Value of the variable.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The method has been executed successfully.
- E_FAIL
- An error has been encountered during the execution of the method.
o GetVariablesNames
-
Returns the variables names matching given criterion.
- Parameters:
-
- iQuality
- Quality of the required variables
- iVarType
- Knowledgeware type of the required variables.
- iPointedVarType
- if any, Knowledgeware type of the object pointed by the variable
- oVariables
- List of variables names.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The method has been executed successfully.
- E_FAIL
- An error has been encountered during the execution of the method.
o IsLocalVariable
-
Indicates if a variable of a given quality is local to this object.
- Parameters:
-
- iName
- Name of the variable.
- iQuality
- Quality of the variable.
- oIsLocal
- CATTrue if the variable iName is local.
CATFalse if not.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The method has been executed successfully.
- E_FAIL
- An error has been encountered during the execution of the method.
o LinkVariables
-
Creates a link between two variables.
- Parameters:
-
- iName
- Name of the pointing variable. Must belong to this object.
- iQuality
- Quality of the variable.
- iVariable
- Pointed object. It can be another variable (literal, list or pointer) or a feature.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The method has been executed successfully.
- E_FAIL
- An error has been encountered during the execution of the method.
o SetVariableType
-
Sets the expected knowledgeware type of the object pointed by a variable of a given quality.
Relevant only for pointer and list variables. For other variables, the Knowledge type is set at creation
and cannot be changed afterwards.
- Parameters:
-
- iName
- Name of the variable.
- iQuality
- Quality of the variable.
- iType
- New knowledge type for the object pointed by the variable.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The method has been executed successfully.
- E_FAIL
- An error has been encountered during the execution of the method.
o SetVariableValue
-
Valuates a variable of a given quality.
- Parameters:
-
- iName
- Name of the variable.
- iQuality
- Quality of the variable.
- iValue
- New value for the variable.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The method has been executed successfully.
- E_FAIL
- An error has been encountered during the execution of the method.
o Unset
-
Unsets a variable.
- Parameters:
-
- iName
- Name of the variable to unset.
- iQuality
- Quality of the variable.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The method has been executed successfully.
- E_FAIL
- An error has been encountered during the execution of the method.
Enumerated Types
o UserAccessMode
-
enum UserAccessMode {
NotSeen,
ReadOnly,
ReadWrite
}
Rights defined on a variable.
Used to define how a parameter can be used through BKT.
- Parameters:
-
- NotSeen
- this parameter is not seen by the user.
- ReadOnly
- the parameter will be seen but won't be modified, may be used as input of a relation.
- ReadWrite
- Default value:the parameter can be modified, and used as output of a relation
This object is included in the file: CATIVariableManagement.h
If needed, your Imakefile.mk should include the module: CATOBMItf