All Frameworks Class Hierarchy This Framework Previous Indexes
CATCommonLayoutInterfaces Class CATEcwLightNwkNodeForPercentFill
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATEcwLightNwkNodeForPercentFill
Usage: you must use this class as is. You should never derive it.
public class CATEcwLightNwkNodeForPercentFill
This is a CAA exposed class, meant to represent the Node 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 GetNodeData.
This shall give him more details about the Node
Warning: All other methods of CATEcwLightNwkNodeForPercentFill should not
be used by the user
Constructor and Destructor Index
- o
CATEcwLightNwkNodeForPercentFill(int)
- Constructor
- o
~CATEcwLightNwkNodeForPercentFill()
-
Method Index
- o
GetNodeData(CATUnicodeString&,CATUnicodeString&,double&,double&,CATLISTP(CATEcwLightNwkArcForPercentFill)&)
- Method can be called by the user from within his custom implementation of
CATIEcvPercentFill::ComputePercentFillValue
- o
SetArea(double)
- Method called by ManageCablesFromDatabase Command UI to set data for later use.
- o
SetExistingPercentFill(double)
- Method called by ManageCablesFromDatabase Command UI to set data for later use.
- o
SetListOfNodeArcs(CATLISTP(CATEcwLightNwkArcForPercentFill))
- 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 CATEcwLightNwkNodeForPercentFill
public CATEcwLightNwkNodeForPercentFill( | int | iDBKey) |
-
Constructor
- Parameters:
-
- iDBKey
- Input the unique key of the node
- Returns:
-
o ~CATEcwLightNwkNodeForPercentFill
public virtual ~CATEcwLightNwkNodeForPercentFill( | ) |
-
Methods
o GetNodeData
public void GetNodeData( | CATUnicodeString& | ouName, |
| CATUnicodeString& | ouType, |
| double& | odNodeArea, |
| double& | odNodeExistingPFill, |
| CATLISTP(CATEcwLightNwkArcForPercentFill)& | opListOfCAANwkArc) |
-
Method can be called by the user from within his custom implementation of
CATIEcvPercentFill::ComputePercentFillValue
- Parameters:
-
- ouName
- output: the Name of the Node
- ouType
- output: the Type of the Node
- odNodeArea
- output: the Area of the Node
- odNodeExistingPFill
- output: the existing Percent Fill of the Node
- opListOfCAANwkArc
- output: the List of Arcs connected to the Node
o SetArea
public void SetArea( | double | dNodeArea) |
-
Method called by ManageCablesFromDatabase Command UI to set data for later use.
the CAA user shall not use the following method
- Parameters:
-
- dNodeArea
- input: the Area of the Node
o SetExistingPercentFill
public void SetExistingPercentFill( | double | dNodeExistingPFill) |
-
Method called by ManageCablesFromDatabase Command UI to set data for later use.
the CAA user shall not use the following method
- Parameters:
-
- dNodeExistingPFill
- input: the existing PercentFill of the Node
o SetListOfNodeArcs
public void SetListOfNodeArcs( | CATLISTP(CATEcwLightNwkArcForPercentFill) | pListOfCAANwkArc) |
-
Method called by ManageCablesFromDatabase Command UI to set data for later use.
the CAA user shall not use the following method
- Parameters:
-
- pListOfCAANwkArc
- input: the ListOfArc connected to the Node
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 Node
o SetType
-
Method called by ManageCablesFromDatabase Command UI to set data for later use.
the CAA user shall not use the following method
- Parameters:
-
- iType
- input: the Type of the Node
This object is included in the file: CATEcwLightNwkNodeForPercentFill.h
If needed, your Imakefile.mk should include the module: CATCommonLayoutItfCPP