All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATCommonLayoutInterfaces Class CATEcwLightNwkCableForPercentFill
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATEcwLightNwkCableForPercentFill
Usage: you must use this class as is. You should never derive it.
public class CATEcwLightNwkCableForPercentFill
This is a CAA exposed class, meant to represent the Cable object
as defined in ECV (Electrical Cableway Route Management) application.
This class should NOT be instantiated by the user
The creation various instances of this class and setting data of various
class members by use of Setxxx methods should not be managed by the CAA user.
This class shall be required by the CAA user, so as to calculate Percent Fill
(hereafter referred as PF) information.
This class is an input argument to the CATIEcvPercentFill::ComputePercentFill
The ONLY method that the user should use from this class is GetCableData.
This shall give him more details about the Cable
Warning: All other methods of CATEcwLightNwkCableForPercentFill should not
be used by the user
Constructor and Destructor Index
- o
CATEcwLightNwkCableForPercentFill(int)
- Constructor
- o
~CATEcwLightNwkCableForPercentFill()
-
Method Index
- o
GetCableData(double&)
- Method can be called by the user from within his custom implementation of
CATIEcvPercentFill::ComputePercentFillValue
- o
SetCurrentCableArea(double)
- Method called by ManageCablesFromDatabase Command UI to set data for later use.
- o
SetCurrentCableOD(double)
- Method called by ManageCablesFromDatabase Command UI to set data for later use.
- o
SetListOfRoutedCablesODs(CATListOfDouble)
- Method called by ManageCablesFromDatabase Command UI to set data for later use.
- o
SetTotalCommonCableSize(double)
- Method called by ManageCablesFromDatabase Command UI to set data for later use.
Constructor and Destructor
o CATEcwLightNwkCableForPercentFill
public CATEcwLightNwkCableForPercentFill( | int | iDBKey) |
-
Constructor
- Parameters:
-
- iDBKey
- Input the unique key of the cable
o ~CATEcwLightNwkCableForPercentFill
public virtual ~CATEcwLightNwkCableForPercentFill( | ) |
-
Methods
o GetCableData
public void GetCableData( | double& | odCurrentCableOD) |
-
Method can be called by the user from within his custom implementation of
CATIEcvPercentFill::ComputePercentFillValue
- Parameters:
-
- odCurrentCableOD
- output: the OD of current Cable
- odCurrentCableArea
- output: the cumulative Area of current Cables
- oLRoutedCablesDiameter
- output: the List of Diameters of Current Cables
- odTotalCommonCableSize
- output: the cumulative Diameters of Current Cables
o SetCurrentCableArea
public void SetCurrentCableArea( | double | dCurrentCableArea) |
-
Method called by ManageCablesFromDatabase Command UI to set data for later use.
the CAA user shall not use the following method
- Parameters:
-
- dCurrentCableArea
- input: the cumulative Area of current Cables
o SetCurrentCableOD
public void SetCurrentCableOD( | double | dCurrentCableOD) |
-
Method called by ManageCablesFromDatabase Command UI to set data for later use.
the CAA user shall not use the following method
- Parameters:
-
- dCurrentCableOD
- input: the OD of current Cable
o SetListOfRoutedCablesODs
public void SetListOfRoutedCablesODs( | CATListOfDouble | iLRoutedCablesDiameter) |
-
Method called by ManageCablesFromDatabase Command UI to set data for later use.
the CAA user shall not use the following method
- Parameters:
-
- iLRoutedCablesDiameter
- input: the List of Diameters of Current Cables
o SetTotalCommonCableSize
public void SetTotalCommonCableSize( | double | dTotalCommonCableSize) |
-
Method called by ManageCablesFromDatabase Command UI to set data for later use.
the CAA user shall not use the following method
- Parameters:
-
- dTotalCommonCableSize
- input: the cumulative Diameters of Current Cables
This object is included in the file: CATEcwLightNwkCableForPercentFill.h
If needed, your Imakefile.mk should include the module: CATCommonLayoutItfCPP