Synopsis

Declared in <bdlar_choiceref.h>

class ChoiceRef;

Member Functions

Name

Description

ChoiceRef [constructor]

Constructors

accessSelection

Invoke the specified accessor on the (non‐modifiable) selection, supplying accessor with the corresponding selection information structure. The supplied accessor must be a callable type that can be called as if it had the following signature: ` template <class t_INFO> int accessor(const SELECTION& refOrValue, const t_INFO& info); ` Return the value returned from the invocation of accessor. The behavior is undefined unless selectionId() != ‐1.

hasSelection

hasSelection overloads

makeSelection

makeSelection overloads

manipulateSelection

Invoke the specified manipulator on the address of the (modifiable) selection, supplying manipulator with the corresponding selection information structure. The supplied manipulator must be a callable type that can be called as if it had the following signature: ` template <class t_INFO> int manipulator(SELECTION *refOrValue, const t_INFO& info); ` Return the value returned from the invocation of manipulator. The behavior is undefined unless selectionId() != ‐1.

objectAddress

Return a pointer to the wrapped array.

reset

Reset the referred object to the default value.

selectionId

Return the id of the current selection if the selection is defined, and ‐1 otherwise.

vtable

Return a pointer to the vtable.

Non-Member Functions

Name

Description

bdlat_choiceAccessSelection

Invoke the specified accessor on the current selection of the specified ref. Return the value from the invocation of accessor.

bdlat_choiceHasSelection

Return whether the specified ref has the selection with the specified selectionName and selectionNameLength.

bdlat_choiceHasSelection

Return whether the specified ref has the selection with the specified selectionId.

bdlat_choiceMakeSelection

Make the selection identified by the specified selectionId in the specified ref.

bdlat_choiceMakeSelection

Make the selection identified by the specified selectionName of the specified selectionNameLength in the specified ref.

bdlat_choiceManipulateSelection

Invoke the specified manipulator on the current selection of the specified ref. Return the value from the invocation of manipulator.

bdlat_choiceSelectionId

Return the id of the current selection if the selection is defined, and ‐1 otherwise.

bdlat_valueTypeReset

Reset the specified ref to its default‐constructed state.

Created with MrDocs