All Frameworks Class Hierarchy This Framework Indexes
CATCommonLayoutInterfaces Class CATEcwLightNwkArcForPercentFill
Usage: you must use this class as is. You should never derive it.
public class CATEcwLightNwkArcForPercentFill
This is a CAA exposed class, meant to represent the Arc 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 GetArcData.
This shall give him more details about the Arc
Warning: All other methods of CATEcwLightNwkArcForPercentFill should not
be used by the user
Constructor and Destructor Index
- o
CATEcwLightNwkArcForPercentFill(int)
- Constructor
- o
~CATEcwLightNwkArcForPercentFill()
-
Method Index
- o
GetArcData(CATUnicodeString&,CATUnicodeString&,double&,double&,double&)
- Method can be called by the user from within his custom implementation of
CATIEcvPercentFill::ComputePercentFillValue
- o
SetArcArea(double)
- Method called by ManageCablesFromDatabase Command UI to set data for later use.
- o
SetArcPercentFill(double)
- Method called by ManageCablesFromDatabase Command UI to set data for later use.
- o
SetArcWidth(double)
- Method called by ManageCablesFromDatabase Command UI to set data for later use.
- o
SetName(CATUnicodeString)
- Method called by ManageCablesFromDatabase Command UI to set data for later use.
- o
SetType(CATUnicodeString)
- Method called by ManageCablesFromDatabase Command UI to set data for later use.
Constructor and Destructor
o CATEcwLightNwkArcForPercentFill
| public CATEcwLightNwkArcForPercentFill( | | iDBKey) |
-
Constructor
- Parameters:
-
- iDBKey
- Input the unique key of the arc
- Returns:
-
o ~CATEcwLightNwkArcForPercentFill
| public virtual ~CATEcwLightNwkArcForPercentFill( | ) |
-
Methods
o GetArcData
| public GetArcData( | | ouName, |
| | ouType, |
| | odArcArea, |
| | odArcWidth, |
| | odArcExistingPFill) |
-
Method can be called by the user from within his custom implementation of
CATIEcvPercentFill::ComputePercentFillValue
- Parameters:
-
- ouName
- output: the Name of the Arc
- ouType
- output: the Type of the Arc
- odArcArea
- output: the Area of the Arc
- odArcWidth
- output: the Width of the Arc
- odArcExistingPFill
- output: the existing Percent Fill of the Arc
o SetArcArea
| public SetArcArea( | | dArcArea) |
-
Method called by ManageCablesFromDatabase Command UI to set data for later use.
the CAA user shall not use the following method
- Parameters:
-
- dArcArea
- input: the Area of the Arc
o SetArcPercentFill
| public SetArcPercentFill( | | dArcExistingPFill) |
-
Method called by ManageCablesFromDatabase Command UI to set data for later use.
the CAA user shall not use the following method
- Parameters:
-
- dArcExistingPFill
- input: the existing PF of the Arc
o SetArcWidth
| public SetArcWidth( | | dArcWidth) |
-
Method called by ManageCablesFromDatabase Command UI to set data for later use.
the CAA user shall not use the following method
- Parameters:
-
- dArcWidth
- input: the Width of the Arc
o SetName
-
Method called by ManageCablesFromDatabase Command UI to set data for later use.
the CAA user shall not use the following method
- Parameters:
-
- iName
- input: the Name of the Arc
o SetType
-
Method called by ManageCablesFromDatabase Command UI to set data for later use.
the CAA user shall not use the following method
- Parameters:
-
- iName
- input: the Type of the Arc
This object is included in the file: CATEcwLightNwkArcForPercentFill.h
If needed, your Imakefile.mk should include the module: CATCommonLayoutItfCPP