Issue#

class omni.converter.dgn.Issue#

Bases: pybind11_object

Structured diagnostic with a code, message, and code-specific subject. Code and message are read-only. Set the writable subject before recording the issue in a Result. Construction does not log a diagnostic.

Methods

__init__(*args, **kwargs)

Overloaded function.

hasIssue(self)

Return whether code differs from eNone.

Attributes

code

Stable machine-readable issue code.

message

Description of the condition, cause, and any recovery or consequence.

subject

Code-specific identity of the object associated with the issue, or an empty string when not set.
__init__(*args, **kwargs)#

Overloaded function.

  1. __init__(self: omni.converter.dgn._omni_converter_dgn.Issue) -> None

Create an empty Issue with code eNone and empty strings. hasIssue() returns False.

  1. __init__(self: omni.converter.dgn._omni_converter_dgn.Issue, code: omni.converter.dgn._omni_converter_dgn.IssueCode, message: str) -> None

    Create an issue with an empty subject.

    Args:

    code: Reportable IssueCode other than eNone or eMax. message: Non-empty description of the condition, cause, and any recovery or consequence.

    Raises:

    ValueError: If the code is not reportable or the message is empty.

  2. __init__(self: omni.converter.dgn._omni_converter_dgn.Issue, code: omni.converter.dgn._omni_converter_dgn.IssueCode, message: str, subject: str) -> None

    Create an issue with a code-specific subject.

    Args:

    code: Reportable IssueCode other than eNone or eMax. message: Non-empty description of the condition, cause, and any recovery or consequence. subject: Identity of the associated object, or an empty string when unavailable or inapplicable.

    Raises:

    ValueError: If the code is not reportable or the message is empty.

property code#

Stable machine-readable issue code.

hasIssue(
self: omni.converter.dgn._omni_converter_dgn.Issue,
) → bool#

Return whether code differs from eNone. An empty Issue returns False.

property message#

Description of the condition, cause, and any recovery or consequence. Use formatIssue() to include the subject.

property subject#

Code-specific identity of the object associated with the issue, or an empty string when not set.