Version: 8.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
GEOM::IAdvancedOperations Interface Reference

Interface for advanced modeling functions.

import "AdvancedGEOM.idl";

Inheritance diagram for GEOM::IAdvancedOperations:
Inheritance graph

Public Member Functions

GEOM::ListOfGO MakePipeTShape (in double theR1, in double theW1, in double theL1, in double theR2, in double theW2, in double theL2, in boolean theHexMesh)
 Create a T-shape object with specified caracteristics for the main and the incident pipes (radius, width, half-length). More...
 
GEOM::ListOfGO MakePipeTShapeWithPosition (in double theR1, in double theW1, in double theL1, in double theR2, in double theW2, in double theL2, in boolean theHexMesh, in GEOM::GEOM_Object theP1, in GEOM::GEOM_Object theP2, in GEOM::GEOM_Object theP3)
 Create a T-shape object with specified caracteristics for the main and the incident pipes (radius, width, half-length). More...
 
GEOM::ListOfGO MakePipeTShapeChamfer (in double theR1, in double theW1, in double theL1, in double theR2, in double theW2, in double theL2, in double theH, in double theW, in boolean theHexMesh)
 Create a T-shape object with specified caracteristics for the main and the incident pipes (radius, width, half-length). A chamfer is created on the junction of the pipes. More...
 
GEOM::ListOfGO MakePipeTShapeChamferWithPosition (in double theR1, in double theW1, in double theL1, in double theR2, in double theW2, in double theL2, in double theH, in double theW, in boolean theHexMesh, in GEOM::GEOM_Object theP1, in GEOM::GEOM_Object theP2, in GEOM::GEOM_Object theP3)
 Create a T-shape object with specified caracteristics for the main and the incident pipes (radius, width, half-length). More...
 
GEOM::ListOfGO MakePipeTShapeFillet (in double theR1, in double theW1, in double theL1, in double theR2, in double theW2, in double theL2, in double theRF, in boolean theHexMesh)
 Create a T-shape object with specified caracteristics for the main and the incident pipes (radius, width, half-length). More...
 
GEOM::ListOfGO MakePipeTShapeFilletWithPosition (in double theR1, in double theW1, in double theL1, in double theR2, in double theW2, in double theL2, in double theRF, in boolean theHexMesh, in GEOM::GEOM_Object theP1, in GEOM::GEOM_Object theP2, in GEOM::GEOM_Object theP3)
 Create a T-shape object with specified caracteristics for the main and the incident pipes (radius, width, half-length). More...
 
GEOM::ListOfGO MakePipeTShapeTR (in double theR1, in double theW1, in double theL1, in double theR2, in double theW2, in double theL2, in double theRL, in double theWL, in double theLtransL, in double theLthinL, in double theRR, in double theWR, in double theLtransR, in double theLthinR, in double theRI, in double theWI, in double theLtransI, in double theLthinI, in boolean theHexMesh)
 Create a T-shape object with specified caracteristics for the main and the incident pipes (radius, width, half-length). More...
 
GEOM::ListOfGO MakePipeTShapeTRWithPosition (in double theR1, in double theW1, in double theL1, in double theR2, in double theW2, in double theL2, in double theRL, in double theWL, in double theLtransL, in double theLthinL, in double theRR, in double theWR, in double theLtransR, in double theLthinR, in double theRI, in double theWI, in double theLtransI, in double theLthinI, in boolean theHexMesh, in GEOM::GEOM_Object theP1, in GEOM::GEOM_Object theP2, in GEOM::GEOM_Object theP3)
 Create a T-shape object with specified caracteristics for the main and the incident pipes (radius, width, half-length). More...
 
GEOM::ListOfGO MakePipeTShapeTRChamfer (in double theR1, in double theW1, in double theL1, in double theR2, in double theW2, in double theL2, in double theRL, in double theWL, in double theLtransL, in double theLthinL, in double theRR, in double theWR, in double theLtransR, in double theLthinR, in double theRI, in double theWI, in double theLtransI, in double theLthinI, in double theH, in double theW, in boolean theHexMesh)
 Create a T-shape object with specified caracteristics for the main and the incident pipes (radius, width, half-length). A chamfer is created on the junction of the pipes. More...
 
