All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMModelInterfaces Interface CATICGMComputePointOnWire

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATICGMComputePointOnWire

Class defining the operator that computes mathematical points on a wire.

This operator follows the general scheme of the topological operators:

Create the operator with the global function CATCGMCreateComputePointOnWire
Set parameters if necessary
Run with the Run method
Get the result mathematical point with the GetMathPoint method. Here, the GetResult method will always return NULL, and there is no associated journal, because the operator does not create any body.
Release the operator with the Release method.

Method Index

o GetMathPoint(CATMathPoint&): Retrieves the corresponding mathematical point.
o GetValue(double&): Retrieves the corresponding value for the computation.
o Run(): Runs this operator.
o SetMathPoint(CATMathPoint&): Defines the mathematical point.
o SetValue(double): Defines the ratio between the point to be computed and the wire length.

Methods

o GetMathPoint

public virtual GetMathPoint( ioResultPoint)

Retrieves the corresponding mathematical point.

Parameters:

ioResultPoint: The result as a CATMathPoint.

o GetValue

public virtual GetValue( oResultValue)

Retrieves the corresponding value for the computation.

Parameters:

oResultValue: The value, according to the computation mode.

o Run

public virtual Run(

)

Runs this operator.

Returns:: Not NULL in case of error.

o SetMathPoint

public virtual SetMathPoint( const iPoint)

Defines the mathematical point. The ratio between the length of wire portion defined by the CATMathPoint and the total wire length is then retrieved by using GetValue.

Parameters:

iPoint: The CATMathPoint.

o SetValue

public virtual SetValue( iValue)

Defines the ratio between the point to be computed and the wire length. The computed CATMathpoint is then retrieved by using GetMathPoint.

Parameters:

iValue: The value, according to the computation mode.

This object is included in the file: CATICGMComputePointOnWire.h
If needed, your Imakefile.mk should include the module: CATGMModelInterfaces