fmeobjects.FMEMultiText

`FMEMultiText.appendPart`(text)	This appends the text to the existing MultiText.
`FMEMultiText.appendParts`(multiText)	This appends the MultiText passed in to the existing MultiText.
`FMEMultiText.boundingBox`()	This method returns the bounding box of the geometry.
`FMEMultiText.boundingCube`()	This method returns the bounding cube of the geometry.
`FMEMultiText.bounds`()	Returns the bounds of the geometry.
`FMEMultiText.clearMeasures`()	Remove all measures from the geometry.
`FMEMultiText.copyAttributesFromFeature`(...)	Copies all the attributes from the given feature to traits on this geometry, if they match the (optional) regular expression.
`FMEMultiText.copyLabelFromGeometry`(...)	Copies the label of the 'sourceGeometry' onto this geometry.
`FMEMultiText.copyTraitsFromGeometry`(...)	Copies all the traits from the given geometry that match the (optional) regular expression.
`FMEMultiText.copyTraitsToFeature`(...)	Copies all the traits from this geometry to attributes on the given feature, if they match the (optional) regular expression.
`FMEMultiText.deleteLabel`()	Deletes the geometry's label.
`FMEMultiText.force2D`()	Reduces the geometry to 2D.
`FMEMultiText.force3D`(newZ)	This sets the geometry's dimension to 3D.
`FMEMultiText.getArea`()	Area calculation.
`FMEMultiText.getLabel`()	This routine retrieves the 'label' of this geometry as a `str`.
`FMEMultiText.getMeasureNames`()	Retrieve the names of the measures on this geometry.
`FMEMultiText.getPartAt`(index)	This method returns the text at the given index.
`FMEMultiText.getTrait`(traitName)	Retrieves the geometry trait value of the specified trait name.
`FMEMultiText.getTraitNames`()	Retrieve the names of the traits on this geometry.
`FMEMultiText.getTraitNullMissingAndType`(...)	This method returns a tuple of a boolean, indicating if the trait is null, a boolean, indicating if the trait is missing, and an integer representing the type of the trait.
`FMEMultiText.getTraitType`(traitName)	Returns the type of given trait.
`FMEMultiText.hasLabel`()	Returns whether or not the geometry has a label.
`FMEMultiText.hasMeasures`()	Check if this geometry or any sub part of this geometry has measures.
`FMEMultiText.is3D`()	Returns whether or not the geometry is 3D.
`FMEMultiText.isCollection`()	Check if the geometry is an aggregate or multi-part collection.
`FMEMultiText.measureExists`(measureName)	Returns `True` if the specified measure exists and `False` otherwise.
`FMEMultiText.numParts`()	This returns the number of texts that make up this MultiText.
`FMEMultiText.offset`(offsetPoint)	Offsets the geometry by the coords specified by 'offsetPoint'.
`FMEMultiText.removeLastPart`()	This removes and returns the last text of the MultiText.
`FMEMultiText.removeMeasure`(measureName)	Removes the measure with name 'measureName' if supplied, or the default measure, if there is one.
`FMEMultiText.removeTraits`(regexp)	This method has 4 modes:
`FMEMultiText.renameMeasure`(oldMeasureName, ...)	Renames the measure specified by 'oldMeasureName' to the new name, specified by 'newMeasureName'.
`FMEMultiText.rotate2D`(center, angle)	The angle is CCW up from the horizontal and is measured in degrees.
`FMEMultiText.scaleXYZ`	scaleXYZT(xscale, yscale, zscale, scaleText)
`FMEMultiText.scaleXYZT`(xscale, yscale, ...)	scaleXYZ(xscale, yscale, zscale)
`FMEMultiText.setLabel`(name)	Sets the geometry's label with a `str`.
`FMEMultiText.setTrait`(traitName, traitValue)	Sets a geometry trait with the specified value.
`FMEMultiText.setTraitNullWithType`(traitName, ...)	This method supplies a null trait value with a type to the geometry.

class FMEMultiText

FME Multi-Text Class

Create an instance of a Multi-Text geometry object.

init()

Default FMEMultiText constructor.

Return type:: FMEMultiText
Returns:: An instance of a MultiText geometry object.

init(multiText)

Create a copy of the passed in Multi-Text geometry object.

Parameters:: multiText (FMEMultiText) – The Multi-Text geometry object to create a copy of.
Return type:: FMEMultiText
Returns:: An instance of a MultiText Geometry object.

__init__(*args, **kwargs)

appendPart(text)

