LuciadCPillar 2023.1.04
luciad::FeatureStateEvent Class Referencefinal

This class is used by IFeatureStateObserver to pass information about FeatureState changes. More...

#include <luciad/layers/features/FeatureStateManager.h>

Public Member Functions

bool getChange (const FeatureState &featureState, const LayerFeatureId &layerFeatureId) const
 Returns the new value of the feature state for the given feature. More...
 
std::vector< LayerFeatureIdgetChangedFeatures (const FeatureState &featureState) const
 Returns the list of features for which the given feature state has been changed. More...
 
std::vector< FeatureStategetChangedFeatureStates () const
 Returns the list of feature states that has been changed for at least one Feature in this event. More...
 

Detailed Description

This class is used by IFeatureStateObserver to pass information about FeatureState changes.

It allows you to inspect which features have been changed, and their new values. One call to FeatureStateManager::applyStateChange will result in one FeatureStateEvent instance.

See FeatureStateManager for a usage example.

Member Function Documentation

◆ getChange()

bool luciad::FeatureStateEvent::getChange ( const FeatureState featureState,
const LayerFeatureId layerFeatureId 
) const

Returns the new value of the feature state for the given feature.

Parameters
featureStatea feature state
layerFeatureIda feature
Returns
the new value of the feature state for the given feature.

◆ getChangedFeatures()

std::vector< LayerFeatureId > luciad::FeatureStateEvent::getChangedFeatures ( const FeatureState featureState) const

Returns the list of features for which the given feature state has been changed.

Parameters
featureStatea feature state
Returns
the list of features for which the given feature state has been changed.

◆ getChangedFeatureStates()

std::vector< FeatureState > luciad::FeatureStateEvent::getChangedFeatureStates ( ) const

Returns the list of feature states that has been changed for at least one Feature in this event.

Returns
the list of feature states that has been changed for at least one Feature in this event.