nn::nex::DuplicatedObject::Update Member Function

Syntax

qResult Update();

qResult Update(
     const Time & tUpdateTime
);

qResult Update(
     DataSet & refDataset
);

qResult Update(
     DataSet & refDataset,
     const Time & tUpdateTime
);

List of Overloaded Member Functions

Update ( ) Notifies duplicas in the session that the content of all datasets has been updated.
Update ( const Time & ) Notifies duplicas in the session that the content of all datasets has been updated.
Update ( DataSet & ) Notifies duplicas in the session that the specified dataset content has been refreshed.
Update ( DataSet &, const Time & ) Notifies duplicas in the session that the specified dataset content has been refreshed.

Description of Update ( )

Only allow the duplication master to call this function.

This function internally gets the CPU tick count. To get the best possible performance on CTR, we recommend getting the SessionClock value from a different location and explicitly specifying that value in an overloaded function.

When using reliable communication to send data, the ReliableSendBufferFull error is returned if all the send buffers used to send data to another station are full. Regardless of whether you are using reliable communication, when the packet buffer has insufficient space required for sending, the PacketBufferFull error is returned. The ReliableSendBufferFull and PacketBufferFull errors indicate that the send buffer was temporarily full. When these errors occur, dispatch the data and wait briefly before trying to send the data again. If PacketBufferFull occurs at a high frequency, take measures to increase the packet buffer. For more information about packet buffer settings, see PacketBufferManager.

When there is an error, you can guarantee that datasets for which there has been an error do not reach all stations, but datasets prior to the error do arrive.

Description of Update ( const Time & )

Only allow the duplication master to call this function.

In this overloaded function, you can refresh by explicitly specifying the current SessionClock value. When you need to separately update a great many different duplicated objects, you can optimize by getting the SessionClock value outside of a loop and passing that value to this overloaded function.

When using reliable communication to send data, the ReliableSendBufferFull error is returned if all the send buffers used to send data to another station are full. Regardless of whether you are using reliable communication, when the packet buffer has insufficient space required for sending, the PacketBufferFull error is returned. The ReliableSendBufferFull and PacketBufferFull errors indicate that the send buffer was temporarily full. When these errors occur, dispatch the data and wait briefly before trying to send the data again. If PacketBufferFull occurs at a high frequency, take measures to increase the packet buffer. For more information about packet buffer settings, see PacketBufferManager.

When there is an error, you can guarantee that datasets for which there has been an error do not reach all stations, but datasets prior to the error do arrive.

Description of Update ( DataSet & )

Only allow the duplication master to call this function.

A call of this function results in less communication than a refresh of all datasets. This function internally gets the CPU tick count. To get the best possible performance on CTR, we recommend getting the SessionClock value from a different location and explicitly specifying that value in an overloaded function.

When using reliable communication to send data, the ReliableSendBufferFull error is returned if all the send buffers used to send data to another station are full. Regardless of whether you are using reliable communication, when the packet buffer has insufficient space required for sending, the PacketBufferFull error is returned. The ReliableSendBufferFull and PacketBufferFull errors indicate that the send buffer was temporarily full. When these errors occur, dispatch the data and wait briefly before trying to send the data again. If PacketBufferFull occurs at a high frequency, take measures to increase the packet buffer. For more information about packet buffer settings, see PacketBufferManager.

When there is an error, it is guaranteed that the data will not reach all stations.

Description of Update ( DataSet &, const Time & )

Only allow the duplication master to call this function.

A call of this function results in less communication than a refresh of all datasets. In this overloaded function, you can refresh by explicitly specifying the current SessionClock value. When you need to separately update a great many different duplicated objects, you can optimize by getting the SessionClock value outside of a loop and passing that value to this overloaded function.

When using reliable communication to send data, the ReliableSendBufferFull error is returned if all the send buffers used to send data to another station are full. Regardless of whether you are using reliable communication, when the packet buffer has insufficient space required for sending, the PacketBufferFull error is returned. The ReliableSendBufferFull and PacketBufferFull errors indicate that the send buffer was temporarily full. When these errors occur, dispatch the data and wait briefly before trying to send the data again. If PacketBufferFull occurs at a high frequency, take measures to increase the packet buffer. For more information about packet buffer settings, see PacketBufferManager.

When there is an error, it is guaranteed that the data will not reach all stations.


CONFIDENTIAL