occ
Loading...
Searching...
No Matches
occ::main::DescribeOutcome Struct Reference

What became of one input structure: a file, or one data block of a CIF. More...

#include <occ_describe.h>

Public Types

enum class  Status { Described , Skipped , Failed }

Public Attributes

std::string filename
std::string block
 The CIF data block, or the file's stem for other formats.
int index {0}
 Position of the block in its file, from 0.
Status status {Status::Described}
std::string detail
 The RINSE hash of a crystal; for a skipped or failed structure, the reason.
occ::Vec values
 The flattened RINSE descriptor of a described crystal, otherwise empty.

Detailed Description

What became of one input structure: a file, or one data block of a CIF.

Member Enumeration Documentation

◆ Status

Enumerator
Described 
Skipped 
Failed 

Member Data Documentation

◆ block

std::string occ::main::DescribeOutcome::block

The CIF data block, or the file's stem for other formats.

◆ detail

std::string occ::main::DescribeOutcome::detail

The RINSE hash of a crystal; for a skipped or failed structure, the reason.

◆ filename

std::string occ::main::DescribeOutcome::filename

◆ index

int occ::main::DescribeOutcome::index {0}

Position of the block in its file, from 0.

◆ status

Status occ::main::DescribeOutcome::status {Status::Described}

◆ values

occ::Vec occ::main::DescribeOutcome::values

The flattened RINSE descriptor of a described crystal, otherwise empty.


The documentation for this struct was generated from the following file: