BDE 4.14.0 Production release
Loading...
Searching...
No Matches
bdlb::VariantImp< TYPES > Class Template Reference

#include <bdlb_variant.h>

Inheritance diagram for bdlb::VariantImp< TYPES >:
bdlb::Variant< Bool, Char, Int, Int64, Double, String, Datetime, Date, Time, CharArray, IntArray, Int64Array, DoubleArray, StringArray, DatetimeArray, DateArray, TimeArray, OptionValue_NullOf > bdlb::Variant< int, long, long long, unsigned int, unsigned long, unsigned long long, bsl::string, const void *, bdlb::Guid > bdlb::Variant< bsls::Types::Int64, double, bsl::string, bdlt::DatetimeTz, bsl::vector< char > > bdlb::Variant< JsonObject, JsonArray, bsl::string, JsonNumber, bool, JsonNull > bdlb::Variant< Gauge > bdlb::Variant< A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20 >

Public Member Functions

 BSLMF_NESTED_TRAIT_DECLARATION_IF (VariantImp, bslma::UsesBslmaAllocator, Traits::k_VARIANT_USES_BSLMA_ALLOCATOR)
 
 BSLMF_NESTED_TRAIT_DECLARATION_IF (VariantImp, bslmf::IsBitwiseCopyable, Traits::k_VARIANT_IS_BITWISE_COPYABLE)
 
 BSLMF_NESTED_TRAIT_DECLARATION_IF (VariantImp, bslmf::IsBitwiseMoveable, Traits::k_VARIANT_IS_BITWISE_MOVEABLE)
 
 BSLMF_NESTED_TRAIT_DECLARATION (VariantImp, HasPrintMethod)
 
 VariantImp ()
 
template<class TYPE_OR_ALLOCATOR >
 VariantImp (const TYPE_OR_ALLOCATOR &valueOrAllocator)
 
template<class TYPE >
 VariantImp (const TYPE &value, bslma::Allocator *basicAllocator)
 
template<class TYPE >
 VariantImp (bslmf::MovableRef< TYPE > value)
 
template<class TYPE >
 VariantImp (bslmf::MovableRef< TYPE > value, bslma::Allocator *basicAllocator)
 
 VariantImp (const VariantImp &original, bslma::Allocator *basicAllocator=0)
 
 VariantImp (bslmf::MovableRef< VariantImp > original)
 
 VariantImp (bslmf::MovableRef< VariantImp > original, bslma::Allocator *basicAllocator)
 
 ~VariantImp ()
 
template<class TYPE >
VariantImpoperator= (const TYPE &value)
 
template<class TYPE >
VariantImpoperator= (bslmf::MovableRef< TYPE > value)
 
VariantImpoperator= (const VariantImp &rhs)
 
VariantImpoperator= (bslmf::MovableRef< VariantImp > rhs)
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type apply (VISITOR &visitor)
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type apply (const VISITOR &visitor)
 
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type apply (VISITOR &visitor, const TYPE &defaultValue)
 
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type apply (const VISITOR &visitor, const TYPE &defaultValue)
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type apply (VISITOR &visitor)
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type apply (const VISITOR &visitor)
 
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type apply (VISITOR &visitor, const TYPE &defaultValue)
 
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type apply (const VISITOR &visitor, const TYPE &defaultValue)
 
template<class RET_TYPE , class VISITOR >
RET_TYPE apply (VISITOR &visitor)
 
template<class RET_TYPE , class VISITOR >
RET_TYPE apply (const VISITOR &visitor)
 
template<class RET_TYPE , class VISITOR , class TYPE >
RET_TYPE apply (VISITOR &visitor, const TYPE &defaultValue)
 
template<class RET_TYPE , class VISITOR , class TYPE >
RET_TYPE apply (const VISITOR &visitor, const TYPE &defaultValue)
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type applyRaw (VISITOR &visitor)
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type applyRaw (const VISITOR &visitor)
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type applyRaw (VISITOR &visitor)
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type applyRaw (const VISITOR &visitor)
 
template<class RET_TYPE , class VISITOR >
RET_TYPE applyRaw (VISITOR &visitor)
 
template<class RET_TYPE , class VISITOR >
RET_TYPE applyRaw (const VISITOR &visitor)
 
template<class TYPE >
VariantImpassign (const TYPE &value)
 
template<class TYPE >
VariantImpassign (bslmf::MovableRef< TYPE > value)
 
template<class TYPE , class SOURCE_TYPE >
VariantImpassignTo (const SOURCE_TYPE &value)
 
template<class TYPE , class... ARGS>
TYPE & createInPlace (ARGS &&... arguments)
 
void reset ()
 
void swap (VariantImp &other)
 
template<class TYPE >
TYPE & the ()
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type apply (VISITOR &visitor) const
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type apply (const VISITOR &visitor) const
 
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type apply (VISITOR &visitor, const TYPE &defaultValue) const
 
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type apply (const VISITOR &visitor, const TYPE &defaultValue) const
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type apply (VISITOR &visitor) const
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type apply (const VISITOR &visitor) const
 
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type apply (VISITOR &visitor, const TYPE &defaultValue) const
 
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type apply (const VISITOR &visitor, const TYPE &defaultValue) const
 
template<class RET_TYPE , class VISITOR >
RET_TYPE apply (VISITOR &visitor) const
 
template<class RET_TYPE , class VISITOR >
RET_TYPE apply (const VISITOR &visitor) const
 
template<class RET_TYPE , class VISITOR , class TYPE >
RET_TYPE apply (VISITOR &visitor, const TYPE &defaultValue) const
 
template<class RET_TYPE , class VISITOR , class TYPE >
RET_TYPE apply (const VISITOR &visitor, const TYPE &defaultValue) const
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type applyRaw (VISITOR &visitor) const
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type applyRaw (const VISITOR &visitor) const
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type applyRaw (VISITOR &visitor) const
 
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type applyRaw (const VISITOR &visitor) const
 
template<class RET_TYPE , class VISITOR >
RET_TYPE applyRaw (VISITOR &visitor) const
 
template<class RET_TYPE , class VISITOR >
RET_TYPE applyRaw (const VISITOR &visitor) const
 
template<class TYPE >
bool is () const
 
bool isUnset () const
 
bsl::ostream & print (bsl::ostream &stream, int level=0, int spacesPerLevel=4) const
 
template<class TYPE >
const TYPE & the () const
 
int typeIndex () const
 
const bsl::type_info & typeInfo () const
 
template<class STREAM >
STREAM & bdexStreamIn (STREAM &stream, int version)
 DEPRECATED: Do not use.
 
int maxSupportedBdexVersion () const
 DEPRECATED: Do not use.
 
template<class STREAM >
STREAM & bdexStreamOut (STREAM &stream, int version) const
 DEPRECATED: Do not use.
 
template<class TYPE >
VariantImp< TYPES > & operator= (const TYPE &value)
 
template<class TYPE >
VariantImp< TYPES > & operator= (bslmf::MovableRef< TYPE > value)
 
template<class TYPE >
VariantImp< TYPES > & assign (const TYPE &value)
 
template<class TYPE >
VariantImp< TYPES > & assign (bslmf::MovableRef< TYPE > value)
 
template<class TYPE , class SOURCE_TYPE >
VariantImp< TYPES > & assignTo (const SOURCE_TYPE &value)
 

Detailed Description

template<class TYPES>
class bdlb::VariantImp< TYPES >

This class provides the implementation of Variant (except for the creators) given a list of template parameter TYPES.

More generally, if each of the types in the list of TYPES is value semantic, then this class also supports a complete set of value semantic operations, including copy construction, assignment, equality comparison, and ostream printing. A precise operational definition of when two instances have the same value can be found in the description of operator== for the class. This class is exception neutral with no guarantee of rollback: if an exception is thrown during the invocation of a method on a pre-existing instance, the object is left in a valid state, but its value is undefined. In no event is memory leaked. Finally, aliasing (e.g., using all or part of an object as both source and destination) is supported in all cases.

If any of the types in the list of TYPES does not support operator==, or any of the value-semantic operations mentioned above, then this variant also does not support that operation and attempts to invoke it will trigger a compilation diagnostic.

See bdlb_variant

Constructor & Destructor Documentation

◆ VariantImp() [1/8]

template<class TYPES >
bdlb::VariantImp< TYPES >::VariantImp ( )
inline

Create a variant object in the unset state that uses the currently installed default allocator to supply memory.

◆ VariantImp() [2/8]

template<class TYPES >
template<class TYPE_OR_ALLOCATOR >
bdlb::VariantImp< TYPES >::VariantImp ( const TYPE_OR_ALLOCATOR &  valueOrAllocator)
inlineexplicit

