SegmentDefinitionSetElementAndAdapter Method

Add or sets an adapter for an element in this segment.

Note that many types of derived segments will automatically handle their adapters by interrogating properties specific to the derived segment. Also some segments whose PassAllElementsToNextSegment property is do not require adapters or elements to be set.

These adapters have the responsibility of processing the initial state that the propagator will start propagating from. They will modify the initial state passed to this segment so that the state is in a form that the propagator can process.

Namespace: AGI.Foundation.SegmentPropagation
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.3.420.0 (24.3.420.0)

Syntax

C++

Copy

public virtual bool SetElementAndAdapter(
	StateElementAdapterDefinition adapter
)

Public Overridable Function SetElementAndAdapter ( 
	adapter As StateElementAdapterDefinition
) As Boolean

public:
virtual bool SetElementAndAdapter(
	StateElementAdapterDefinition^ adapter
)

abstract SetElementAndAdapter : 
        adapter : StateElementAdapterDefinition -> bool 
override SetElementAndAdapter : 
        adapter : StateElementAdapterDefinition -> bool

Parameters

adapter: Type: AGI.Foundation.CoordinatesStateElementAdapterDefinition
An instance of the factory that makes the adapter. This must be configured with the current defined in object (if appropriate) and with the element identification.

Return Value

Type: Boolean
if the element was added or set successfully; otherwise . does not indicate an error; it means that this segment does not need elements and adapters explicitly set.

Reference

SegmentDefinition Class

AGI.Foundation.SegmentPropagation Namespace

SegmentDefinitionAddLanguageSpecificTextSet("LSTBA69DE94_0?cpp=::|nu=.");SetElementAndAdapter Method

Parameters

Return Value

Reference

SegmentDefinitionSetElementAndAdapter Method