icetCopyState(3)

icetCopyState3

Usage

#include <IceT.h>

void icetCopyState(IceTContextdest,
const IceTContextsrc );

Overview

The icetCopyState function replaces the state of dest with the current state of src. This function can be used to quickly duplicate a context.

The IceTCommunicator object associated with dest is not changed (nor can it ever be). Consequently, the following state values are not copied either, since they refer to process ids that are directly tied to the IceTCommunicator object: ICET_RANK, ICET_NUM_PROCESSES, ICET_DATA_REPLICATION_GROUP, ICET_DATA_REPLICATION_GROUP_SIZE, ICET_COMPOSITE_ORDER, and ICET_PROCESS_ORDERS. However, every other state parameter is copied.

Errors

None.

Warnings

None.

Notes

Behavior is undefined if dest or src has never been created or has already been destroyed.

Releases

8 releases since Debian 6.0 (Squeeze); the text changed 3 times.

  1. 6.0
  2. 7–8
  3. 9–10
  4. 11–13

Bugs

The state is copied blindly. It is therefore possible to copy states that are invalid for a context's communicator. For example, a display rank may not refer to a valid process id.

From paraview 5.13.2+dfsg-3 in Debian 13 (Trixie). Parsed by carta from the page's man source.