Create a variant object with the specified valueOrAllocator that can be either a value of a type that the variant can hold or an allocator to supply memory. If valueOrAllocator is not a bslma::Allocator *, then the variant will hold the value and type of valueOrAllocator, and use the currently installed default allocator to supply memory. Otherwise, the variant will be unset and use valueOrAllocator to supply memory. TYPE_OR_ALLOCATOR must be the same as one of the types that this variant can hold or be convertible to bslma::Allocator *. Note that this parameterized constructor is defined instead of two constructors (one taking a bslma::Allocator * and the other not) because template parameter arguments are always a better match than derived-to-base conversion (a concrete allocator pointer converted to bslma::Allocator *).

◆ VariantImp() [3/8]

template<class TYPES >
template<class TYPE >
bdlb::VariantImp< TYPES >::VariantImp ( const TYPE &  value,
bslma::Allocator basicAllocator 
)
inline

Create a variant object having the specified value of template parameter TYPE and that uses the specified basicAllocator to supply memory. If basicAllocator is 0, the currently installed default allocator is used. TYPE must be the same as one of the types that this variant can hold.

◆ VariantImp() [4/8]

template<class TYPES >
template<class TYPE >
bdlb::VariantImp< TYPES >::VariantImp ( bslmf::MovableRef< TYPE >  value)
explicit

◆ VariantImp() [5/8]

template<class TYPES >
template<class TYPE >
bdlb::VariantImp< TYPES >::VariantImp ( bslmf::MovableRef< TYPE >  value,
bslma::Allocator basicAllocator 
)

◆ VariantImp() [6/8]

template<class TYPES >
bdlb::VariantImp< TYPES >::VariantImp ( const VariantImp< TYPES > &  original,
bslma::Allocator basicAllocator = 0 
)

Create a variant object having the type and value of the specified original variant. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used.

◆ VariantImp() [7/8]

template<class TYPES >
bdlb::VariantImp< TYPES >::VariantImp ( bslmf::MovableRef< VariantImp< TYPES > >  original)

Create a variant object having the type and value of the specified original object by moving the contents of original to the newly-created object. The allocator associated with original (if any) is propagated for use in the newly-created object. original is left in a valid but unspecified state.

◆ VariantImp() [8/8]

template<class TYPES >
bdlb::VariantImp< TYPES >::VariantImp ( bslmf::MovableRef< VariantImp< TYPES > >  original,
bslma::Allocator basicAllocator 
)

Create a variant object having the type and value of the specified original object that uses the specified basicAllocator to supply memory. If basicAllocator is 0, the currently installed default allocator is used. The contents of original are moved to the newly-created object with original left in a valid but unspecified state.

◆ ~VariantImp()

template<class TYPES >
bdlb::VariantImp< TYPES >::~VariantImp ( )
inline

Destroy this variant object, invoking the destructor of the type of object contained (if any) on the value of that type.

Member Function Documentation

◆ apply() [1/24]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type bdlb::VariantImp< TYPES >::apply ( const VISITOR &  visitor)
inline

Apply the specified visitor to this modifiable variant by passing the value this variant currently holds to the visitor object's operator(), and return the value returned by the visitor. If If this variant is unset, a default constructed bslmf::Nil is passed to the visitor. Note that this method is selected only if the template parameter type VISITOR defines a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [2/24]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type bdlb::VariantImp< TYPES >::apply ( const VISITOR &  visitor)
inline

Apply the specified visitor to this modifiable variant by passing the value this variant currently holds to the visitor object's operator(). This method does not return a value. If this variant is unset, a default constructed bslmf::Nil is passed to the visitor. Note that this method is selected only if the template parameter type VISITOR does not define a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [3/24]

template<class TYPES >
template<class RET_TYPE , class VISITOR >
RET_TYPE bdlb::VariantImp< TYPES >::apply ( const VISITOR &  visitor)
inline

◆ apply() [4/24]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type bdlb::VariantImp< TYPES >::apply ( const VISITOR &  visitor) const
inline

Apply the specified visitor to this variant by passing the value this variant currently holds to the visitor object's operator(), and return the value returned by the 'visitor. If this variant is unset, a default constructed bslmf::Nil is passed to the visitor. Note that this method is selected only if the template parameter type VISITOR defines a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [5/24]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type bdlb::VariantImp< TYPES >::apply ( const VISITOR &  visitor) const
inline

Apply the specified visitor to this variant by passing the value this variant currently holds to the visitor object's operator(). This method does not return a value. If this variant is unset, a default constructed bslmf::Nil is passed to the visitor. Note that this method is selected only if the template parameter type VISITOR does not define a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [6/24]

