ReadOperator Class

Represents an operator that reads Feature elements from a DataSet.

Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.17.0.nupkg (in the CECore assembly)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

public class ReadOperator : Operator

Remarks

All layers that read data from a DataSet must have a ReadOperator first. If the DataSet contains visualization information then the ReadOperator connects a Visualizer to the features. Otherwise there must be a VisualizationOperator in the layer to get a presentation.

Example

// Create a ReadOperator, that reads all features from a MemoryDataSet
public static ReadOperator CreateReadOperatorWithMemoryDataSet()
{
    // Create a MemoryDataSet
    MemoryDataSet dataSet = new MemoryDataSet();

    // Create a ReadOperator, that reads from a MemoryDataSet
    return new ReadOperator(dataSet);
}

Inheritance Hierarchy

System.Object
  EngineObject
    Operator
      ReadOperator

Platforms

Windows, Linux, Android

ReadOperator Members

The ReadOperator type has the following members.

Constructors

Name	Description
ReadOperator	Initializes a new instance of the ReadOperator class.

Properties

Name	Description
DataSet	Gets or sets the DataSet that the operator reads features from.
Description	Gets or sets a short description of the operator. Inherited from Operator
DisplayName	Gets or sets a display name for the operator. Inherited from Operator
IsDisposed	Gets a value that tells whether the current ReadOperator has been disposed. Inherited from EngineObject
IsoMetadataDocument	Gets or sets the path to an ISO 19139 metadata document for the operator. Inherited from Operator
Name	Gets or sets the name of the operator. Inherited from Operator
NativeHandle	Gets the native Carmenta Engine kernel object the current ReadOperator represents. Inherited from EngineObject
Query	Gets or sets the additional query parameters the operator uses when it reads from the DataSet.
IUserProperties.UserProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties

Methods

Name	Description
Clone	Creates a copy of an object. Inherited from EngineObject
Dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
Equals	Determines whether this instance is equal to another. Inherited from EngineObject
FindChildObject	Overloaded. Finds the child object with the specified name. Inherited from Operator
FlushCache	Removes the objects that have been cached by the operator. Inherited from Operator
GetChildObjects	Overloaded. Gets the child objects of the current object. Inherited from Operator
GetFeatures	Overloaded. Gets features from the operator chain. Inherited from Operator
GetLocalizedDescription	Gets a localized version of the operator description in a specific language. Inherited from Operator
GetLocalizedDisplayName	Gets a localized version of the operator display name in a specific language. Inherited from Operator
GetLocalizedIsoMetadataDocument	Gets the path to an ISO 19139 metadata document for a specific language. Inherited from Operator
GetRasterFeature	Overloaded. Gets raster features from the operator chain and merges them into a single raster. Inherited from Operator
HasLocalizedDescription	Checks if a localized version of the operator description is available in a specific language. Inherited from Operator
HasLocalizedDisplayName	Checks if a localized version of the operator display name is available in a specific language. Inherited from Operator
HasLocalizedIsoMetadataDocument	Checks if an ISO 19139 metadata document is available for a specific language. Inherited from Operator
SetLocalizedDescription	Sets a operator description in a specific language. Inherited from Operator
SetLocalizedDisplayName	Sets a operator display name in a specific language. Inherited from Operator
SetLocalizedIsoMetadataDocument	Sets the path to an ISO 19139 metadata document for the operator, for a specific language. Inherited from Operator

ReadOperator Class

Represents an operator that reads Feature elements from a DataSet.

Namespace: Carmenta::Engine
Include: <Carmenta/Engine/Core.hpp>
Dynamic link library: CECore.Cpp.dll
Library: CECore.Cpp.lib

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

C++

class ReadOperator : public Operator

C++ Smart Pointer Declaration

typedef Ptr<ReadOperator> ReadOperatorPtr;

Remarks

Example

C++

