casa::Copy_global_functions_copy Struct Reference
[Utilities]

#include <Copy.h>

List of all members.

---

Detailed Description

Copy methods .

Definition at line 129 of file Copy.h.

Public Member Functions
template<class T>
void	objmove (T *to, const T *from, uInt n)
	The general function to copy n objects from one place to another if overlap between to and from fields is possible.
template<class T>
void	objmove (T *to, const T *from, uInt n, uInt toStride, uInt fromStride)
template<class T>
void	objcopy (T *to, const T *from, uInt n)
	The non-general function to copy n objects from one place to another.
template<class T>
void	objcopy (T *to, const T *from, uInt n, uInt toStride, uInt fromStride)
template<class T>
void	objset (T *to, const T fillValue, uInt n)
	Fill n elements of an array of objects with the given value, optionally with a stride.
template<class T>
void	objset (T *to, const T fillValue, uInt n, uInt toStride)

---

Member Function Documentation

template<class T>

void casa::Copy_global_functions_copy::objmove	(	T *	to,
		const T *	from,
		uInt	n
	)			[inline]

The general function to copy n objects from one place to another if overlap between to and from fields is possible.

Strides may be specified, i.e. you may copy from every fromStride-th position into every toStride-th one. The function will call std::copy() when possible. Objmove works correctly if the source and destination overlap in any way. An exception will be thrown if the source or the destination does not exist (and n is non-zero) or if the strides are non-positive.

Thrown Exceptions

• AipsError

Definition at line 143 of file Copy.h.

template<class T>

void casa::Copy_global_functions_copy::objmove	(	T *	to,
		const T *	from,
		uInt	n,
		uInt	toStride,
		uInt	fromStride
	)			[inline]

Definition at line 147 of file Copy.h.

template<class T>

void casa::Copy_global_functions_copy::objcopy	(	T *	to,
		const T *	from,
		uInt	n
	)			[inline]

The non-general function to copy n objects from one place to another.

Strides may be specified, i.e. you may copy from every fromStride-th position into every toStride-th one.

Objcopy does not take an overlap of source and destination into account. Objmove should be used if that is an issue.

An exception will be thrown if the source or the destination does not exist or if the strides are non-positive.

Thrown Exceptions

• AipsError

Definition at line 206 of file Copy.h.

template<class T>

void casa::Copy_global_functions_copy::objcopy	(	T *	to,
		const T *	from,
		uInt	n,
		uInt	toStride,
		uInt	fromStride
	)			[inline]

Definition at line 208 of file Copy.h.

template<class T>

void casa::Copy_global_functions_copy::objset	(	T *	to,
		const T	fillValue,
		uInt	n
	)			[inline]

Fill n elements of an array of objects with the given value, optionally with a stride.

Note that the fillValue is passed by value.

An exception will be thrown if the destination array does not exist or if the stride is non-positive.

Thrown Exceptions

• AipsError

Definition at line 239 of file Copy.h.

template<class T>

void casa::Copy_global_functions_copy::objset	(	T *	to,
		const T	fillValue,
		uInt	n,
		uInt	toStride
	)			[inline]

Definition at line 242 of file Copy.h.

---

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

• casa/implement/Utilities/Copy.h

---