This appends the text to the existing MultiText. If None is passed in, nothing will be appended. All texts in the MultiText will be forced to have the same dimension. If any 3D texts exist, all 2D texts will be converted to 3D with a default Z value of 0.0.

Parameters:: text (FMEText) – The text to be appended.
Return type:: None
Raises:: FMEException – An exception is raised if an error occurred.

appendParts(multiText)

This appends the MultiText passed in to the existing MultiText. If None is passed in, nothing will be appended.

Parameters:: multiText (FMEMultiText) – The MultiText to be appended.
Return type:: None
Raises:: FMEException – An exception is raised if an error occurred.

boundingBox()

This method returns the bounding box of the geometry.

Return type:: tuple[tuple[float]]
Returns:: The bounding box of the Geometry, in the form ((minx, miny), (maxx, maxy)).

boundingCube()

This method returns the bounding cube of the geometry.

Return type:: tuple[tuple[float]]
Returns:: The bounding box of the Geometry, in the form ((minx, miny, minz), (maxx, maxy, maxz)).

bounds()

Returns the bounds of the geometry.

Return type:: tuple[FMEPoint]
Returns:: The min point and max point of the bounds. None is returned if the geometry contains no points.

clearMeasures()

Remove all measures from the geometry.

Return type:: None

copyAttributesFromFeature(sourceFeature, overwriteExisting, regexp, prefix)

Copies all the attributes from the given feature to traits on this geometry, if they match the (optional) regular expression.

Parameters:

sourceFeature (FMEFeature) – The feature to copy attributes from.
overwriteExisting (bool) – Existing traits will be overwritten only if overwriteExisting is True.
regexp (str) – (Optional) The regular expression to match the attributes against. If regexp is not specified, then all attributes will be copied.
prefix (str) – (Optional) The prefix is put on all the trait names as they are copied. If it is not specified, a prefix will not be added to the trait names.

Return type:

None

copyLabelFromGeometry(sourceGeometry)

Copies the label of the ‘sourceGeometry’ onto this geometry. If ‘sourceGeometry’s label is blank or None, this geometry’s label will become None. This method replaces the deprecated copyNameFromGeometry() method.

Parameters:: sourceGeometry (FMEGeometry) – The geometry to copy the label from.
Return type:: None

copyTraitsFromGeometry(sourceGeometry, overwriteExisting, regexp, prefix)

Copies all the traits from the given geometry that match the (optional) regular expression.

Parameters:

sourceGeometry (FMEGeometry) – The geometry to copy traits from.
overwriteExisting (bool) – Existing traits will be overwritten only if overwriteExisting is True.
regexp (str) – (Optional) The regular expression to match the traits against. If regexp is not specified, or is an empty string, then all traits will be copied.
prefix (str) – (Optional) The prefix is put on all the trait names as they are copied. If it is not specified, a prefix will not be added to the trait names.

Return type:

None

copyTraitsToFeature(destFeature, overwriteExisting, regexp, prefix)

Copies all the traits from this geometry to attributes on the given feature, if they match the (optional) regular expression.

Parameters:

destFeature (FMEFeature) – The feature to copy traits to.
overwriteExisting (bool) – Existing attributes will be overwritten only if overwriteExisting is True.
regexp (str) – (Optional) The regular expression to match the traits against. If regexp is not specified, or is an empty string, then all traits will be copied.
prefix (str) – (Optional) The prefix is put on all the attribute names as they are copied. If it is not specified, a prefix will not be added to the attribute names.

Return type:

None

deleteLabel()

Deletes the geometry’s label. If a label existed prior to this call then True is returned; otherwise False is returned. This method replaces the deprecated deleteName() method.

Return type:: bool
Returns:: Returns a boolean indicating whether or not the label existed before deletion.

force2D()

Reduces the geometry to 2D.

Return type:: None

force3D(newZ)

This sets the geometry’s dimension to 3D. All Z values are set to the value passed in, even if the geometry is already 3D.

Parameters:: newZ (float) – The new Z value.
Return type:: None

getArea()

Area calculation.

Return type:: float
Returns:: The calculated area.

getLabel()

This routine retrieves the ‘label’ of this geometry as a str. This will return None if it did not have a label associated with it. This method replaces the deprecated getName() method.

Return type:: str or None
Returns:: The geometry’s label.

getMeasureNames()

Retrieve the names of the measures on this geometry.