GEOM::ListOfGO MakePipeTShapeTRChamferWithPosition (in double theR1, in double theW1, in double theL1, in double theR2, in double theW2, in double theL2, in double theRL, in double theWL, in double theLtransL, in double theLthinL, in double theRR, in double theWR, in double theLtransR, in double theLthinR, in double theRI, in double theWI, in double theLtransI, in double theLthinI, in double theH, in double theW, in boolean theHexMesh, in GEOM::GEOM_Object theP1, in GEOM::GEOM_Object theP2, in GEOM::GEOM_Object theP3)
 Create a T-shape object with specified caracteristics for the main and the incident pipes (radius, width, half-length). More...
 
GEOM::ListOfGO MakePipeTShapeTRFillet (in double theR1, in double theW1, in double theL1, in double theR2, in double theW2, in double theL2, in double theRL, in double theWL, in double theLtransL, in double theLthinL, in double theRR, in double theWR, in double theLtransR, in double theLthinR, in double theRI, in double theWI, in double theLtransI, in double theLthinI, in double theRF, in boolean theHexMesh)
 Create a T-shape object with specified caracteristics for the main and the incident pipes (radius, width, half-length). More...
 
GEOM::ListOfGO MakePipeTShapeTRFilletWithPosition (in double theR1, in double theW1, in double theL1, in double theR2, in double theW2, in double theL2, in double theRL, in double theWL, in double theLtransL, in double theLthinL, in double theRR, in double theWR, in double theLtransR, in double theLthinR, in double theRI, in double theWI, in double theLtransI, in double theLthinI, in double theRF, in boolean theHexMesh, in GEOM::GEOM_Object theP1, in GEOM::GEOM_Object theP2, in GEOM::GEOM_Object theP3)
 Create a T-shape object with specified caracteristics for the main and the incident pipes (radius, width, half-length). More...
 
GEOM::GEOM_Object MakeDividedDisk (in double theR, in double theRatio, in short theOrientation, in GEOM::pattern thePattern)
 
GEOM::GEOM_Object MakeDividedDiskPntVecR (in GEOM::GEOM_Object thePnt, in GEOM::GEOM_Object theVec, in double theR, in double theRatio, in GEOM::pattern thePattern)
 Create a Disk prepared for hexa meshing with given center, normal vector and radius. More...
 
GEOM::GEOM_Object MakeDividedCylinder (in double theR, in double theH, in GEOM::pattern thePattern)
 
GEOM::GEOM_Object MakeSmoothingSurface (in GEOM::ListOfGO thelPoints, in long theNbMax, in long theDegMax, in double theDMax)
 
- Public Member Functions inherited from GEOM::GEOM_IOperations
boolean IsDone ()
 To know, if the operation was successfully performed. More...
 
void SetErrorCode (in string theErrorID)
 Set the operation error code. More...
 
string GetErrorCode ()
 Get the operation error code. More...
 
long GetStudyID ()
 Get ID of study, where the operation is defined. More...
 
void StartOperation ()
 Opens a new transaction. More...
 
void FinishOperation ()
 Closes the previously opened trasaction. More...
 
void AbortOperation ()
 Aborts the previously opened transaction. More...
 

Member Function Documentation

GEOM::GEOM_Object GEOM::IAdvancedOperations::MakeDividedCylinder ( in double  theR,
in double  theH,
in GEOM::pattern  thePattern 
)

Builds a cylinder prepared for hexa meshes

Parameters
theRRadius of the cylinder
theHHeight of the cylinder
thePatternDivision pattern. It can be GEOM.SQUARE or GEOM.HEXAGON
Returns
New GEOM_Object, containing the created shape.
GEOM::GEOM_Object GEOM::IAdvancedOperations::MakeDividedDisk ( in double  theR,
in double  theRatio,
in short  theOrientation,
in GEOM::pattern  thePattern 
)

This function allows to create a disk already divided into blocks. It can be use to create divided pipes for later meshing in hexaedra.