// Create a ReadOperator, that reads all features from a MemoryDataSet
static ReadOperatorPtr createReadOperatorWithMemoryDataSet()
{
    // Create a MemoryDataSet
    MemoryDataSetPtr dataSet = new MemoryDataSet();

    // Create a ReadOperator, that reads from a MemoryDataSet
    return new ReadOperator(dataSet);
}

Inheritance Hierarchy

EngineObject
Operator
ReadOperator

Platforms

Windows, Linux, Android

ReadOperator Members

The ReadOperator type has the following members.

Constructors

Name	Description
ReadOperator	Initializes a new instance of the ReadOperator class.

Properties

Name	Description
dataSet	Gets or sets the DataSet that the operator reads features from.
description	Gets or sets a short description of the operator. Inherited from Operator
displayName	Gets or sets a display name for the operator. Inherited from Operator
isoMetadataDocument	Gets or sets the path to an ISO 19139 metadata document for the operator. Inherited from Operator
name	Gets or sets the name of the operator. Inherited from Operator
query	Gets or sets the additional query parameters the operator uses when it reads from the DataSet.
IUserProperties::userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject
findChildObject	Overloaded. Finds the child object with the specified name. Inherited from Operator
flushCache	Removes the objects that have been cached by the operator. Inherited from Operator
getChildObjects	Overloaded. Gets the child objects of the current object. Inherited from Operator
getFeatures	Overloaded. Gets features from the operator chain. Inherited from Operator
getLocalizedDescription	Gets a localized version of the operator description in a specific language. Inherited from Operator
getLocalizedDisplayName	Gets a localized version of the operator display name in a specific language. Inherited from Operator
getLocalizedIsoMetadataDocument	Gets the path to an ISO 19139 metadata document for a specific language. Inherited from Operator
getRasterFeature	Overloaded. Gets raster features from the operator chain and merges them into a single raster. Inherited from Operator
hasLocalizedDescription	Checks if a localized version of the operator description is available in a specific language. Inherited from Operator
hasLocalizedDisplayName	Checks if a localized version of the operator display name is available in a specific language. Inherited from Operator
hasLocalizedIsoMetadataDocument	Checks if an ISO 19139 metadata document is available for a specific language. Inherited from Operator
setLocalizedDescription	Sets a operator description in a specific language. Inherited from Operator
setLocalizedDisplayName	Sets a operator display name in a specific language. Inherited from Operator
setLocalizedIsoMetadataDocument	Sets the path to an ISO 19139 metadata document for the operator, for a specific language. Inherited from Operator

ReadOperator Class

Represents an operator that reads Feature elements from a DataSet.

Package: com.carmenta.engine.core
JAR file: CECore.Java.jar

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Java

public class ReadOperator extends Operator

Remarks

Example

Java

// Create a ReadOperator, that reads all features from a MemoryDataSet
public static ReadOperator createReadOperatorWithMemoryDataSet()
{
    // Create a MemoryDataSet
    MemoryDataSet dataSet = new MemoryDataSet();

    // Create a ReadOperator, that reads from a MemoryDataSet
    return new ReadOperator(dataSet);
}

Inheritance Hierarchy

java.lang.Object
  EngineObject
    Operator
      ReadOperator

Platforms

Windows, Linux, Android

ReadOperator Members

The ReadOperator type has the following members.

Constructors

Name	Description
ReadOperator	Initializes a new instance of the ReadOperator class.

Properties

