bsltf::MovableAllocTestType Class Reference

#include <bsltf_movablealloctesttype.h>

Detailed Description

This class provides an unconstrained (value-semantic) attribute type that records when move semantics have been invoked with the object instance as the source parameter. The class uses a bslma::Allocator to allocate memory and defines the type trait bslma::UsesBslmaAllocator. This class is primarily provided to facilitate testing of templates where move semantics need to be differentiated versus copy semantics. See the Attributes section under @DESCRIPTION in the component-level documentation for information on the class attributes.

See bsltf_movablealloctesttype

Public Member Functions
	BSLMF_NESTED_TRAIT_DECLARATION (MovableAllocTestType, bsl::is_nothrow_move_constructible)
	MovableAllocTestType ()
	MovableAllocTestType (bslma::Allocator *basicAllocator)
	MovableAllocTestType (int data, bslma::Allocator *basicAllocator=0)
	MovableAllocTestType (bslmf::MovableRef< MovableAllocTestType > original) BSLS_KEYWORD_NOEXCEPT
	MovableAllocTestType (bslmf::MovableRef< MovableAllocTestType > original, bslma::Allocator *basicAllocator)
	MovableAllocTestType (const MovableAllocTestType &original, bslma::Allocator *basicAllocator=0)
	~MovableAllocTestType ()
MovableAllocTestType &	operator= (const MovableAllocTestType &rhs)
MovableAllocTestType &	operator= (bslmf::MovableRef< MovableAllocTestType > rhs)
void	setCopyMoveState (CopyMoveState::Enum state)
void	setData (int value)
void	setMovedInto (MoveState::Enum value)
CopyMoveState::Enum	copyMoveState () const
int	data () const
MoveState::Enum	movedInto () const
MoveState::Enum	movedFrom () const
bslma::Allocator *	allocator () const

Friends
CopyMoveState::Enum	copyMoveState (const MovableAllocTestType &obj)
void	setCopyMoveState (MovableAllocTestType *obj, CopyMoveState::Enum state)

Constructor & Destructor Documentation

MovableAllocTestType() [1/6]

bsltf::MovableAllocTestType::MovableAllocTestType

(

)

Create a MovableAllocTestType object having the (default) attribute values:

data() == -1

Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used.

MovableAllocTestType() [2/6]

bsltf::MovableAllocTestType::MovableAllocTestType ( bslma::Allocator *  basicAllocator )

explicit

MovableAllocTestType() [3/6]

bsltf::MovableAllocTestType::MovableAllocTestType ( int  data, bslma::Allocator *  basicAllocator = 0  )

explicit

Create a MovableAllocTestType object having the specified data attribute value. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used.

MovableAllocTestType() [4/6]

bsltf::MovableAllocTestType::MovableAllocTestType

(

bslmf::MovableRef< MovableAllocTestType >

original

)

MovableAllocTestType() [5/6]

bsltf::MovableAllocTestType::MovableAllocTestType	(	bslmf::MovableRef< MovableAllocTestType >	original,
		bslma::Allocator *	basicAllocator
	)

TBD: comment this.

MovableAllocTestType() [6/6]

bsltf::MovableAllocTestType::MovableAllocTestType	(	const MovableAllocTestType &	original,
		bslma::Allocator *	basicAllocator = 0
	)

Create a MovableAllocTestType object having the same value as the specified original object. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used.

~MovableAllocTestType()

bsltf::MovableAllocTestType::~MovableAllocTestType

(

)

Destroy this object.

Member Function Documentation

allocator()

bslma::Allocator * bsltf::MovableAllocTestType::allocator ( ) const

inline

Return the allocator used by this object to supply memory.

BSLMF_NESTED_TRAIT_DECLARATION()

bsltf::MovableAllocTestType::BSLMF_NESTED_TRAIT_DECLARATION	(	MovableAllocTestType	,
		bsl::is_nothrow_move_constructible
	)

copyMoveState()

CopyMoveState::Enum bsltf::MovableAllocTestType::copyMoveState ( ) const

inline

Return the copy/move state of this object.

data()

int bsltf::MovableAllocTestType::data ( ) const

inline

Return the value of the data attribute of this object.

movedFrom()

MoveState::Enum bsltf::MovableAllocTestType::movedFrom ( ) const

inline

Return the move state of this object as source of a move operation.

Deprecated:

Use CopyMoveState::isMovedFrom instead.

movedInto()

MoveState::Enum bsltf::MovableAllocTestType::movedInto ( ) const

inline

Return the move state of this object as target of a move operation.

Deprecated:

Use CopyMoveState::isMovedInto instead.

operator=() [1/2]

MovableAllocTestType & bsltf::MovableAllocTestType::operator=

(

bslmf::MovableRef< MovableAllocTestType >

rhs

)

TBD: comment this.

operator=() [2/2]

MovableAllocTestType & bsltf::MovableAllocTestType::operator=

(

const MovableAllocTestType &

rhs

)

Assign to this object the value of the specified rhs object, and return a reference providing modifiable access to this object.

setCopyMoveState()

void bsltf::MovableAllocTestType::setCopyMoveState ( CopyMoveState::Enum  state )

inline

Set the copy/move state of this object to the specified state.

setData()

void bsltf::MovableAllocTestType::setData

(

int

value

)

Set the data attribute of this object to the specified value.

setMovedInto()

void bsltf::MovableAllocTestType::setMovedInto ( MoveState::Enum  value )

inline

Set the moved-into state of this object to the specified value.

Friends And Related Symbol Documentation

copyMoveState

CopyMoveState::Enum copyMoveState ( const MovableAllocTestType &  obj )

friend

Return the copy/move state of the specified obj. This function is an ADL customization point used by CopyMoveState::get(obj).

setCopyMoveState

void setCopyMoveState ( MovableAllocTestType *  obj, CopyMoveState::Enum  state  )

friend

Set the copy/move state of object at the specified obj address to the specified state. This function is an ADL customization point used by CopyMoveState::set(obj, state).

---

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

• bsltf_movablealloctesttype.h