Public Types
enum	StatType { eQueueTime, eScheduleTime, eCookStartTime, eCookEndTime, eFileSize, eStatCount }
	Enumeration of stats stored in this object. More...

Public Member Functions
	PDG_WorkItemStats ()
	Constructs and zero-initializes the stat object. More...

void	reset ()
	Resets all stats on the work item. More...

fpreal	getStat (StatType stat) const
	Returns the current value of the specified stat type. More...

fpreal	setStat (StatType stat, fpreal value)
	Sets the value of the specified stat type. More...

fpreal	setTimeStat (StatType stat)
	Sets the value of the specified stat to the current time. More...

fpreal	cookDuration () const

void	setServiceClient (const UT_StringHolder &client)
	Sets the service client used to cook the work item. More...

const UT_StringHolder &	serviceClient () const

Detailed Description

Definition at line 21 of file PDG_WorkItemStats.h.

Member Enumeration Documentation

Enumeration of stats stored in this object.

Enumerator
eQueueTime	The time at which the work item was submitted to the PDG scheduler queue
eScheduleTime	The time at which the work item was passed to the onSchedule call for the active scheduler
eCookStartTime	The time at which the work item began cooking. For scheduled items, this is set when the startCook message is recevied, not when the item is scheduled.
eCookEndTime	The time at which the work item completed cooking.
eFileSize	The total file size of all outputs on the work item.
eStatCount	The number of tracked stats.

Definition at line 25 of file PDG_WorkItemStats.h.

PDG_WorkItemStats::PDG_WorkItemStats ( )

Constructs and zero-initializes the stat object.

fpreal PDG_WorkItemStats::cookDuration ( ) const

Returns the cook duration for the work item. e.g. the time spent between starting and stopping cooking

fpreal PDG_WorkItemStats::getStat ( StatType stat ) const

Returns the current value of the specified stat type.

void PDG_WorkItemStats::reset ( )

Resets all stats on the work item.

const UT_StringHolder& PDG_WorkItemStats::serviceClient ( ) const

inline

Returns the service client name used to cook this work item, or empty string if the work item didn't cook using services

Definition at line 76 of file PDG_WorkItemStats.h.

void PDG_WorkItemStats::setServiceClient ( const UT_StringHolder & client )

inline

Sets the service client used to cook the work item.

Definition at line 71 of file PDG_WorkItemStats.h.

fpreal PDG_WorkItemStats::setStat	(	StatType	stat,
		fpreal	value
	)

Sets the value of the specified stat type.

fpreal PDG_WorkItemStats::setTimeStat ( StatType stat )

Sets the value of the specified stat to the current time.

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