All Frameworks Class Hierarchy This Framework Previous Next Indexes
BatchInfrastructure Interface CATIBatchElementCAA
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIBatchElementCAA
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIBatchElementCAA
Interface representing a node in a batch parameter XML file.
Role: to be used within your batch to retrieve the data contained in the parameters XML files.
You can get the interface using CATIBatchCAA interface.
This interface represents a node in the XML tree of your parameter file.It allows you to navigate in this tree and to retrieve a specific node
and its attributes value.
In the parameter file two kinds of node are allowed :
- The batch nodes, specific typed node designed to describe the most often used input/output of a batch.
- The custom nodes, nodes created by the batch conceptor to describe input/output which cannot be represented by a batch node.
In this interface some methods are batch node specifc. The other methods can be used for both kind of nodes.
- See also:
- CATIBatchCAA, CATIBatchElementsCAA
Method Index
- o
BoolArg(boolean&)
- Retrieves the value of the attribute "value" on a "simple_arg" node.
- o
BoolValue(CATUnicodeString&,boolean&)
- Retrieves a specific attibute's value on the current node.
- o
DoubleArg(double&)
- Retrieves the value of the attribute "value" on a "simple_arg" node.
- o
DoubleValue(CATUnicodeString&,double&)
- Retrieves a specific attibute's value on the current node.
- o
FloatArg(float&)
- Retrieves the value of the attribute "value" on a "simple_arg" node.
- o
FloatValue(CATUnicodeString&,float&)
- Retrieves a specific attibute's value on the current node.
- o
LongArg(long&)
- Retrieves the value of the attribute "value" on a "simple_arg" node.
- o
LongValue(CATUnicodeString&,long&)
- Retrieves a specific attibute's value on the current node.
- o
ParameterCAA(CATUnicodeString&,CATIBatchElementCAA*&)
- Retrieves a specific child of the current node.
- o
StringArg(CATUnicodeString&)
- Retrieves the value of the attribute "value" on a "simple_arg" node.
- o
StringValue(CATUnicodeString&,CATUnicodeString&)
- Retrieves a specific attibute's value on the current node.
- o
get_ChildrenCAA(CATIBatchElementsCAA*&)
- Retrieves an interface describing the children node list.
- o
get_FileListCAA(CATIBatchElementsCAA*&)
- Retrieves an interface describing the "file" children node list.
- o
get_FolderListCAA(CATIBatchElementsCAA*&)
- Retrieves an interface describing the "folder" children node list.
- o
get_ParentElementCAA(CATIBatchElementCAA*&)
- Retrieves an interface describing the father node.
- o
get_Path(CATUnicodeString&)
- Retrieves the path attribute value of a file or a folder node.
- o
get_TagName(CATUnicodeString&)
- Retrieves the name of the node.
Methods
o BoolArg
public virtual HRESULT BoolArg( | boolean& | oBool) = 0 |
-
Retrieves the value of the attribute "value" on a "simple_arg" node.
Role: The simple_arg node are designed to describe fondamentals types such as bool, float, double, string.
Use this "batch node" method to retrieve the attribute "value" on a "simple_arg" node if the value is a boolean
- Parameters:
-
- iId
- id of the child to be searched for
- oBool
- value to be retrieved
o BoolValue
-
Retrieves a specific attibute's value on the current node.
Role: This method allows you to retrieve the attribute's value of the current node given its name.
Use this "batch node" method to retrieve the attribute value is a boolean
- Parameters:
-
- iAttrName
- name of the attribute.
- oBool
- value to be retrieved
o DoubleArg
public virtual HRESULT DoubleArg( | double& | oDouble) = 0 |
-
Retrieves the value of the attribute "value" on a "simple_arg" node.
Role: See BoolArg method.
Use this "batch node" method to retrieve the attribute "value" on a "simple_arg" node if the value is a double
- Parameters:
-
- oDouble
- value to be retrieved
o DoubleValue
-
Retrieves a specific attibute's value on the current node.
Role: See BoolValue
Use this"batch node" method to retrieve the attribute value is a double
- Parameters:
-
- iAttrName
- name of the attribute.
- oDouble
- value to be retrieved
o FloatArg
public virtual HRESULT FloatArg( | float& | oFloat) = 0 |
-
Retrieves the value of the attribute "value" on a "simple_arg" node.
Role: See BoolArg method.
Use this "batch node" method to retrieve the attribute "value" on a "simple_arg" node if the value is a float
- Parameters:
-
- oFloat
- value to be retrieved
o FloatValue
-
Retrieves a specific attibute's value on the current node.
Role: See BoolValue
Use this "batch node" method to retrieve the attribute value is a float
- Parameters:
-
- iAttrName
- name of the attribute.
- oFloat
- value to be retrieved
o LongArg
public virtual HRESULT LongArg( | long& | oLong) = 0 |
-
Retrieves the value of the attribute "value" on a "simple_arg" node.
Role: See BoolArg method.
Use this "batch node" method to retrieve the attribute "value" on a "simple_arg" node if the value is a long
- Parameters:
-
- oLong
- value to be retrieved
o LongValue
-
Retrieves a specific attibute's value on the current node.
Role: See BoolValue
Use this "batch node" method to retrieve the attribute value is a long
- Parameters:
-
- iAttrName
- name of the attribute.
- oLong
- value to be retrieved
o ParameterCAA
-
Retrieves a specific child of the current node.
Role: This "batch node" method must be used on a file or a folder node.
Each "batch node" has an attribute called "id", tis method allows you to retrieve an interface on a child of the current node by givig its id.
- Parameters:
-
- iId
- id of the child to be searched for
- oParameter
- interface on this child to be retrieved
o StringArg
-
Retrieves the value of the attribute "value" on a "simple_arg" node.
Role: See BoolArg method.
Use this "batch node" method to retrieve the attribute "value" on a "simple_arg" node if the value is a string
- Parameters:
-
- oString
- value to be retrieved
o StringValue
-
Retrieves a specific attibute's value on the current node.
Role: See BoolValue
Use this "batch node" method to retrieve the attribute value is a string
- Parameters:
-
- iAttrName
- name of the attribute.
- oString
- value to be retrieved
o get_ChildrenCAA
-
Retrieves an interface describing the children node list.
Role: This method retrieves the children nodes of the node represented by this interface.
This is a navigation method.
- Parameters:
-
- oChildren
- interface to be retrieved
o get_FileListCAA
-
Retrieves an interface describing the "file" children node list.
Role: This "batch node" method retrieves all the "file nodes" of the node represented by this interface.
Under the node InputParameters or OuptutParameters you may have created file typed node to describe an input/output of this type.
This method allows you to retrieve an interface to this list of file nodes.
To be used on an InputParameters or an OuptutParameters node.
- Parameters:
-
- oFileList
- interface to be retrieved
o get_FolderListCAA
-
Retrieves an interface describing the "folder" children node list.
Role: This "batch node" method retrieves all the "folder" nodes of the node represented by this interface.
Under the node InputParameters or OuptutParameters you may have created folder typed node to describe an input/output of this type.
This method allows you to retrieve an interface to this list of folder nodes.
To be used on an InputParameters or an OuptutParameters node.
- Parameters:
-
- oFolderList
- interface to be retrieved
o get_ParentElementCAA
-
Retrieves an interface describing the father node.
Role: This method retrieves the father node. of the node represented by this interface.
This is a navigation method.
- Parameters:
-
- oParent
- interface to be retrieved
o get_Path
-
Retrieves the path attribute value of a file or a folder node.
Role: This "batch node" method must be used on a file or a folder node.
It gives the absolute path of the file or the folder described by the current node
- Parameters:
-
- oPath
- path to be retrieved
o get_TagName
-
Retrieves the name of the node.
Role: This method retrieves the name of the node represented by this interface.
- Parameters:
-
- oTagName
- name to be retrieved
This object is included in the file: CATIBatchElementCAA.h
If needed, your Imakefile.mk should include the module: CATIABatImpl