RcnCountResultGroup Struct Reference

Result type for a group of analysis operations on a single source entity. More...

#include <reckon/reckon.h>

Data Fields
RcnCount	logicalLines
	The counted logical lines of code.
RcnCount	physicalLines
	The counted hard physical lines.
RcnCount	words
	The counted words.
RcnCount	characters
	The counted characters.
RcnCount	sourceSize
	The size of the source entity in bytes.
RcnResultState	state
	The state of performed operations, indicating success or failure.
bool	isProcessed
	Indicates whether the source entity was actually processed.

Detailed Description

Result type for a group of analysis operations on a single source entity.

Represents the end results of possibly multiple count operations performed on a single named source entity, like a specific source file. This is used to group multiple different count metrics together into a single type.

Field Documentation

characters

RcnCount RcnCountResultGroup::characters

The counted characters.

isProcessed

bool RcnCountResultGroup::isProcessed

Indicates whether the source entity was actually processed.

If this is false, then no counts are available and all count values are zero. This may happen if the source entity's format is not supported, was not selected in a performed analysis operation, an attempt to read the source file content failed, or some other error has occurred. A processed entity might still have zero counts, e.g. if it is an empty file, and it might still have errors as indicated in the state field.

logicalLines

RcnCount RcnCountResultGroup::logicalLines

The counted logical lines of code.

physicalLines

RcnCount RcnCountResultGroup::physicalLines

The counted hard physical lines.

sourceSize

RcnCount RcnCountResultGroup::sourceSize

The size of the source entity in bytes.

state

RcnResultState RcnCountResultGroup::state

The state of performed operations, indicating success or failure.

words

RcnCount RcnCountResultGroup::words

The counted words.