[#BloombergLP-bslalg-BidirectionalNode]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslalg.adoc[bslalg]::BidirectionalNode
:relfileprefix: ../../
:mrdocs:

POD‐like node holding a `VALUE` in a doubly‐linked list.

== Synopsis

Declared in `<bslalg_bidirectionalnode.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class VALUE>
class BidirectionalNode
    : public xref:BloombergLP/bslalg/BidirectionalLink.adoc[bslalg::BidirectionalLink]
----

== Description

This POD‐like `class` describes a node suitable for use in a doubly‐linked list of values of the template parameter type `VALUE`. This class is a "POD‐like" to facilitate efficient allocation and use in the context of a container implementation. In order to meet the essential requirements of a POD type, this `class` does not define a constructor or destructor. The manipulator, `value`, returns a modifiable reference to `d_value` so that it may be constructed in‐place by the appropriate `bsl::allocator_traits` object.

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslalg/BidirectionalLink.adoc[bslalg::BidirectionalLink]`
| A node in a doubly‐linked (bidirectional) list.
|===

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslalg/BidirectionalNode/ValueType.adoc[`ValueType`] 
| Payload type stored in this node.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslalg/BidirectionalLink/nextLink.adoc[`nextLink`] 
| Return the address of the next node linked from this node.
| xref:BloombergLP/bslalg/BidirectionalLink/previousLink.adoc[`previousLink`] 
| Return the address of the preceding node linked from this node.
| xref:BloombergLP/bslalg/BidirectionalLink/reset.adoc[`reset`] 
| Set the `nextLink` and `previousLink` attributes of this value to 0.
| xref:BloombergLP/bslalg/BidirectionalLink/setNextLink.adoc[`setNextLink`] 
| Set the successor of this node to be the specified `next` link.
| xref:BloombergLP/bslalg/BidirectionalLink/setPreviousLink.adoc[`setPreviousLink`] 
| Set the predecessor of this node to be the specified `previous` link.
| xref:BloombergLP/bslalg/BidirectionalNode/value-09.adoc[`value`] 
| `value` overloads
|===



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