template<class TYPES >
template<class RET_TYPE , class VISITOR >
RET_TYPE bdlb::VariantImp< TYPES >::apply ( const VISITOR &  visitor) const
inline

◆ apply() [7/24]

template<class TYPES >
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type bdlb::VariantImp< TYPES >::apply ( const VISITOR &  visitor,
const TYPE &  defaultValue 
)
inline

Apply the specified visitor to this modifiable variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(), and return the value returned by the visitor. If this variant is unset, the specified defaultValue of template parameter TYPE is passed to the visitor. TYPE must be the same as one of the types that this variant can hold. The behavior is undefined unless this variant is unset or holds a value of template parameter TYPE. Note that this method is selected only if the template parameter type VISITOR defines a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [8/24]

template<class TYPES >
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type bdlb::VariantImp< TYPES >::apply ( const VISITOR &  visitor,
const TYPE &  defaultValue 
)
inline

Apply the specified visitor to this modifiable variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(). This method does not return a value. If this variant is unset, the specified defaultValue of template parameter TYPE is passed to the visitor. TYPE must be the same as one of the types that this variant can hold. The behavior is undefined unless this variant is unset or holds a value of template parameter TYPE. Note that this method is selected only if the template parameter type VISITOR does not define a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [9/24]

template<class TYPES >
template<class RET_TYPE , class VISITOR , class TYPE >
RET_TYPE bdlb::VariantImp< TYPES >::apply ( const VISITOR &  visitor,
const TYPE &  defaultValue 
)
inline

◆ apply() [10/24]

template<class TYPES >
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type bdlb::VariantImp< TYPES >::apply ( const VISITOR &  visitor,
const TYPE &  defaultValue 
) const
inline

Apply the specified visitor to this variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(), and return the value returned by the visitor. If this variant is unset, the specified defaultValue of template parameter TYPE is passed to the visitor. TYPE must be the same as one of the types that this variant can hold. The behavior is undefined unless this variant is unset or holds a value of template parameter TYPE. Note that this method is selected only if the template parameter type VISITOR defines a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [11/24]

template<class TYPES >
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type bdlb::VariantImp< TYPES >::apply ( const VISITOR &  visitor,
const TYPE &  defaultValue 
) const
inline

Apply the specified visitor to this variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(). This method does not return a value. If this variant is unset, the specified defaultValue of template parameter TYPE is passed to the visitor. TYPE must be the same as one of the types that this variant can hold. The behavior is undefined unless this variant is unset or holds a value of template parameter TYPE. Note that this method is selected only if the template parameter type VISITOR does not define a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [12/24]

template<class TYPES >
template<class RET_TYPE , class VISITOR , class TYPE >
RET_TYPE bdlb::VariantImp< TYPES >::apply ( const VISITOR &  visitor,
const TYPE &  defaultValue 
) const
inline

◆ apply() [13/24]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type bdlb::VariantImp< TYPES >::apply ( VISITOR &  visitor)
inline

Apply the specified visitor to this modifiable variant by passing the value this variant currently holds to the visitor object's operator(), and return the value returned by the visitor. If this variant is unset, a default constructed bslmf::Nil is passed to the visitor. Note that this method is selected only if the template parameter type VISITOR defines a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [14/24]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type bdlb::VariantImp< TYPES >::apply ( VISITOR &  visitor)
inline

Apply the specified visitor to this modifiable variant by passing the value this variant currently holds to the visitor object's operator(). This method does not return a value. If this variant is unset, a default constructed bslmf::Nil is passed to the visitor. Note that this method is selected only if the template parameter type VISITOR does not define a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [15/24]

template<class TYPES >
template<class RET_TYPE , class VISITOR >
RET_TYPE bdlb::VariantImp< TYPES >::apply ( VISITOR &  visitor)
inline

Apply the specified visitor to this modifiable variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(), and return the value (of template parameter RET_TYPE) returned by the visitor. If this variant is unset, a default constructed bslmf::Nil is passed to the visitor.

◆ apply() [16/24]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type bdlb::VariantImp< TYPES >::apply ( VISITOR &  visitor) const
inline

Apply the specified visitor to this variant by passing the value this variant currently holds to the visitor object's operator(), and return the value returned by the visitor. If this variant is unset, a default constructed bslmf::Nil is passed to the visitor. Note that this method is selected only if the template parameter type VISITOR defines a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [17/24]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type bdlb::VariantImp< TYPES >::apply ( VISITOR &  visitor) const
inline