Parameters
theRRadius of the disk
theRatioRelative size of the central square diagonal against the disk diameter
theOrientationPlane on which the disk will be built
thePatternDivision pattern. It can be GEOM.SQUARE or GEOM.HEXAGON
Returns
New GEOM_Object, containing the created shape.
GEOM::GEOM_Object GEOM::IAdvancedOperations::MakeDividedDiskPntVecR ( in GEOM::GEOM_Object  thePnt,
in GEOM::GEOM_Object  theVec,
in double  theR,
in double  theRatio,
in GEOM::pattern  thePattern 
)
Parameters
thePntdisk center.
theVecVector, normal to the plane of the disk.
theRDisk radius.
theRatioRelative size of the central square diagonal against the disk diameter
thePatternDivision pattern. It can be GEOM.SQUARE or GEOM.HEXAGON
Returns
New GEOM_Object, containing the created disk.
GEOM::ListOfGO GEOM::IAdvancedOperations::MakePipeTShape ( in double  theR1,
in double  theW1,
in double  theL1,
in double  theR2,
in double  theW2,
in double  theL2,
in boolean  theHexMesh 
)

Center of the shape is (0,0,0). The main plane of the T-shape is XOY.

Parameters
theR1Internal radius of main pipe
theW1Width of main pipe
theL1Half-length of main pipe
theR2Internal radius of incident pipe (R2 < R1)
theW2Width of incident pipe (R2+W2 < R1+W1)
theL2Half-length of incident pipe
theHexMeshBoolean indicating if shape is prepared for hex mesh (default=true)
Returns
List of GEOM_Object, containing the created shape and propagation groups.
GEOM::ListOfGO GEOM::IAdvancedOperations::MakePipeTShapeChamfer ( in double  theR1,
in double  theW1,
in double  theL1,
in double  theR2,
in double  theW2,
in double  theL2,
in double  theH,
in double  theW,
in boolean  theHexMesh 
)

Center of the shape is (0,0,0). The main plane of the T-shape is XOY.

Parameters
theR1Internal radius of main pipe
theW1Width of main pipe
theL1Half-length of main pipe
theR2Internal radius of incident pipe (R2 < R1)
theW2Width of incident pipe (R2+W2 < R1+W1)
theL2Half-length of incident pipe
theHHeight of the chamfer.
theWWidth of the chamfer.
theHexMeshBoolean indicating if shape is prepared for hex mesh (default=true)
Returns
List of GEOM_Object, containing the created shape and propagation groups.
GEOM::ListOfGO GEOM::IAdvancedOperations::MakePipeTShapeChamferWithPosition ( in double  theR1,
in double  theW1,
in double  theL1,
in double  theR2,
in double  theW2,
in double  theL2,
in double  theH,
in double  theW,
in boolean  theHexMesh,
in GEOM::GEOM_Object  theP1,
in GEOM::GEOM_Object  theP2,
in GEOM::GEOM_Object  theP3 
)

A chamfer is created on the junction of the pipes. The extremities of the main pipe are located on junctions points P1 and P2. The extremity of the incident pipe is located on junction point P3.

Parameters
theR1Internal radius of main pipe
theW1Width of main pipe
theL1Half-length of main pipe
theR2Internal radius of incident pipe (R2 < R1)
theW2Width of incident pipe (R2+W2 < R1+W1)
theL2Half-length of incident pipe
theHHeight of the chamfer.
theWWidth of the chamfer.
theHexMeshBoolean indicating if shape is prepared for hex mesh (default=true)
theP11st junction point of main pipe
theP22nd junction point of main pipe
theP3Junction point of incident pipe
Returns
List of GEOM_Object, containing the created shape and propagation groups.
GEOM::ListOfGO GEOM::IAdvancedOperations::MakePipeTShapeFillet ( in double  theR1,
in double  theW1,
in double  theL1,
in double  theR2,
in double  theW2,
in double  theL2,
in double  theRF,
in boolean  theHexMesh 
)

A fillet is created on the junction of the pipes. Center of the shape is (0,0,0). The main plane of the T-shape is XOY.

Parameters
theR1Internal radius of main pipe
theW1Width of main pipe
theL1Half-length of main pipe
theR2Internal radius of incident pipe (R2 < R1)
theW2Width of incident pipe (R2+W2 < R1+W1)
theL2Half-length of incident pipe
theRFRadius of curvature of fillet.
theHexMeshBoolean indicating if shape is prepared for hex mesh (default=true)
Returns
List of GEOM_Object, containing the created shape and propagation groups.
GEOM::ListOfGO GEOM::IAdvancedOperations::MakePipeTShapeFilletWithPosition ( in double  theR1,
in double  theW1,
in double  theL1,
in double  theR2,
in double  theW2,
in double  theL2,
in double  theRF,
in boolean  theHexMesh,
in GEOM::GEOM_Object  theP1,
in GEOM::GEOM_Object  theP2,
in GEOM::GEOM_Object  theP3 
)

