PDG_AttributeClassify Class Reference

#include <PDG_AttributeClassify.h>

Public Types
using	AttributeMap = UT_ArrayMap< SYS_HashType, PDG_WorkItemIDArray >
using	ClassMap = UT_ArrayMap< PDG_WorkItemID, UT_ExintArray >

Public Member Functions
const AttributeMap &	classifications () const
exint	numKeys () const
void	classifications (ClassMap &class_map) const
bool	classifyAll (const UT_StringArray &names, const PDG_WorkItem *work_item, bool skip_failures, UT_WorkBuffer &errors)
bool	classifyEach (const UT_StringArray &names, const PDG_WorkItem *work_item, bool skip_failures, UT_WorkBuffer &errors)

Detailed Description

Definition at line 30 of file PDG_AttributeClassify.h.

Member Typedef Documentation

using PDG_AttributeClassify::AttributeMap = UT_ArrayMap<SYS_HashType, PDG_WorkItemIDArray>

A map of attribute hash to the work items that match that particular class.

Definition at line 35 of file PDG_AttributeClassify.h.

using PDG_AttributeClassify::ClassMap = UT_ArrayMap<PDG_WorkItemID, UT_ExintArray>

A map of work item ID to the monotonically increasing class numbers that the work item is a part of

Definition at line 39 of file PDG_AttributeClassify.h.

Member Function Documentation

const AttributeMap& PDG_AttributeClassify::classifications ( ) const

inline

Returns the immediate results of classification, as a map of attrib hash to the matching work items

Definition at line 44 of file PDG_AttributeClassify.h.

void PDG_AttributeClassify::classifications

(

ClassMap &

class_map

)

const

Returns a map of work item ID to class, produced by post-processing the classification map

bool PDG_AttributeClassify::classifyAll	(	const UT_StringArray &	names,
		const PDG_WorkItem *	work_item,
		bool	skip_failures,
		UT_WorkBuffer &	errors
	)

Classifies the work item by creating a unique classification for ALL attribute names. Returns true if the work item has the desired set of attributes, and false if the work item is missing an attribute.

bool PDG_AttributeClassify::classifyEach	(	const UT_StringArray &	names,
		const PDG_WorkItem *	work_item,
		bool	skip_failures,
		UT_WorkBuffer &	errors
	)

Classifies the work item by creating a unique classification for EACH attribute name. Returns true if the work items has the desired set of attributes, and false if the work items is missing an attribute.

exint PDG_AttributeClassify::numKeys ( ) const

inline

Returns the number of unique classifiction keys found from the input work items

Definition at line 49 of file PDG_AttributeClassify.h.

---

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

• PDG/PDG_AttributeClassify.h