Apply the specified visitor to this variant by passing the value this variant currently holds to the visitor object's operator(). This method does not return a value. If this variant is unset, a default constructed bslmf::Nil is passed to the visitor. Note that this method is selected only if the template parameter type VISITOR does not define a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [18/24]

template<class TYPES >
template<class RET_TYPE , class VISITOR >
RET_TYPE bdlb::VariantImp< TYPES >::apply ( VISITOR &  visitor) const
inline

Apply the specified visitor to this variant by passing the value this variant currently holds to the visitor object's operator(), and return the value (of template parameter RET_TYPE) returned by the visitor. If this variant is unset, a default constructed bslmf::Nil is passed to the visitor.

◆ apply() [19/24]

template<class TYPES >
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type bdlb::VariantImp< TYPES >::apply ( VISITOR &  visitor,
const TYPE &  defaultValue 
)
inline

Apply the specified visitor to this modifiable variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(), and return the value returned by the visitor. If this variant is unset, the specified defaultValue of template parameter TYPE is passed to the visitor. TYPE must be the same as one of the types that this variant can hold. The behavior is undefined unless this variant is unset or holds a value of template parameter TYPE. Note that this method is selected only if the template parameter type VISITOR defines a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [20/24]

template<class TYPES >
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type bdlb::VariantImp< TYPES >::apply ( VISITOR &  visitor,
const TYPE &  defaultValue 
)
inline

Apply the specified visitor to this modifiable variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(). This method does not return a value. If this variant is unset, the specified defaultValue of template parameter TYPE is passed to the visitor. TYPE must be the same as one of the types that this variant can hold. The behavior is undefined unless this variant is unset or holds a value of template parameter TYPE. Note that this method is selected only if the template parameter type VISITOR does not define a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [21/24]

template<class TYPES >
template<class RET_TYPE , class VISITOR , class TYPE >
RET_TYPE bdlb::VariantImp< TYPES >::apply ( VISITOR &  visitor,
const TYPE &  defaultValue 
)
inline

Apply the specified visitor to this modifiable variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(), and return the value (of template parameter RET_TYPE) returned by the visitor. If this variant is unset, the specified defaultValue of template parameter TYPE is passed to the visitor. TYPE must be the same as one of the types that this variant can hold. The behavior is undefined unless this variant is unset or holds a value of template parameter TYPE.

◆ apply() [22/24]

template<class TYPES >
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type bdlb::VariantImp< TYPES >::apply ( VISITOR &  visitor,
const TYPE &  defaultValue 
) const
inline

Apply the specified visitor to this variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(), and return the value returned by the visitor. If this variant is unset, the specified defaultValue of template parameter TYPE is passed to the visitor. TYPE must be the same as one of the types that this variant can hold. The behavior is undefined unless this variant is unset or holds a value of template parameter TYPE. Note that this method is selected only if the template parameter type VISITOR defines a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [23/24]

template<class TYPES >
template<class VISITOR , class TYPE >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type bdlb::VariantImp< TYPES >::apply ( VISITOR &  visitor,
const TYPE &  defaultValue 
) const
inline

Apply the specified visitor to this variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(). This method does not return a value. If this variant is unset, the specified defaultValue of template parameter TYPE is passed to the visitor. TYPE must be the same as one of the types that this variant can hold. The behavior is undefined unless this variant is unset or holds a value of template parameter TYPE. Note that this method is selected only if the template parameter type VISITOR does not define a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ apply() [24/24]

template<class TYPES >
template<class RET_TYPE , class VISITOR , class TYPE >
RET_TYPE bdlb::VariantImp< TYPES >::apply ( VISITOR &  visitor,
const TYPE &  defaultValue 
) const
inline

Apply the specified visitor to this variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(), and return the value (of template parameter RET_TYPE) returned by the visitor. If this variant is unset, the specified defaultValue of template parameter TYPE is passed to the visitor. TYPE must be the same as one of the types that this variant can hold. The behavior is undefined unless this variant is unset or holds a value of template parameter TYPE.

◆ applyRaw() [1/12]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type bdlb::VariantImp< TYPES >::applyRaw ( const VISITOR &  visitor)
inline

Apply the specified visitor to this modifiable variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(), and return the value returned by the visitor. The behavior is undefined if this variant is unset. Note that this method is selected only if the template parameter type VISITOR defines a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ applyRaw() [2/12]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type bdlb::VariantImp< TYPES >::applyRaw ( const VISITOR &  visitor)
inline

