All Frameworks Class Hierarchy This Framework Previous Next Indexes
ElecHarnessItf Interface CATIEhiMultiBranchable
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIEhiMultiBranchable
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEhiMultiBranchable
Interface to manage Multi Branchable .
Role:A Multi Branchable is a group of Branchable.
Method Index
- o
AddBranchable(CATIEhiBranchable**)
-
Adds a Branchable in a MultiBranchable.
- o
InstanciateProtectionFromReference(CATIProduct*,CATListValCATBaseUnknown_var*,double,double,CATIEhiProtection**)
- Instantiates a Protection from the given Internal Protection reference (CATProduct).
- o
ListBranchables(CATListValCATBaseUnknown_var**)
-
Lists Branchables of a Multi Branchable.
- o
ListBundleSegments(CATListValCATBaseUnknown_var**)
- Lists bundle segments of a Multi Branchable.
- o
ListProtections(CATListValCATBaseUnknown_var**)
- Lists all the Internal Protections instantiated in the MultiBranchable.
- o
RemoveBranchable(CATIEhiBranchable*,CATBoolean)
-
Removes a Branchable in a MultiBranchable.
- o
RemoveProtection(CATIEhiProtection*)
- Removes the given Internal Protection instance in MultiBranchable.
Methods
o AddBranchable
-
Adds a Branchable in a MultiBranchable.
- Parameters:
-
- opBranchable
- the Branchable created.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- Error.
o InstanciateProtectionFromReference
public virtual HRESULT InstanciateProtectionFromReference( | CATIProduct* | ipIInternalProtectionRefPrd, |
| CATListValCATBaseUnknown_var* | ipUnkListOfOrderedBundleSegments, |
| double | iDistanceA, |
| double | iDistanceB, |
| CATIEhiProtection** | opIEhiInternalProtectionInst) = 0 |
-
Instantiates a Protection from the given Internal Protection reference (CATProduct).
Internal Protecion Instance is created under Protection Body in MultiBranchable.
- Parameters:
-
- ipIInternalProtectionRefPrd
- Reference Product of Internal Protection to instanciate
- ipUnkListOfOrderedBundleSegments
- Ordered List of Bundle segments that needs to be covered
- iDistanceA
- Distance from the extremity of the first segment in ipUnkListOfOrderedBundleSegments
- iDistanceB
- Distance from the extremity of the last segment in ipUnkListOfOrderedBundleSegments
- opIEhiInternalProtectionInst
- Created Internal Protection Instance
- Returns:
- E_INVALIDARG if the input/output arguments are invalid
S_OK if the method succeeds
E_FAIL if the method fails
o ListBranchables
public virtual HRESULT ListBranchables( | CATListValCATBaseUnknown_var** | oListOfBranchables) = 0 |
-
Lists Branchables of a Multi Branchable.
- Parameters:
-
- oListOfBranchables
- List of Branchables
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error occured while searching bundle segments.
- E_FAIL
- Error.
o ListBundleSegments
public virtual HRESULT ListBundleSegments( | CATListValCATBaseUnknown_var** | oListOfBundleSegments)= 0 |
-
Lists bundle segments of a Multi Branchable.
- Parameters:
-
- oListOfBundleSegments
- List of bundle segments in multi-branchable
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error occured while searching bundle segments.
- E_FAIL
- Error.
o ListProtections
public virtual HRESULT ListProtections( | CATListValCATBaseUnknown_var** | opUnkListOfInternalProtInst) = 0 |
-
Lists all the Internal Protections instantiated in the MultiBranchable.
- Parameters:
-
- opUnkListOfInternalProtInst
- List of Internal Protection instances to be returned
- Returns:
- E_INVALIDARG if the output argument is invalid
S_OK if the method succeeds
E_FAIL if the method fails
o RemoveBranchable
-
Removes a Branchable in a MultiBranchable.
- Parameters:
-
- ipBranchable
- the Branchable removed.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- Error.
o RemoveProtection
-
Removes the given Internal Protection instance in MultiBranchable.
- Parameters:
-
- ipIEhiInternalProtectionInst
- Internal Protection instance to be removed
- Returns:
- E_INVALIDARG if the input argument is invalid
S_OK if the method succeeds
E_FAIL if the method fails
This object is included in the file: CATIEhiMultiBranchable.h
If needed, your Imakefile.mk should include the module: CATEhiInterfaces