TPG.GeoFramework.Style.Core.Contracts.Condition.ICondition Interface Reference

Base class for condition objects. Condition objects allows conditional system behaviour depending on properties of the system (context parameter) and an object or object collection (conditionObjectAccessor) Typical usage is in conditional track and object styling. Complex, nested conditions can be made using derived classes. More...

Inheritance diagram for TPG.GeoFramework.Style.Core.Contracts.Condition.ICondition:

Public Member Functions
bool	IsSatisfied (IItemContext context, IGenericGeoObjectAdapter conditionObjectAccessor)
	Depends true if condition is satisfied, otherwise false.
bool	GetConditionObjectFieldReferences (HashSet< string > target)
	Most conditions depend on some field/value within the object they operate on.
ICondition	Clone ()
	Creates a clone of condition. Any child-conditions are also cloned.

Detailed Description

Base class for condition objects. Condition objects allows conditional system behaviour depending on properties of the system (context parameter) and an object or object collection (conditionObjectAccessor) Typical usage is in conditional track and object styling. Complex, nested conditions can be made using derived classes.

Member Function Documentation

Clone()

ICondition TPG.GeoFramework.Style.Core.Contracts.Condition.ICondition.Clone

(

)

Creates a clone of condition. Any child-conditions are also cloned.

Returns

Cloned condition

Implemented in TPG.GeoFramework.StyleCore.Condition.AgeCondition, TPG.GeoFramework.StyleCore.Condition.CompositeCondition, TPG.GeoFramework.StyleCore.Condition.ContextStateCondition, TPG.GeoFramework.StyleCore.Condition.ContextVariableCondition, TPG.GeoFramework.StyleCore.Condition.FalseCondition, TPG.GeoFramework.StyleCore.Condition.FieldCondition, TPG.GeoFramework.StyleCore.Condition.GeoCondition, TPG.GeoFramework.StyleCore.Condition.MapScaleCondition, TPG.GeoFramework.StyleCore.Condition.SpeedCondition, TPG.GeoFramework.StyleCore.Condition.TimeValidCondition, TPG.GeoFramework.StyleCore.Condition.TrueCondition, TPG.DrawObjects.Data.Filters.DrawObjectGeoCondition, TPG.GeoFramework.TrackCore.TrackFieldMultiValueCondition, and TPG.GeoFramework.TrackCore.TrackTextSearchQuery.

GetConditionObjectFieldReferences()

bool TPG.GeoFramework.Style.Core.Contracts.Condition.ICondition.GetConditionObjectFieldReferences

(

HashSet< string >

target

)

Most conditions depend on some field/value within the object they operate on.

Parameters

target

All field references of condition and children are placed here

Returns

true if field reference is extracted or if field reference is irrelevant. false if field reference cannot be extracted, and condition is not constant relative to object

Implemented in TPG.GeoFramework.StyleCore.Condition.AgeCondition, TPG.GeoFramework.StyleCore.Condition.CompositeCondition, TPG.GeoFramework.StyleCore.Condition.ContextStateCondition, TPG.GeoFramework.StyleCore.Condition.ContextVariableCondition, TPG.GeoFramework.StyleCore.Condition.FalseCondition, TPG.GeoFramework.StyleCore.Condition.FieldCondition, TPG.GeoFramework.StyleCore.Condition.GeoCondition, TPG.GeoFramework.StyleCore.Condition.SpeedCondition, TPG.GeoFramework.StyleCore.Condition.TimeValidCondition, TPG.GeoFramework.StyleCore.Condition.TrueCondition, TPG.DrawObjects.Data.Filters.DrawObjectGeoCondition, TPG.GeoFramework.TrackCore.TrackFieldMultiValueCondition, and TPG.GeoFramework.TrackCore.TrackTextSearchQuery.

IsSatisfied()

bool TPG.GeoFramework.Style.Core.Contracts.Condition.ICondition.IsSatisfied	(	IItemContext	context,
		IGenericGeoObjectAdapter	conditionObjectAccessor
	)

Depends true if condition is satisfied, otherwise false.

Parameters

context	Contains system parameters such as geo contest, settings and variables
conditionObjectAccessor	Object to test (typically track or draw object)

Returns

true if satisfied, otherwise false

Implemented in TPG.DrawObjects.Data.Filters.DrawObjectGeoCondition, TPG.GeoFramework.StyleCore.Condition.CompositeCondition, TPG.GeoFramework.StyleCore.Condition.ContextStateCondition, TPG.GeoFramework.StyleCore.Condition.ContextVariableCondition, TPG.GeoFramework.StyleCore.Condition.FieldCondition, TPG.GeoFramework.StyleCore.Condition.GeoCondition, TPG.GeoFramework.StyleCore.Condition.SpeedCondition, TPG.GeoFramework.TrackCore.TrackTextSearchQuery, TPG.GeoFramework.StyleCore.Condition.AgeCondition, TPG.GeoFramework.StyleCore.Condition.FalseCondition, TPG.GeoFramework.StyleCore.Condition.MapScaleCondition, TPG.GeoFramework.StyleCore.Condition.TimeValidCondition, TPG.GeoFramework.StyleCore.Condition.TrueCondition, and TPG.GeoFramework.TrackCore.TrackFieldMultiValueCondition.

---

The documentation for this interface was generated from the following file:

• Src/Common/TPG.GeoFramework.Style.Core.Contracts/Condition/ICondition.cs