Apply the specified visitor to this modifiable variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(). This method does not return a value. The behavior is undefined if this variant is unset. Note that this method is selected only if the template parameter type VISITOR does not define a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ applyRaw() [3/12]

template<class TYPES >
template<class RET_TYPE , class VISITOR >
RET_TYPE bdlb::VariantImp< TYPES >::applyRaw ( const VISITOR &  visitor)
inline

◆ applyRaw() [4/12]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type bdlb::VariantImp< TYPES >::applyRaw ( const VISITOR &  visitor) const
inline

Apply the specified visitor to this variant by passing the value this variant currently holds to the visitor object's operator(), and return the value returned by the visitor. The behavior is undefined if this variant is unset. Note that this method is selected only if the template parameter type VISITOR defines a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ applyRaw() [5/12]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type bdlb::VariantImp< TYPES >::applyRaw ( const VISITOR &  visitor) const
inline

Apply the specified visitor to this variant by passing the value this variant currently holds to the visitor object's operator(). This method does not return a value. The behavior is undefined if this variant is unset. Note that this method is selected only if the template parameter type VISITOR does not define a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ applyRaw() [6/12]

template<class TYPES >
template<class RET_TYPE , class VISITOR >
RET_TYPE bdlb::VariantImp< TYPES >::applyRaw ( const VISITOR &  visitor) const
inline

◆ applyRaw() [7/12]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type bdlb::VariantImp< TYPES >::applyRaw ( VISITOR &  visitor)
inline

Apply the specified visitor to this modifiable variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(), and return the value returned by the visitor. The behavior is undefined if this variant is unset. Note that this method is selected only if the template parameter type VISITOR defines a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ applyRaw() [8/12]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type bdlb::VariantImp< TYPES >::applyRaw ( VISITOR &  visitor)
inline

Apply the specified visitor to this modifiable variant by passing the value (of template parameter TYPE) this variant currently holds to the visitor object's operator(). This method does not return a value. The behavior is undefined if this variant is unset. Note that this method is selected only if the template parameter type VISITOR does not define a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ applyRaw() [9/12]

template<class TYPES >
template<class RET_TYPE , class VISITOR >
RET_TYPE bdlb::VariantImp< TYPES >::applyRaw ( VISITOR &  visitor)
inline

Apply the specified visitor to this modifiable variant by passing the value this variant currently holds to the visitor object's operator(), and return the value (of template parameter RET_TYPE) returned by the visitor. The behavior is undefined if this variant is unset.

◆ applyRaw() [10/12]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==1, typenameVISITOR::ResultType >::type bdlb::VariantImp< TYPES >::applyRaw ( VISITOR &  visitor) const
inline

Apply the specified visitor to this variant by passing the value this variant currently holds to the visitor object's operator(), and return the value (of template parameter RET_TYPE) returned by the visitor. The behavior is undefined if this variant is unset. Note that this method is selected only if the template parameter type VISITOR defines a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ applyRaw() [11/12]

template<class TYPES >
template<class VISITOR >
bsl::enable_if< Variant_ReturnValueHelper< VISITOR >::value==0, void >::type bdlb::VariantImp< TYPES >::applyRaw ( VISITOR &  visitor) const
inline

Apply the specified visitor to this variant by passing the value this variant currently holds to the visitor object's operator(). This method does not return a value. The behavior is undefined if this variant is unset. Note that this method is selected only if the template parameter type VISITOR does not define a typedef of ResultType in its public interface. Also note that this method is defined inline to work around a Windows compiler bug with SFINAE functions.

◆ applyRaw() [12/12]

template<class TYPES >
template<class RET_TYPE , class VISITOR >
RET_TYPE bdlb::VariantImp< TYPES >::applyRaw ( VISITOR &  visitor) const
inline

Apply the specified visitor to this variant by passing the value this variant currently holds to the visitor object's operator(), and return the value (of template parameter RET_TYPE) returned by the visitor. The behavior is undefined if this variant is unset.

◆ assign() [1/4]

template<class TYPES >
template<class TYPE >
VariantImp & bdlb::VariantImp< TYPES >::assign ( bslmf::MovableRef< TYPE >  value)

◆ assign() [2/4]

template<class TYPES >
template<class TYPE >
VariantImp< TYPES > & bdlb::VariantImp< TYPES >::assign ( bslmf::MovableRef< TYPE >  value)

◆ assign() [3/4]

template<class TYPES >
template<class TYPE >
VariantImp & bdlb::VariantImp< TYPES >::assign ( const TYPE &  value)

