All Frameworks Class Hierarchy This Framework Previous Next Indexes
BasicTopologicalOpe Class CATLengthFromBodyOnWire
Mathematics.CATCGMVirtual
|
+---GeometricObjects.CATCGMOperator
|
+---NewTopologicalObjects.CATTopOperator
|
+---CATLengthFromBodyOnWire
Usage: you must use this class as is. You should never derive it.
public class CATLengthFromBodyOnWire
Class defining the operator that computes the length between two point bodies.
This operator can be used in two modes.
In BASIC mode, the operation is run at the operator creation. In this mode,
you have to read the resulting distance, and delete the operator, as in the following
example:
CATLengthFromBodyOnWire * Op = CATLengthFromBodyOnWire (factory,vertex1,vertex2);
double distance = Op->GetDistance(NULL,NULL);
delete Op;
If you need specific parameters, use the ADVANCED mode:
- Create the operator ,
- Set parameters,
- Run,
- Get the resulting distance,
- Delete the operator.
Example:
CATLengthFromBodyOnWire * Op = CATLengthFromBodyOnWire (factory,vertex1,vertex2);
Op->SetSupport(Wire); // on a wire
Op->Run();
CATMathPoint Point1, Point2;
double distance = Op->GetDistance(&Point1,&Point2);
delete Op;
Constructor and Destructor Index
- o
CATLengthFromBodyOnWire(CATGeoFactory*,CATBody*,CATBody*,CATBody*,CATSkillValue)
- Constructs an operator that computes the distance between two vertices along a wire body.
- o
CATLengthFromBodyOnWire(CATGeoFactory*,CATTopData*,CATBody*,CATBody*,CATBody*,CATSkillValue)
- Constructs an operator that computes the distance between two vertices along a wire body.
- o
CATLengthFromBodyOnWire(CATGeoFactory*,CATTopData*,CATVertex*,CATVertex*,CATWire*,CATSkillValue)
- Constructs an operator that computes the distance between two vertices along a wire.
- o
CATLengthFromBodyOnWire(CATGeoFactory*,CATVertex*,CATVertex*,CATWire*,CATSkillValue)
- Constructs an operator that computes the distance between two vertices along a wire.
- o
~CATLengthFromBodyOnWire()
-
Method Index
- o
GetDistance(CATMathPoint*,CATMathPoint*)
- Returns the computed distance.
- o
Run()
- Runs the operator in ADVANCED mode.
- o
SetEdge(CATBody*)
- Defines a new wire body along which the distance is computed.
- o
SetEdge(CATEdge*)
- Defines a new edge along which the distance is computed.
- o
SetVertices(CATBody*,CATBody*)
- Defines the new vertices between which the distance is computed.
- o
SetVertices(CATVertex*,CATVertex*)
- Defines the new vertices between which the distance is computed.
Constructor and Destructor
o CATLengthFromBodyOnWire
-
Constructs an operator that computes the distance between two vertices along a wire body.
- Parameters:
-
- iFactory
- The factory that creates the resulting body.
- iVertex1
- A pointer to the first body point.
- iVertex2
- A pointer to the second body point.
- iWire
- A pointer to the wire body on which the distance is computed.
- iMode
- The operator mode.
- BASIC The operation is performed at the operator creation.
- ADVANCEDUse the Run method.
o CATLengthFromBodyOnWire
-
Constructs an operator that computes the distance between two vertices along a wire body.
- Parameters:
-
- iFactory
- The factory that creates the resulting body.
- iData
- The pointer to the data defining the software configuration.
- iVertex1
- A pointer to the first body point.
- iVertex2
- A pointer to the second body point.
- iWire
- A pointer to the wire body on which the distance is computed.
- iMode
- The operator mode.
- BASIC The operation is performed at the operator creation.
- ADVANCEDUse the Run method.
o CATLengthFromBodyOnWire
-
Constructs an operator that computes the distance between two vertices along a wire.
- Parameters:
-
- iFactory
- The factory that creates the resulting body.
- iData
- The pointer to the data defining the software configuration.
- iVertex1
- A pointer to the first vertex.
- iVertex2
- A pointer to the second vertex.
- iWire
- A pointer to the wire on which the distance is computed.
- iMode
- The operator mode.
- BASIC The operation is performed at the operator creation.
- ADVANCEDUse the Run method.
o CATLengthFromBodyOnWire
-
Constructs an operator that computes the distance between two vertices along a wire.
- Parameters:
-
- iFactory
- The factory that creates the resulting body.
- iVertex1
- A pointer to the first vertex.
- iVertex2
- A pointer to the second vertex.
- iWire
- A pointer to the wire on which the distance is computed.
- iMode
- The operator mode.
- BASIC The operation is performed at the operator creation.
- ADVANCEDUse the Run method.
o ~CATLengthFromBodyOnWire
public ~CATLengthFromBodyOnWire( | ) |
-
Methods
o GetDistance
-
Returns the computed distance.
- Parameters:
-
- iMathPoint1
- A pointer to the mathematical definition of the first point.
If NULL, this argument is not computed.
- iMathPoint2
- A pointer to the mathematical definition of the second point.
If NULL, this argument is not computed.
- Returns:
- The computed distance.
Sample: to retrieve the distance and the mathematical definition of the first point:
CATMathPoint Point1;
double distance = Op->GetDistance(&Point1,NULL);
o Run
-
Runs the operator in ADVANCED mode.
- Returns:
- A diagnosis.
Legal values: 0 if some arguments of the operator are invalid, 1 otherwise.
o SetEdge
-
Defines a new wire body along which the distance is computed.
To use in ADVANCED mode.
- Parameters:
-
- iNewEdge
- A pointer to the wire body along which which the distance is computed.
o SetEdge
-
Defines a new edge along which the distance is computed.
To use in ADVANCED mode.
- Parameters:
-
- iNewEdge
- A pointer to the edge along which the distance is computed.
o SetVertices
-
Defines the new vertices between which the distance is computed.
To use in ADVANCED mode.
- Parameters:
-
- iNewVertex1
- A pointer to the first vertex.
- iNewVertex2
- A pointer to the second vertex.
o SetVertices
-
Defines the new vertices between which the distance is computed.
To use in ADVANCED mode.
- Parameters:
-
- iNewVertex1
- A pointer to the first vertex.
- iNewVertex2
- A pointer to the second vertex.
This object is included in the file: CATLengthFromBodyOnWire.h
If needed, your Imakefile.mk should include the module: CATBasicTopologicalOpe