Porting Guide from CGF 5.10 to CGF 5.12

Table of Contents

• Catching Exceptions
• ChannelFactory
• Node API
• Parameter Description
• Parameter Provider
• Enum Type

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

Catching Exceptions

A new public class dw::framework::ExceptionGuard has been introduced in dwcgf/Exception.hpp to provide the functionality of catching various exception types and converting them into error codes. This is replacing functionality previously provided by transitive includes of internal headers.

ChannelFactory

The function dw::framework::ChannelFactory::getEvent() was renamed to dw::framework::ChannelFactory::popError() and has a different signature.

Node API

The following (mostly deprecated) constants, members, methods, and types have been removed from the node classes:

• dw::framework::SimpleNode::PASS_SETUP_NAME
• dw::framework::SimpleNode::PASS_TEARDOWN_NAME
• dw::framework::SimpleSensorNode::LOG_TAG
• dw::framework::SensorNode::DataEventType (use dw::framework::ISensorNode::DataEventType instead)
• dw::framework::SensorNode::DataEvent (use dw::framework::ISensorNode::DataEvent instead)
• dw::framework::SensorNode::DataEventReadCallback (use dw::framework::ISensorNode::DataEventReadCallback instead)
• dw::framework::SensorNode::DataEventWriteCallback (use dw::framework::ISensorNode::DataEventWriteCallback instead)
• dw::framework::Port::initialize()
• dw::framework::Pass::m_processType
• dw::framework::Pass::m_minTime
• dw::framework::Pass::m_avgTime
• dw::framework::Pass::m_maxTime
• dw::framework::Pass::m_dlaEngine

The following methods have been renamed:

• dw::framework::Node::reportCurrentErrorSignal() -> dw::framework::Node::updateCurrentErrorSignal()
• dw::framework::Node::reportCurrentHealthSignal() -> dw::framework::Node::updateCurrentHealthSignal()
• As well as the same methods in the subclass dw::framework::SimpleNode

The following method has new required arguments:

• dw::framework::Node::getErrorSignal()
• As well as the same method in the subclass dw::framework::SimpleNode

The following methods have removed some arguments:

• processType from dw::framework::Node::getPasses()
• dlaEngine from dw::framework::SimpleNode::registerPass()
• processType, minTime, avgTime, maxTime, and dlaEngine from dw::framework::PassImpl()

Parameter Description

The signatures of the following functions have changed, taking the array size as a template argument instead of a function argument:

• dw::framework::describeAbstractArrayParameter()
• dw::framework::describeArrayParameter()
• dw::framework::describeUnnamedArrayParameter()

Parameter Provider

API to retrieve parameters of type std::string have been removed from dw::framework::JsonParameterProvider.

Enum Type

dw::framework::dwSerializationType has been changed from an enum to an enum class.