Assign to this object the specified value of template parameter TYPE, and return a reference providing modifiable access to this object. The value currently held by this variant (if any) is destroyed if that value's type is not the same as TYPE. TYPE must be the same as one of the types that this variant can hold.

◆ assign() [4/4]

template<class TYPES >
template<class TYPE >
VariantImp< TYPES > & bdlb::VariantImp< TYPES >::assign ( const TYPE &  value)

◆ assignTo() [1/2]

template<class TYPES >
template<class TYPE , class SOURCE_TYPE >
VariantImp & bdlb::VariantImp< TYPES >::assignTo ( const SOURCE_TYPE &  value)

Assign to this object the specified value of template parameter SOURCE_TYPE converted to template parameter TYPE, and return a reference providing modifiable access to this object. The value currently held by this variant (if any) is destroyed if that value's type is not the same as TYPE. TYPE must be the same as one of the types that this variant can hold and SOURCE_TYPE must be convertible to TYPE.

◆ assignTo() [2/2]

template<class TYPES >
template<class TYPE , class SOURCE_TYPE >
VariantImp< TYPES > & bdlb::VariantImp< TYPES >::assignTo ( const SOURCE_TYPE &  value)

◆ bdexStreamIn()

template<class TYPES >
template<class STREAM >
STREAM & bdlb::VariantImp< TYPES >::bdexStreamIn ( STREAM &  stream,
int  version 
)

◆ bdexStreamOut()

template<class TYPES >
template<class STREAM >
STREAM & bdlb::VariantImp< TYPES >::bdexStreamOut ( STREAM &  stream,
int  version 
) const

◆ BSLMF_NESTED_TRAIT_DECLARATION()

template<class TYPES >
bdlb::VariantImp< TYPES >::BSLMF_NESTED_TRAIT_DECLARATION ( VariantImp< TYPES >  ,
HasPrintMethod   
)

◆ BSLMF_NESTED_TRAIT_DECLARATION_IF() [1/3]

template<class TYPES >
bdlb::VariantImp< TYPES >::BSLMF_NESTED_TRAIT_DECLARATION_IF ( VariantImp< TYPES >  ,
bslma::UsesBslmaAllocator  ,
Traits::k_VARIANT_USES_BSLMA_ALLOCATOR   
)

◆ BSLMF_NESTED_TRAIT_DECLARATION_IF() [2/3]

template<class TYPES >
bdlb::VariantImp< TYPES >::BSLMF_NESTED_TRAIT_DECLARATION_IF ( VariantImp< TYPES >  ,
bslmf::IsBitwiseCopyable  ,
Traits::k_VARIANT_IS_BITWISE_COPYABLE   
)

◆ BSLMF_NESTED_TRAIT_DECLARATION_IF() [3/3]

template<class TYPES >
bdlb::VariantImp< TYPES >::BSLMF_NESTED_TRAIT_DECLARATION_IF ( VariantImp< TYPES >  ,
bslmf::IsBitwiseMoveable  ,
Traits::k_VARIANT_IS_BITWISE_MOVEABLE   
)

◆ createInPlace()

template<class TYPES >
template<class TYPE , class... ARGS>
TYPE & bdlb::VariantImp< TYPES >::createInPlace ( ARGS &&...  arguments)
inline

Create an instance of template parameter TYPE in this variant object with up to 14 parameters using the allocator currently held by this variant to supply memory, and return a reference providing modifiable access to the created instance. This method first destroys the current value held by this variant (even if TYPE is the same as the type currently held). TYPE must be the same as one of the types that this variant can hold. Note the order of the template arguments was chosen so that TYPE must always be specified.

◆ is()

template<class TYPES >
template<class TYPE >
bool bdlb::VariantImp< TYPES >::is ( ) const
inline

Return true if the value held by this variant object is of template parameter TYPE, and false otherwise. TYPE must be the same as one of the types that this variant can hold. Note that TYPE must be specified explicitly, e.g., myValue.is<int>().

◆ isUnset()

template<class TYPES >
bool bdlb::VariantImp< TYPES >::isUnset ( ) const
inline

Return true if this variant is currently unset, and false otherwise. An unset variant does not hold a value or type. Note that this method should be preferred over checking the type index of the variant.

◆ maxSupportedBdexVersion()

template<class TYPES >
int bdlb::VariantImp< TYPES >::maxSupportedBdexVersion ( ) const
inline

◆ operator=() [1/6]