Return type:: tuple[str]
Returns:: Return a tuple storing the names of the measures on this geometry. This will return an empty tuple if there are no measures. For FMEAggregate, FMEMultiSurface, and FMECompositeSurface, this will return the union of all measure names of all of its parts.

getPartAt(index)

This method returns the text at the given index. None is returned if the index is out of range.

Parameters:: index (int) – The index of the text part to return.
Return type:: FMEText or None
Returns:: The text at the given index. Note: This method returns a terminal text type of the FMEText ; i.e. one of the leaf classes in the FMEText inheritance graph. For example, a FMELine is returned if the text truly is a line.
Raises:: FMEException – An exception is raised if an error occurred.

getTrait(traitName)

Retrieves the geometry trait value of the specified trait name. Null trait values will be returned as an empty string. Binary blob traits are returned as a bytearray.

None is returned when the trait is not found on the geometry.

Parameters:: traitName (str) – The name of the geometry trait.
Return type:: bool, int, float, str, bytearray, bytes or None
Returns:: The trait value.
Raises:: FMEException – An exception is raised if there was a problem in retrieving the trait value.

getTraitNames()

Retrieve the names of the traits on this geometry.

Return type:: tuple[str]
Returns:: Return a tuple storing the names of the traits on this geometry. This will return an empty tuple if there are no traits. For all collections and containers, this will only return the names of traits on the outermost object only.

getTraitNullMissingAndType(traitName)

This method returns a tuple of a boolean, indicating if the trait is null, a boolean, indicating if the trait is missing, and an integer representing the type of the trait. The first boolean is True if ‘traitName’ maps to a null trait value on the geometry. Otherwise it is False. The second boolean is True if ‘traitName’ maps to a no value on the geometry. Otherwise it is False. If the trait is absent, FME_ATTR_UNDEFINED is returned for the type.

The possible trait types are FME_ATTR_UNDEFINED, FME_ATTR_BOOLEAN, FME_ATTR_INT8, FME_ATTR_UINT8, FME_ATTR_INT16, FME_ATTR_UINT16, FME_ATTR_INT32, FME_ATTR_UINT32, FME_ATTR_REAL32, FME_ATTR_REAL64, FME_ATTR_REAL80, FME_ATTR_STRING, FME_ATTR_ENCODED_STRING, FME_ATTR_INT64, FME_ATTR_UINT64.

Parameters:: traitName (str) – The trait’s name.
Return type:: tuple[bool, bool, int]
Returns:: A tuple of 2 boolean values the first indicating whether or not the value of the trait is null, the second indicating whether or not the trait is missing, and an integer representing the trait type.

getTraitType(traitName)

Returns the type of given trait. If the trait cannot be found, FME_ATTR_UNDEFINED will be returned.

Returns one of FME_ATTR_UNDEFINED, FME_ATTR_BOOLEAN, FME_ATTR_INT8, FME_ATTR_UINT8, FME_ATTR_INT16, FME_ATTR_UINT16, FME_ATTR_INT32, FME_ATTR_UINT32, FME_ATTR_REAL32, FME_ATTR_REAL64, FME_ATTR_REAL80, FME_ATTR_STRING, FME_ATTR_ENCODED_STRING, FME_ATTR_INT64, FME_ATTR_UINT64.

Parameters:: traitName (str) – The trait’s name.
Return type:: int
Returns:: The trait type.

hasLabel()

Returns whether or not the geometry has a label. This method replaces the deprecated hasName() method.

Return type:: bool
Returns:: Returns True if the geometry has a label and False otherwise.

hasMeasures()

Check if this geometry or any sub part of this geometry has measures.

Return type:: bool
Returns:: True if this geometry or any sub part of this geometry has measures, False otherwise.

is3D()

Returns whether or not the geometry is 3D.

Return type:: bool
Returns:: Returns True if the geometry is 3D and False otherwise. For FMENull, this method will always return True. For FMEAggregate, FMEMultiPoint, FMEMultiArea, FMEMultiText and FMEMultiCurve, this method will return True if any one of the sub-parts is 3D. If the collection is empty or all of its members are 2D, this method will return False.

isCollection()

Check if the geometry is an aggregate or multi-part collection.

Return type:: bool
Returns:: True if the geometry is an aggregate or multi-part collection.

measureExists(measureName)

Returns True if the specified measure exists and False otherwise. If the ‘measureName’ parameter is not specified then the default measure is checked.

Parameters:: measureName (str) – (Optional) The measure’s name.
Return type:: bool
Returns:: Boolean indicating whether or not the measure exists.

numParts()

This returns the number of texts that make up this MultiText.

