Home       Trees       Indices       Help   
Module fmeobjects :: Class FMEDonut
[hide private]
[frames] | no frames]

Class FMEDonut

 object --+        
          |        
FMEGeometry --+    
              |    
        FMEArea --+
                  |
                 FMEDonut

init(MultipleInvocations)

FME Donut class.

Create an instance of a Donut geometry object.

init(outerBoundary)

Creates a new Donut geometry object. The curve passed in is used to define the outer boundary of the donut.

Parameters

Returns: FMEDonut

init(outerBoundary)

Creates a new Donut geometry object. The simple area passed in is used to define the outer boundary of the donut.

Parameters

Returns: FMEDonut

init(donut)

Create a copy of the passed in Donut geometry object.

Parameters

Returns: FMEDonut

Instance Methods [hide private]
 
__decIterRef__(args)
 
__incIterRef__(args)
 
__init__(MultipleInvocations)
x.__init__(...) initializes x; see help(type(x)) for signature
 
__iter__(x)
iter(x)
None
addInnerBoundaryCurve(innerBoundary)
If the inner boundary being added has a different dimension than the other boundaries, anything 2D will be forced to 3D.
None
addInnerBoundarySimpleArea(innerBoundary)
Adds a simple area as an inner boundary.
FMEPath, FMEArc, FMELine or None
getInnerBoundaryAsCurveAt(index)
Retrieves the inner boundary at 'index' as a FMECurve.
FMEPolygon, FMEEllipse or None
getInnerBoundaryAsSimpleAreaAt(index)
Retrieves the inner boundary at 'index' as a FMESimpleArea.
FMEPath, FMEArc or FMELine
getOuterBoundaryAsCurve()
Retrieves the outer boundary as a FMECurve.
FMEPolygon or FMEEllipse
getOuterBoundaryAsSimpleArea()
Retrieves the outer boundary as a FMESimpleArea
int
numInnerBoundaries()
Returns the number of inner boundaries on this donut.
FMEPath, FMEArc or FMELine
removeLastInnerBoundaryAsCurve()
Removes and returns the last inner boundary as a curve.
FMEEllipse, or FMEPolygon
removeLastInnerBoundaryAsSimpleArea()
Removes and returns the last inner boundary as a simple area.
None
setOuterBoundaryCurve(outerBoundary)
If the curve is not closed, the closure will be assumed as a straight line from the start point to the end point.
None
setOuterBoundarySimpleArea(outerBoundary)
Sets the outer boundary of the donut.

Inherited from FMEArea: isBoundaryLinear, isConvex, isInPlane, isOriented, isPlanar, offset, orient, removeDuplicates, reverse, rotate2D, scale

Inherited from FMEGeometry: __getObject__, __new__, boundingBox, boundingCube, bounds, clearMeasures, copyAttributesFromFeature, copyNameFromGeometry, copyTraitsFromGeometry, copyTraitsToFeature, deleteName, force2D, force3D, getArea, getMeasureNames, getName, getTrait, getTraitNames, getTraitNullMissingAndType, getTraitType, hasMeasures, hasName, is3D, isCollection, measureExists, removeMeasure, removeTraits, renameMeasure, setName, setTrait, setTraitNullWithType

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(MultipleInvocations)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

addInnerBoundaryCurve(innerBoundary)

 

If the inner boundary being added has a different dimension than the other boundaries, anything 2D will be forced to 3D. Note that the default Z value is 0.0 when forcing 2D geometry to 3D. If the curve is not closed, the closure will be assumed as a straight line from the start point to the end point. If the innerBoundary being added is None, nothing will be done.

Parameters:
  • innerBoundary (FMECurve or None) - The curve to add to the inner boundary.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

addInnerBoundarySimpleArea(innerBoundary)

 

Adds a simple area as an inner boundary. If the inner boundary being added has a different dimension than the other boundaries, anything 2D will be forced to 3D. Note that the default Z value is 0.0 when forcing 2D geometry to 3D. If the innerBoundary being added is None, nothing will be done.

Parameters:
  • innerBoundary (FMESimpleArea or None) - The simple area to add to the inner boundary.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

getInnerBoundaryAsCurveAt(index)

 

Retrieves the inner boundary at 'index' as a FMECurve.

Parameters:
  • index (int) - The index from which to retrieve the inner boundary as a curve from.
Returns: FMEPath, FMEArc, FMELine or None
The inner boundary as a FMECurve, or None if the specified index is greater than the number of inner boundaries. Returns the terminal geometry of the FMECurve, either a FMEPath, FMEArc or FMELine.
Raises:
  • FMEException - An exception is raised if an error occurred.

getInnerBoundaryAsSimpleAreaAt(index)

 

Retrieves the inner boundary at 'index' as a FMESimpleArea.

Parameters:
  • index (int) - The index from which to retrieve the inner boundary as a simple area from
Returns: FMEPolygon, FMEEllipse or None
The inner boundary as a FMESimpleArea, or None if the specified index is greater than the number of inner boundaries. Returns the terminal geometry of the FMESimpleArea, either a FMEPolygon or a FMEEllipse.
Raises:
  • FMEException - An exception is raised if an error occurred.

getOuterBoundaryAsCurve()

 

Retrieves the outer boundary as a FMECurve.

Returns: FMEPath, FMEArc or FMELine
The inner boundary as a FMECurve. Returns the terminal geometry of the FMECurve, either a FMEPath, FMEArc or FMELine.
Raises:
  • FMEException - An exception is raised if an error occurred.

getOuterBoundaryAsSimpleArea()

 

Retrieves the outer boundary as a FMESimpleArea

Returns: FMEPolygon or FMEEllipse
The outer boundary as a FMESimpleArea. Returns the terminal geometry of the FMESimpleArea, either a FMEPolygon or a FMEEllipse.
Raises:
  • FMEException - An exception is raised if an error occurred.

numInnerBoundaries()

 

Returns the number of inner boundaries on this donut.

Returns: int
The number of inner boundaries on this donut.

removeLastInnerBoundaryAsCurve()

 

Removes and returns the last inner boundary as a curve.

Returns: FMEPath, FMEArc or FMELine
The last inner boundary as a FMECurve. Returns the terminal geometry of the FMECurve, either a FMEPath, FMEArc or FMELine.
Raises:
  • FMEException - An exception is raised if an error occurred.

removeLastInnerBoundaryAsSimpleArea()

 

Removes and returns the last inner boundary as a simple area.

Returns: FMEEllipse, or FMEPolygon
The last inner boundary as a FMESimpleArea. Returns the terminal geometry of the FMESimpleArea, either a FMEEllipse, or FMEPolygon.
Raises:
  • FMEException - An exception is raised if an error occurred.

setOuterBoundaryCurve(outerBoundary)

 

If the curve is not closed, the closure will be assumed as a straight line from the start point to the end point. If the new outer boundary has a different dimension than the inner boundaries, everything will be forced to 3D. Note that the default Z value is 0.0 when forcing 2D geometry to 3D. This will return an error if the outerBoundary passed in is invalid or None.

Parameters:
  • outerBoundary (FMECurve) - The curve to set as the outer boundary.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

setOuterBoundarySimpleArea(outerBoundary)

 

Sets the outer boundary of the donut. If the new outer boundary has a different dimension than the inner boundaries, everything will be forced to 3D. Note that the default Z value is 0.0 when forcing 2D geometry to 3D.

Parameters:
  • outerBoundary (FMESimpleArea) - The simple area to set as the outer boundary.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Thu Nov 26 19:10:16 2015 http://epydoc.sourceforge.net