A fillet is created on the junction of the pipes. The extremities of the main pipe are located on junctions points P1 and P2. The extremity of the incident pipe is located on junction point P3.

Parameters
theR1Internal radius of main pipe
theW1Width of main pipe
theL1Half-length of main pipe
theR2Internal radius of incident pipe (R2 < R1)
theW2Width of incident pipe (R2+W2 < R1+W1)
theL2Half-length of incident pipe
theRFRadius of curvature of fillet.
theHexMeshBoolean indicating if shape is prepared for hex mesh (default=true)
theP11st junction point of main pipe
theP22nd junction point of main pipe
theP3Junction point of incident pipe
Returns
List of GEOM_Object, containing the created shape and propagation groups.
GEOM::ListOfGO GEOM::IAdvancedOperations::MakePipeTShapeTR ( in double  theR1,
in double  theW1,
in double  theL1,
in double  theR2,
in double  theW2,
in double  theL2,
in double  theRL,
in double  theWL,
in double  theLtransL,
in double  theLthinL,
in double  theRR,
in double  theWR,
in double  theLtransR,
in double  theLthinR,
in double  theRI,
in double  theWI,
in double  theLtransI,
in double  theLthinI,
in boolean  theHexMesh 
)

Center of the shape is (0,0,0). The main plane of the T-shape is XOY.

Parameters
theR1Internal radius of main pipe
theW1Width of main pipe
theL1Half-length of main pipe
theR2Internal radius of incident pipe (R2 < R1)
theW2Width of incident pipe (R2+W2 < R1+W1)
theL2Half-length of incident pipe
theRLInternal radius of left thickness reduction
theWLWidth of left thickness reduction
theLtransLLength of left transition part
theLthinLLength of left thin part
theRRInternal radius of right thickness reduction
theWRWidth of right thickness reduction
theLtransRLength of right transition part
theLthinRLength of right thin part
theRIInternal radius of incident thickness reduction
theWIWidth of incident thickness reduction
theLtransILength of incident transition part
theLthinILength of incident thin part
theHexMeshBoolean indicating if shape is prepared for hex mesh (default=true)
Returns
List of GEOM_Object, containing the created shape and propagation groups.
GEOM::ListOfGO GEOM::IAdvancedOperations::MakePipeTShapeTRChamfer ( in double  theR1,
in double  theW1,
in double  theL1,
in double  theR2,
in double  theW2,
in double  theL2,
in double  theRL,
in double  theWL,
in double  theLtransL,
in double  theLthinL,
in double  theRR,
in double  theWR,
in double  theLtransR,
in double  theLthinR,
in double  theRI,
in double  theWI,
in double  theLtransI,
in double  theLthinI,
in double  theH,
in double  theW,
in boolean  theHexMesh 
)

Center of the shape is (0,0,0). The main plane of the T-shape is XOY.

Parameters
theR1Internal radius of main pipe
theW1Width of main pipe
theL1Half-length of main pipe
theR2Internal radius of incident pipe (R2 < R1)
theW2Width of incident pipe (R2+W2 < R1+W1)
theL2Half-length of incident pipe
theRLInternal radius of left thickness reduction
theWLWidth of left thickness reduction
theLtransLLength of left transition part
theLthinLLength of left thin part
theRRInternal radius of right thickness reduction
theWRWidth of right thickness reduction
theLtransRLength of right transition part
theLthinRLength of right thin part
theRIInternal radius of incident thickness reduction
theWIWidth of incident thickness reduction
theLtransILength of incident transition part
theLthinILength of incident thin part
theHHeight of the chamfer.
theWWidth of the chamfer.
theHexMeshBoolean indicating if shape is prepared for hex mesh (default=true)
Returns
List of GEOM_Object, containing the created shape and propagation groups.
GEOM::ListOfGO GEOM::IAdvancedOperations::MakePipeTShapeTRChamferWithPosition ( in double  theR1,
in double  theW1,
in double  theL1,
in double  theR2,
in double  theW2,
in double  theL2,
in double  theRL,
in double  theWL,
in double  theLtransL,
in double  theLthinL,
in double  theRR,
in double  theWR,
in double  theLtransR,
in double  theLthinR,
in double  theRI,
in double  theWI,
in double  theLtransI,
in double  theLthinI,
in double  theH,
in double  theW,
in boolean  theHexMesh,
in GEOM::GEOM_Object  theP1,
in GEOM::GEOM_Object  theP2,
in GEOM::GEOM_Object  theP3 
)

