Porting Guide from CGF 5.12 to CGF 5.14

Table of Contents

• Channel Metadata
• Node API
  • Error and Health API
• NodeFactory
• Pass
• Port API
  • PortDirection
  • SyncPortHelper
• Descriptors
• Deprecated

This document will help you port your applications from DriveWorks CGF 5.12 to DriveWorks CGF 5.14.

Channel Metadata

The enumerators of the enum class dw::framework::MetadataFlags have been changed.

The members of the struct dw::framework::ChannelMetadata have been changed.

Node API

The deprecated classes dw::framework::SimpleProcessNode and dw::framework::SimpleProcessNodeT have been removed, use dw::framework::SimpleNode and dw::framework::SimpleNodeT instead.

The type dw::framework::Node::Name_t has been removed, use dw::core::FixedString<dw::framework::Node::MAX_NAME_LEN> instead.

The constants dw::framework::Node::MAX_PORT_COUNT and dw::framework::Node::MAX_PASS_COUNT as well as the default constructor of dw::framework::SimpleNode have been removed. Instead invoke the constructor with dw::framework::NodeAllocationParams which should be initialized with the number of ports and passes of the concrete node.

The following changes also apply to subclasses of the mentioned classes.

The method dw::framework::Node::setInputChannel() with a dw::framework::dwSerializationType argument has been removed.

The functions dw::framework::SimpleNode::initInputArrayPort() and dw::framework::SimpleNode::initOutputArrayPort() as well as the macros NODE_INIT_INPUT_ARRAY_PORT() and NODE_INIT_OUTPUT_ARRAY_PORT() have been renamed with an additional trailing s/S to indicate that all ports in the array are being initialized.

The following deprecated methods have been removed:

• dw::framework::SimpleNode::createSetupPass(), dw::framework::SimpleNode::createTeardownPass(), dw::framework::SimpleNode::make_pass(), and dw::framework::SimpleNode::addPass()
  • use dw::framework::SimpleNode::registerPass() instead
• dw::framework::SimpleNode::make_port(), use one of the following methods instead
  • dw::framework::SimpleNode::initInputPort()
  • dw::framework::SimpleNode::initInputArrayPort()
  • dw::framework::SimpleNode::initInputArrayPorts()
  • dw::framework::SimpleNode::initOutputPort()
  • dw::framework::SimpleNode::initOutputArrayPort()
  • dw::framework::SimpleNode::initOutputArrayPorts()

Error and Health API

The following methods have been split into multiple separate methods:

• dw::framework::Node::getErrorSignal() replaced by
  • dw::framework::Node::collectErrorSignals()
  • dw::framework::Node::getModuleErrorSignal()
  • dw::framework::Node::getNodeErrorSignal()
• dw::framework::Node::getHealthSignal() replaced by
  • dw::framework::Node::collectHealthSignals()
  • dw::framework::Node::getModuleHealthSignal()
  • dw::framework::Node::getNodeHealthSignal()

NodeFactory

DW_REGISTER_NODE() only support a single argument. The previously necessary second argument to distinguish multiple invocations of the macro in the same translation unit is not needed anymore.

Pass

dw::framework::Pass requires the pass name as an additional constructor argument.

Port API

dw::framework::ManagedPortBase as well as all of its subclasses require the port name as an additional constructor argument.

PortDirection

The enumerator dw::framework::PortDirection::COUNT was removed from the enum class.

SyncPortHelper

The method dw::framework::SyncPortHelper::setSyncRetriever() has been removed.

Descriptors

Previously individual ports, passes and parameters of a node were described by a tuple. Those have been replaced by (templated) structs:

• dw::framework::PortDescriptorT
• dw::framework::PassDescriptorT
• dw::framework::ParameterDescriptorT
• dw::framework::ParameterDescriptorWithDefaultT

Accordingly, all constants referring to indices within the tuples have been removed.

Deprecated

The following methods are deprecated and will be removed in a future release:

• dw::framework::Node::updateCurrentErrorSignal()
• dw::framework::Node::updateCurrentHealthSignal()