ElecRoutingItf Interface CATIEwrRouteSegment

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

interface CATIEwrRouteSegment

Interface on the route segment of wires or wire groups.

Method Index

o GetFillingRatio(double&,double*,double*): Retrieves the FillingRatio of the segment.
o ListConductors(CATListValCATBaseUnknown_var*&): Fills a list of conductors going through a given network segment.

o GetFillingRatio

public virtual GetFillingRatio(	`oFillingRatio`,
	`iStartOffset`	`= NULL`,
	`iEndOffset`	`= NULL`)

Retrieves the FillingRatio of the segment.

Parameters:

oFillingRatio: The Filling ratio of the bundle segment.
iStartOffset: The Offset from StartExtremity at which computation of segment filling ratio is to be started/ done. (If only iStartOffset is given, the Filling ratio will be calculated at this offset.)
iEndOffset: The Offset from StartExtremity at which computation of segment filling ratio is to be ended. (If both the offsets are given, the Filling ratio will be calculated between the two offsets.) Both the offsets are always calculated from the First End of the Segment.

Returns:

An HRESULT value.
Legal values:

o ListConductors

public virtual ListConductors( opLConductors)

Fills a list of conductors going through a given network segment.

Parameters:

opLConductors: A pointer to a list of wires and wire groups going through a network segment.

Returns:

S_OK is returned if there were no errors (the pointer on the list might be NULL).
E_FAIL is returned in case of errors.

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