Class: DDSError

vortexdds~DDSError(error, messageopt)

An error originating from the DDS system.

Every DDS error has two properties:

  • ddsErrCode a numeric value between 0 and 12
  • ddsErrMsg a short textual description of the error code

Note that every DDSError results in entries in the ospl-error.log file. These entries provide significantly more information on the nature of the error.

Constructor

new DDSError(error, messageopt)

Not typically used by customers. Creates a DDSError instance.

Extends:
Parameters:
Name Type Attributes Default Description
error module:vortexdds.DDSErrorCode

an integer between 0 and 12 or a negative integer returned from one of the C99 APIs (used internally)

message string <optional>
''

a message providing context of the error

Extends

Members

ddsErrCode :module:vortexdds.DDSErrorCode

The DDS error code

Type:

ddsErrMsg :string

A short textual description of the DDS error code

Type:
  • string