[#BloombergLP-bdlar-SequenceRef]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlar.adoc[bdlar]::SequenceRef
:relfileprefix: ../../
:mrdocs:

== Synopsis

Declared in `<bdlar_sequenceref.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class SequenceRef;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlar/SequenceRef/2constructor-01.adoc[`SequenceRef`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlar/SequenceRef/accessAttribute-01.adoc[`accessAttribute`] 
| `accessAttribute` overloads
| xref:BloombergLP/bdlar/SequenceRef/accessAttributes.adoc[`accessAttributes`] 
| Invoke the specified `accessor` sequentially on each attribute, supplying `accessor` with the corresponding attribute information structure until such invocation returns a non‐zero value. 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 ATTRIBUTE& refOrValue, const t_INFO& info); ` Return the value from the last invocation of `accessor` (i.e., the invocation that terminated the sequence).
| xref:BloombergLP/bdlar/SequenceRef/hasAttribute-0d.adoc[`hasAttribute`] 
| `hasAttribute` overloads
| xref:BloombergLP/bdlar/SequenceRef/manipulateAttribute-01.adoc[`manipulateAttribute`] 
| `manipulateAttribute` overloads
| xref:BloombergLP/bdlar/SequenceRef/manipulateAttributes.adoc[`manipulateAttributes`] 
| Invoke the specified `manipulator` sequentially on each (modifiable) attribute, supplying `manipulator` with the corresponding attribute information structure until such invocation returns non‐zero value. 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(ATTRIBUTE *refOrValue, const t_INFO& info); ` Return the value from the last invocation of `manipulator` (i.e., the invocation that terminated the sequence).
| xref:BloombergLP/bdlar/SequenceRef/objectAddress.adoc[`objectAddress`] 
| Return a pointer to the wrapped object.
| xref:BloombergLP/bdlar/SequenceRef/reset.adoc[`reset`] 
| Reset the referred object to the default value.
| xref:BloombergLP/bdlar/SequenceRef/vtable.adoc[`vtable`] 
| Return a pointer to the vtable.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlar/bdlat_sequenceAccessAttribute-056.adoc[`bdlat_sequenceAccessAttribute`]
| Invoke the specified `accessor` on the attribute of the specified `ref` identified by the specified `attributeId`. Return the value from the invocation of `accessor`.
| xref:BloombergLP/bdlar/bdlat_sequenceAccessAttribute-0a9.adoc[`bdlat_sequenceAccessAttribute`]
| Invoke the specified `accessor` on the attribute of the specified `ref` identified by the specified `attributeName` and `attributeNameLength`. Return the value from the invocation of `accessor`.
| xref:BloombergLP/bdlar/bdlat_sequenceAccessAttributes-0a.adoc[`bdlat_sequenceAccessAttributes`]
| Invoke the specified `accessor` on each attribute of the specified `ref`. Return the value from the invocation of `accessor`.
| xref:BloombergLP/bdlar/bdlat_sequenceHasAttribute-07.adoc[`bdlat_sequenceHasAttribute`]
| Return `true` if the specified `ref` has an attribute with the specified `attributeId`, and `false` otherwise.
| xref:BloombergLP/bdlar/bdlat_sequenceHasAttribute-08.adoc[`bdlat_sequenceHasAttribute`]
| Return `true` if the specified `ref` has an attribute with the specified `attributeName` of the specified `attributeNameLength`, and `false` otherwise.
| xref:BloombergLP/bdlar/bdlat_sequenceManipulateAttribute-08.adoc[`bdlat_sequenceManipulateAttribute`]
| Invoke the specified `manipulator` on the attribute of the specified `ref` identified by the specified `attributeId`. Return the value from the invocation of `manipulator`.
| xref:BloombergLP/bdlar/bdlat_sequenceManipulateAttribute-0f.adoc[`bdlat_sequenceManipulateAttribute`]
| Invoke the specified `manipulator` on the attribute of the specified `ref` identified by the specified `attributeName` and `attributeNameLength`. Return the value from the invocation of `manipulator`.
| xref:BloombergLP/bdlar/bdlat_sequenceManipulateAttributes.adoc[`bdlat_sequenceManipulateAttributes`]
| Invoke the specified `manipulator` on each attribute of the specified `ref`. Return the value from the invocation of `manipulator`.
| xref:BloombergLP/bdlar/bdlat_valueTypeReset-0de.adoc[`bdlat_valueTypeReset`]
| Reset the specified `ref` to the default value.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#