template<class TYPES >
template<class TYPE >
VariantImp & bdlb::VariantImp< TYPES >::operator= ( bslmf::MovableRef< TYPE >  value)

◆ operator=() [2/6]

template<class TYPES >
template<class TYPE >
VariantImp< TYPES > & bdlb::VariantImp< TYPES >::operator= ( bslmf::MovableRef< TYPE >  value)
inline

◆ operator=() [3/6]

template<class TYPES >
VariantImp< TYPES > & bdlb::VariantImp< TYPES >::operator= ( bslmf::MovableRef< VariantImp< TYPES > >  rhs)

Assign to this object the type and value currently held by the specified rhs object, and return a reference providing modifiable access to this object. The contents of rhs are either move-inserted into or move-assigned to this object with rhs left in a valid but unspecified state.

◆ operator=() [4/6]

template<class TYPES >
template<class TYPE >
VariantImp & bdlb::VariantImp< TYPES >::operator= ( const TYPE &  value)

Assign to this object the specified value of template parameter TYPE, and return a reference providing modifiable access to this object. The value currently held by this variant (if any) is destroyed if that value's type is not the same as TYPE. TYPE must be the same as one of the types that this variant can hold.

◆ operator=() [5/6]

template<class TYPES >
template<class TYPE >
VariantImp< TYPES > & bdlb::VariantImp< TYPES >::operator= ( const TYPE &  value)
inline

◆ operator=() [6/6]

template<class TYPES >
VariantImp< TYPES > & bdlb::VariantImp< TYPES >::operator= ( const VariantImp< TYPES > &  rhs)

Assign to this object the type and value currently held by the specified rhs object, and return a reference providing modifiable access to this object. The value currently held by this variant (if any) is destroyed if that value's type is not the same as the type held by the rhs object.

◆ print()

template<class TYPES >
bsl::ostream & bdlb::VariantImp< TYPES >::print ( bsl::ostream &  stream,
int  level = 0,
int  spacesPerLevel = 4 
) const

Format this object to the specified output stream at the (absolute value of) the optionally specified indentation level, and return a reference to stream. If level is specified, optionally specify spacesPerLevel, the number of spaces per indentation level for this and all of its nested objects. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by level). If stream is not valid on entry, this operation has no effect. Nothing is printed if this variant is unset. Each type that may be contained by this variant shall be printable with bdlb::PrintMethods (typically meaning that they either declare the bdlb::HasPrintMethod trait or provide the << output streaming operator). See bdlb_printmethods . The compiler will emit an error if bdlb::PrintMethods::print cannot be instantiated for each type that may be contained by this variant.

◆ reset()

template<class TYPES >
void bdlb::VariantImp< TYPES >::reset ( )

Destroy the current value held by this variant (if any), and reset this variant to the unset state.

◆ swap()

template<class TYPES >
void bdlb::VariantImp< TYPES >::swap ( VariantImp< TYPES > &  other)

Swap the value of this object with the value of the specified other object. This method provides the no-throw guarantee if the TYPE template parameter has a no-throw swap and the two variant objects being swapped have the same type; otherwise this method provides the basic guarantee.

◆ the() [1/2]

template<class TYPES >
template<class TYPE >
TYPE & bdlb::VariantImp< TYPES >::the ( )
inline

Return a reference providing modifiable access to the value of template parameter TYPE held by this variant object. TYPE must be the same as one of the types that this variant can hold. The behavior is undefined unless is<TYPE>() returns true and TYPE is not void. Note that TYPE must be specified explicitly, e.g., myValue.the<int>().

◆ the() [2/2]

template<class TYPES >
template<class TYPE >
const TYPE & bdlb::VariantImp< TYPES >::the ( ) const
inline

Return a reference providing non-modifiable access to the value of template parameter TYPE held by this variant object. TYPE must be the same as one of the types that this variant can hold. The behavior is undefined unless is<TYPE>() returns true and TYPE is not void. Note that TYPE must be specified explicitly, e.g., myValue.the<int>().

◆ typeIndex()

template<class TYPES >
int bdlb::VariantImp< TYPES >::typeIndex ( ) const
inline

Return the index in the list of TYPES corresponding to the type of the value currently held by this variant object (starting at 1), or 0 if this object is unset. Note that instead of switching code on the type index, calling apply is the preferred method of manipulating different types stored inside a variant.

◆ typeInfo()

template<class TYPES >
const bsl::type_info & bdlb::VariantImp< TYPES >::typeInfo ( ) const
inline

Return typeid(void).

DEPRECATED: Do not use.


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