OfficeDiagnostic Class Documentation

class OfficeDiagnostic

Namespace:datalogics_interface

Detailed Description

One per-asset report from an Office conversion. A diagnostic describes how the document was rendered, such as a font that was substituted, and a successful conversion can carry several.

Referenced by

Constructor & Destructor Documentation

OfficeDiagnostic

OfficeDiagnostic()

An empty diagnostic of kind Other.

OfficeDiagnostic

OfficeDiagnostic(OfficeDiagnosticKind kind, int code, std::string asset, std::string message)

Parameters

kind: OfficeDiagnosticKind

What happened.

code: int

The plug-in's number for the kind.

asset: std::string

What it happened to, which may be empty.

message: std::string

A sentence for a log.

A diagnostic with every field.

Member Function Documentation

get_asset

const std::string & get_asset()

Returns:

const std::string &

What it happened to, such as a font's name or an image's part; may be empty.

get_code

int get_code()

Returns:

int

The plug-in's number for the kind, kept for a kind of Other.

get_message

const std::string & get_message()

Returns:

const std::string &

A sentence for a log.