Name	Description
dataSet	Gets or sets the DataSet that the operator reads features from.
description	Gets or sets a short description of the operator. Inherited from Operator
displayName	Gets or sets a display name for the operator. Inherited from Operator
isDisposed	Gets a value that tells whether the current ReadOperator has been disposed. Inherited from EngineObject
isoMetadataDocument	Gets or sets the path to an ISO 19139 metadata document for the operator. Inherited from Operator
name	Gets or sets the name of the operator. Inherited from Operator
query	Gets or sets the additional query parameters the operator uses when it reads from the DataSet.
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject
findChildObject	Overloaded. Finds the child object with the specified name. Inherited from Operator
flushCache	Removes the objects that have been cached by the operator. Inherited from Operator
getChildObjects	Overloaded. Gets the child objects of the current object. Inherited from Operator
getFeatures	Overloaded. Gets features from the operator chain. Inherited from Operator
getLocalizedDescription	Gets a localized version of the operator description in a specific language. Inherited from Operator
getLocalizedDisplayName	Gets a localized version of the operator display name in a specific language. Inherited from Operator
getLocalizedIsoMetadataDocument	Gets the path to an ISO 19139 metadata document for a specific language. Inherited from Operator
getRasterFeature	Overloaded. Gets raster features from the operator chain and merges them into a single raster. Inherited from Operator
hasLocalizedDescription	Checks if a localized version of the operator description is available in a specific language. Inherited from Operator
hasLocalizedDisplayName	Checks if a localized version of the operator display name is available in a specific language. Inherited from Operator
hasLocalizedIsoMetadataDocument	Checks if an ISO 19139 metadata document is available for a specific language. Inherited from Operator
setLocalizedDescription	Sets a operator description in a specific language. Inherited from Operator
setLocalizedDisplayName	Sets a operator display name in a specific language. Inherited from Operator
setLocalizedIsoMetadataDocument	Sets the path to an ISO 19139 metadata document for the operator, for a specific language. Inherited from Operator

ReadOperator Class

Represents an operator that reads Feature elements from a DataSet.

Module: Carmenta.Engine.Core (in Core.pyd)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Python

class ReadOperator ( Operator )

Remarks

Example

Python

# This example is not available in the selected language.

Inheritance Hierarchy

EngineObject
Operator
ReadOperator

Platforms

Windows, Linux, Android

ReadOperator Members

The ReadOperator type has the following members.

Constructors

Name	Description
ReadOperator	Initializes a new instance of the ReadOperator class.

Properties

Name	Description
dataSet	Gets or sets the DataSet that the operator reads features from.
description	Gets or sets a short description of the operator. Inherited from Operator
displayName	Gets or sets a display name for the operator. Inherited from Operator
isoMetadataDocument	Gets or sets the path to an ISO 19139 metadata document for the operator. Inherited from Operator
name	Gets or sets the name of the operator. Inherited from Operator
query	Gets or sets the additional query parameters the operator uses when it reads from the DataSet.
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject
findChildObject	Overloaded. Finds the child object with the specified name. Inherited from Operator
flushCache	Removes the objects that have been cached by the operator. Inherited from Operator
getChildObjects	Overloaded. Gets the child objects of the current object. Inherited from Operator
getFeatures	Overloaded. Gets features from the operator chain. Inherited from Operator
getLocalizedDescription	Gets a localized version of the operator description in a specific language. Inherited from Operator
getLocalizedDisplayName	Gets a localized version of the operator display name in a specific language. Inherited from Operator
getLocalizedIsoMetadataDocument	Gets the path to an ISO 19139 metadata document for a specific language. Inherited from Operator
getRasterFeature	Overloaded. Gets raster features from the operator chain and merges them into a single raster. Inherited from Operator
hasLocalizedDescription	Checks if a localized version of the operator description is available in a specific language. Inherited from Operator
hasLocalizedDisplayName	Checks if a localized version of the operator display name is available in a specific language. Inherited from Operator
hasLocalizedIsoMetadataDocument	Checks if an ISO 19139 metadata document is available for a specific language. Inherited from Operator
setLocalizedDescription	Sets a operator description in a specific language. Inherited from Operator
setLocalizedDisplayName	Sets a operator display name in a specific language. Inherited from Operator
setLocalizedIsoMetadataDocument	Sets the path to an ISO 19139 metadata document for the operator, for a specific language. Inherited from Operator

ReadOperator Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

ReadOperator Members

ReadOperator Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

ReadOperator Members

ReadOperator Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

ReadOperator Members

ReadOperator Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

ReadOperator Members