A chamfer is created on the junction of the pipes. The extremities of the main pipe are located on junctions points P1 and P2. The extremity of the incident pipe is located on junction point P3.

Parameters
theR1Internal radius of main pipe
theW1Width of main pipe
theL1Half-length of main pipe
theR2Internal radius of incident pipe (R2 < R1)
theW2Width of incident pipe (R2+W2 < R1+W1)
theL2Half-length of incident pipe
theRLInternal radius of left thickness reduction
theWLWidth of left thickness reduction
theLtransLLength of left transition part
theLthinLLength of left thin part
theRRInternal radius of right thickness reduction
theWRWidth of right thickness reduction
theLtransRLength of right transition part
theLthinRLength of right thin part
theRIInternal radius of incident thickness reduction
theWIWidth of incident thickness reduction
theLtransILength of incident transition part
theLthinILength of incident thin part
theHHeight of the chamfer.
theWWidth of the chamfer.
theHexMeshBoolean indicating if shape is prepared for hex mesh (default=true)
theP11st junction point of main pipe
theP22nd junction point of main pipe
theP3Junction point of incident pipe
Returns
List of GEOM_Object, containing the created shape and propagation groups.
GEOM::ListOfGO GEOM::IAdvancedOperations::MakePipeTShapeTRFillet ( in double  theR1,
in double  theW1,
in double  theL1,
in double  theR2,
in double  theW2,
in double  theL2,
in double  theRL,
in double  theWL,
in double  theLtransL,
in double  theLthinL,
in double  theRR,
in double  theWR,
in double  theLtransR,
in double  theLthinR,
in double  theRI,
in double  theWI,
in double  theLtransI,
in double  theLthinI,
in double  theRF,
in boolean  theHexMesh 
)

A fillet is created on the junction of the pipes. Center of the shape is (0,0,0). The main plane of the T-shape is XOY.

Parameters
theR1Internal radius of main pipe
theW1Width of main pipe
theL1Half-length of main pipe
theR2Internal radius of incident pipe (R2 < R1)
theW2Width of incident pipe (R2+W2 < R1+W1)
theL2Half-length of incident pipe
theRLInternal radius of left thickness reduction
theWLWidth of left thickness reduction
theLtransLLength of left transition part
theLthinLLength of left thin part
theRRInternal radius of right thickness reduction
theWRWidth of right thickness reduction
theLtransRLength of right transition part
theLthinRLength of right thin part
theRIInternal radius of incident thickness reduction
theWIWidth of incident thickness reduction
theLtransILength of incident transition part
theLthinILength of incident thin part
theRFRadius of curvature of fillet.
theHexMeshBoolean indicating if shape is prepared for hex mesh (default=true)
Returns
List of GEOM_Object, containing the created shape and propagation groups.
GEOM::ListOfGO GEOM::IAdvancedOperations::MakePipeTShapeTRFilletWithPosition ( in double  theR1,
in double  theW1,
in double  theL1,
in double  theR2,
in double  theW2,
in double  theL2,
in double  theRL,
in double  theWL,
in double  theLtransL,
in double  theLthinL,
in double  theRR,
in double  theWR,
in double  theLtransR,
in double  theLthinR,
in double  theRI,
in double  theWI,
in double  theLtransI,
in double  theLthinI,
in double  theRF,
in boolean  theHexMesh,
in GEOM::GEOM_Object  theP1,
in GEOM::GEOM_Object  theP2,
in GEOM::GEOM_Object  theP3 
)

A fillet is created on the junction of the pipes. The extremities of the main pipe are located on junctions points P1 and P2. The extremity of the incident pipe is located on junction point P3.

