LuciadCPillar C# 2023.1.05
Luciad.Models.Features.FeatureModelUpdate.Builder Class Reference

Builder that allows FeatureModelUpdate instances to be created. More...

Inheritance diagram for Luciad.Models.Features.FeatureModelUpdate.Builder:

Public Member Functions

 Builder (Luciad.Models.Features.FeatureModelUpdate.Builder other)
 
Luciad.Models.Features.FeatureModelUpdate.Builder AddFeature (Luciad.Models.Features.Feature newFeature)
 Adds the given Feature to the model. More...
 
Luciad.Models.Features.FeatureModelUpdate Build ()
 Build the FeatureModelUpdate instance. More...
 
void Dispose ()
 
Luciad.Models.Features.FeatureModelUpdate.Builder RemoveFeature (ulong featureId)
 Removes the feature with the given id from the model. More...
 
Luciad.Models.Features.FeatureModelUpdate.Builder UpdateFeature (Luciad.Models.Features.Feature newFeature)
 This method is called to replace the Feature with the same id. More...
 
Luciad.Models.Features.FeatureModelUpdate.Builder UpdaterCallback (Luciad.Models.Features.IFeatureUpdaterCallback updaterCallback)
 Sets the callback that must be called by IFeatureModelUpdater::update to inform that this update was successful or not, or to notify that features were added. More...
 

Detailed Description

Builder that allows FeatureModelUpdate instances to be created.

2020.1

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureModelUpdate::Builder.

Constructor & Destructor Documentation

◆ Builder()

Luciad.Models.Features.FeatureModelUpdate.Builder.Builder ( Luciad.Models.Features.FeatureModelUpdate.Builder  other)
inline

Member Function Documentation

◆ AddFeature()

Luciad.Models.Features.FeatureModelUpdate.Builder Luciad.Models.Features.FeatureModelUpdate.Builder.AddFeature ( Luciad.Models.Features.Feature  newFeature)
inline

Adds the given Feature to the model.

This Feature may not have an id yet. In that case, IFeatureModelUpdater::update is responsible for assigning an id to the feature when adding it to the model. In general, callers of this method can not assign id's to Features. There are a few exceptions though. Passing an id with Feature can for example be useful for in-memory models like FeatureModelBuilder, where the caller may want to assign id's to features. If a Feature with an id is passed to this method, the id must be unique. When adding the feature is finished, the given callback should be called with the newly added Feature (with id). When the Feature could not be added, the callback should be called as well to notify this.

newFeature

the new Feature

this builder

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureModelUpdate::Builder::addFeature.

◆ Build()

Luciad.Models.Features.FeatureModelUpdate Luciad.Models.Features.FeatureModelUpdate.Builder.Build ( )
inline

Build the FeatureModelUpdate instance.

the feature model update.

luciad::LogicException

If no changes were configured.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureModelUpdate::Builder::build.

◆ Dispose()

void Luciad.Models.Features.FeatureModelUpdate.Builder.Dispose ( )
inline

◆ RemoveFeature()

Luciad.Models.Features.FeatureModelUpdate.Builder Luciad.Models.Features.FeatureModelUpdate.Builder.RemoveFeature ( ulong  featureId)
inline

Removes the feature with the given id from the model.

featureId

a feature id

this builder

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureModelUpdate::Builder::removeFeature.

◆ UpdateFeature()

Luciad.Models.Features.FeatureModelUpdate.Builder Luciad.Models.Features.FeatureModelUpdate.Builder.UpdateFeature ( Luciad.Models.Features.Feature  newFeature)
inline

This method is called to replace the Feature with the same id.

newFeature

the new Feature

this builder

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureModelUpdate::Builder::updateFeature.

◆ UpdaterCallback()

Luciad.Models.Features.FeatureModelUpdate.Builder Luciad.Models.Features.FeatureModelUpdate.Builder.UpdaterCallback ( Luciad.Models.Features.IFeatureUpdaterCallback  updaterCallback)
inline

Sets the callback that must be called by IFeatureModelUpdater::update to inform that this update was successful or not, or to notify that features were added.

This method is optional.

updaterCallback

the updater callback

this builder

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureModelUpdate::Builder::updaterCallback.