Return type:: int
Returns:: The number of texts in MultiText.

offset(offsetPoint)

Offsets the geometry by the coords specified by ‘offsetPoint’.

Parameters:: offsetPoint (FMEPoint) – The point to offset the coordinates of the geometry by.
Return type:: None
Raises:: FMEException – An exception is raised if an error occurred.

removeLastPart()

This removes and returns the last text of the MultiText. If there are no texts in the MultiText, it will return None.

Return type:: FMEText or None
Returns:: The last text of the MultiText. Note: This method returns a terminal text type of the FMEText; i.e. one of the leaf classes in the FMEText inheritance graph. For example, a FMELine is returned if the text truly is a line.
Raises:: FMEException – An exception is raised if an error occurred.

removeMeasure(measureName)

Removes the measure with name ‘measureName’ if supplied, or the default measure, if there is one.

Parameters:: measureName (str) – (Optional) The name of the measure to remove.
Return type:: None

removeTraits(regexp)

This method has 4 modes:

Remove all traits at the top level: regex == NULL

Remove some traits at the top level: regex == <string>

Remove all traits at all levels: regex == kFME_RecurseAll

Remove some traits at all levels: regex == kFME_RecurseSome <string>

For example, specifying regex == NULL for a multi-surface will remove all traits at the root level of the multi-surface, whereas specifying regex == kFME_RecurseSome <string> will remove all traits from all levels of the multi surface that match <string>. If <string> is an illegal regular expression, no traits will be removed.

Return type:: None

renameMeasure(oldMeasureName, newMeasureName)

Renames the measure specified by ‘oldMeasureName’ to the new name, specified by ‘newMeasureName’.

Parameters:

oldMeasureName (str) – The original name of the measure.
newMeasureName (str) – The new name of the measure.

Return type:

None

rotate2D(center, angle)

The angle is CCW up from the horizontal and is measured in degrees.

Parameters:

center (FMEPoint) – The center of the rotation.
angle (float) – The angle in degrees.

Return type:

None

Raises:

FMEException – An exception is raised if an error occurred.

scaleXYZ()

scaleXYZT(xscale, yscale, zscale, scaleText)

scaleXYZ(xscale, yscale, zscale)

Applies a scale factor to the MultiText. The ‘zscale’ is ignored if geometry is 2D.

Parameters:

xscale (float) – The x scale factor.
yscale (float) – The y scale factor.
zscale (float) – The z scale factor.

Return type:

None

Raises:

FMEException – An exception is raised if an error occurred.

scaleXYZT(xscale, yscale, zscale, scaleText)

scaleXYZ(xscale, yscale, zscale)

Applies a scale factor to the MultiText. The ‘zscale’ is ignored if geometry is 2D.

Parameters:

xscale (float) – The x scale factor.
yscale (float) – The y scale factor.
zscale (float) – The z scale factor.
scaleText (bool) – bool indicating whether of not to scale the text.

Return type:

None

Raises:

FMEException – An exception is raised if an error occurred.

setLabel(name)

Sets the geometry’s label with a str. By supplying a blank label as input, this method will act as deleteLabel(). This method replaces the deprecated setName() method.

Parameters:: name (str) – The geometry’s new label.
Return type:: None

setTrait(traitName, traitValue)

Sets a geometry trait with the specified value. If the geometry trait already exists, its value and type will be changed. The following type numeric mappings are used:

PyInt ==> FME_Int32

PyFloat ==> FME_Real64

PyLong ==> FME_Int64

Binary values are to be specified as bytearray values or bytes values.

Parameters:

traitName (str) – The name of the geometry trait.
traitValue (bool, int, float, str, bytearray, or bytes) – The value of the geometry trait.

Return type:

None

setTraitNullWithType(traitName, traitType)

This method supplies a null trait value with a type to the geometry. If a trait with the same name already exists, it is overwritten.

Trait type must be one of FME_ATTR_UNDEFINED, FME_ATTR_BOOLEAN, FME_ATTR_INT8, FME_ATTR_UINT8, FME_ATTR_INT16, FME_ATTR_UINT16, FME_ATTR_INT32, FME_ATTR_UINT32, FME_ATTR_REAL32, FME_ATTR_REAL64, FME_ATTR_REAL80, FME_ATTR_STRING, FME_ATTR_ENCODED_STRING, FME_ATTR_INT64, FME_ATTR_UINT64.

Parameters:

traitName (str) – The trait’s name.
traitType (int) – An integer representing the trait type.

Return type:

None