Parameters
theR1Internal radius of main pipe
theW1Width of main pipe
theL1Half-length of main pipe
theR2Internal radius of incident pipe (R2 < R1)
theW2Width of incident pipe (R2+W2 < R1+W1)
theL2Half-length of incident pipe
theRLInternal radius of left thickness reduction
theWLWidth of left thickness reduction
theLtransLLength of left transition part
theLthinLLength of left thin part
theRRInternal radius of right thickness reduction
theWRWidth of right thickness reduction
theLtransRLength of right transition part
theLthinRLength of right thin part
theRIInternal radius of incident thickness reduction
theWIWidth of incident thickness reduction
theLtransILength of incident transition part
theLthinILength of incident thin part
theRFRadius of curvature of fillet.
theHexMeshBoolean indicating if shape is prepared for hex mesh (default=true)
theP11st junction point of main pipe
theP22nd junction point of main pipe
theP3Junction point of incident pipe
Returns
List of GEOM_Object, containing the created shape and propagation groups.
GEOM::ListOfGO GEOM::IAdvancedOperations::MakePipeTShapeTRWithPosition ( in double  theR1,
in double  theW1,
in double  theL1,
in double  theR2,
in double  theW2,
in double  theL2,
in double  theRL,
in double  theWL,
in double  theLtransL,
in double  theLthinL,
in double  theRR,
in double  theWR,
in double  theLtransR,
in double  theLthinR,
in double  theRI,
in double  theWI,
in double  theLtransI,
in double  theLthinI,
in boolean  theHexMesh,
in GEOM::GEOM_Object  theP1,
in GEOM::GEOM_Object  theP2,
in GEOM::GEOM_Object  theP3 
)

The extremities of the main pipe are located on junctions points P1 and P2. The extremity of the incident pipe is located on junction point P3.

Parameters
theR1Internal radius of main pipe
theW1Width of main pipe
theL1Half-length of main pipe
theR2Internal radius of incident pipe (R2 < R1)
theW2Width of incident pipe (R2+W2 < R1+W1)
theL2Half-length of incident pipe
theRLInternal radius of left thickness reduction
theWLWidth of left thickness reduction
theLtransLLength of left transition part
theLthinLLength of left thin part
theRRInternal radius of right thickness reduction
theWRWidth of right thickness reduction
theLtransRLength of right transition part
theLthinRLength of right thin part
theRIInternal radius of incident thickness reduction
theWIWidth of incident thickness reduction
theLtransILength of incident transition part
theLthinILength of incident thin part
theHexMeshBoolean indicating if shape is prepared for hex mesh (default=true)
theP11st junction point of main pipe
theP22nd junction point of main pipe
theP3Junction point of incident pipe
Returns
List of GEOM_Object, containing the created shape and propagation groups.
GEOM::ListOfGO GEOM::IAdvancedOperations::MakePipeTShapeWithPosition ( in double  theR1,
in double  theW1,
in double  theL1,
in double  theR2,
in double  theW2,
in double  theL2,
in boolean  theHexMesh,
in GEOM::GEOM_Object  theP1,
in GEOM::GEOM_Object  theP2,
in GEOM::GEOM_Object  theP3 
)

The extremities of the main pipe are located on junctions points P1 and P2. The extremity of the incident pipe is located on junction point P3.

Parameters
theR1Internal radius of main pipe
theW1Width of main pipe
theL1Half-length of main pipe
theR2Internal radius of incident pipe (R2 < R1)
theW2Width of incident pipe (R2+W2 < R1+W1)
theL2Half-length of incident pipe
theHexMeshBoolean indicating if shape is prepared for hex mesh (default=true)
theP11st junction point of main pipe
theP22nd junction point of main pipe
theP3Junction point of incident pipe
Returns
List of GEOM_Object, containing the created shape and propagation groups.
GEOM::GEOM_Object GEOM::IAdvancedOperations::MakeSmoothingSurface ( in GEOM::ListOfGO  thelPoints,
in long  theNbMax,
in long  theDegMax,
in double  theDMax 
)

Create a smoothing surface from a set of points

Parameters
thelPointslist of points. Compounds of ggpoints are accepted as well.
theNbMaxmaximum number of Bezier pieces in the resulting surface.
theDegMaxmaximum degree of the resulting BSpline surface
theDMaxspecifies maximum value of the GeomPlate_PlateG0Criterion criterion.
Returns
New GEOM_Object, containing the created shape.

The documentation for this interface was generated from the following file: