#include <PDG_WorkItemSerialization.h>

Classes
struct	Stat

Public Types
enum	CheckpointType { eCheckpointNone, eCheckpointInitial, eCheckpointUpdate }

using	Array = UT_Array< PDG_WorkItemSerialization >

using	Map = UT_ArrayStringMap< PDG_WorkItem * >

Public Member Functions
	PDG_WorkItemSerialization (int version=0)
	Constructs an empty, default-initialized serialization object. More...

bool	loadAttributes (const UT_JSONValue &value, PDG_AttributeSaveType save_type, bool reset)
	Loads work item attributes from a JSON value. More...

bool	loadAttributes (const UT_WorkBuffer &buffer, PDG_AttributeSaveType save_type, bool reset)
	Loads work item attributres from a buffer. More...

PDG_WorkItem *	toWorkItem (PDG_GraphContext *context, PDG_WorkItemID base_id, bool strict, Map &compat_map, UT_WorkBuffer &errors) const

bool	initializeString (const UT_StringHolder &data, UT_WorkBuffer &errors)
	Initializes this instance from JSON string data. More...

bool	initializeStream (UT_IStream &istream, UT_WorkBuffer &errors)
	Initializes this instance from a stream of JSON data. More...

bool	initializeFile (const UT_StringHolder &file_path, UT_WorkBuffer &errors)
	Initializes this instance from a JSON file. More...

bool	initializeDict (const UT_OptionsHolder &dict, UT_WorkBuffer &errors)
	Initializes this instance from a dictionary. More...

UT_StringHolder	workItemName () const

Static Public Member Functions
static bool	saveJSON (UT_WorkBuffer &buffer, const PDG_WorkItem *work_item, const PDG_SerializationOptions &options, CheckpointType checkpoint=eCheckpointNone)
	Saves the specified work item to the buffer, as JSON. More...

static bool	saveJSON (std::ostream &ostream, const PDG_WorkItem *work_item, const PDG_SerializationOptions &options, CheckpointType checkpoint=eCheckpointNone)
	Saves the specified work item to the stream, as JSON. More...

static bool	saveJSON (const UT_StringHolder &file_path, const PDG_WorkItem *work_item, const PDG_SerializationOptions &options, CheckpointType checkpoint=eCheckpointNone)
	Saves the specified work item to the file, as JSON. More...

static bool	saveDict (UT_OptionsHolder &dict, const PDG_WorkItem *work_item, const PDG_SerializationOptions &options, CheckpointType checkpoint=eCheckpointNone)
	Saves the specified work item to the UT_Options as a dictionary. More...

static bool	saveArrayJSON (UT_WorkBuffer &buffer, const PDG_WorkItemArray &work_items, const PDG_SerializationOptions &options, CheckpointType checkpoint=eCheckpointNone)
	Saves the specified work item array to the buffer, as JSON. More...

static bool	saveArrayJSON (std::ostream &ostream, const PDG_WorkItemArray &work_items, const PDG_SerializationOptions &options, CheckpointType checkpoint=eCheckpointNone)
	Saves the specified work item array to the stream, as JSON. More...

static bool	saveArrayJSON (const UT_StringHolder &file_path, const PDG_WorkItemArray &work_items, const PDG_SerializationOptions &options, CheckpointType checkpoint=eCheckpointNone)
	Saves the specified work item array to the file, as JSON. More...

static bool	saveArrayDict (UT_OptionsHolder &dict, const PDG_WorkItemArray &work_items, const PDG_SerializationOptions &options, CheckpointType checkpoint=eCheckpointNone)
	Saves the specified work item array to UT_Options. More...

static bool	saveDependencyJSON (UT_WorkBuffer &buffer, const PDG_WorkItem from, const PDG_WorkItem to, bool required, bool user_defined, const PDG_SerializationOptions &options, CheckpointType checkpoint=eCheckpointNone)
	Saves the specified work item dependency pair to the buffer, as JSON. More...

static bool	saveDependencyJSON (std::ostream &ostream, const PDG_WorkItem from, const PDG_WorkItem to, bool required, bool user_defined, const PDG_SerializationOptions &options, CheckpointType checkpoint=eCheckpointNone)
	Saves the specified work item dependency pair to the stream, as JSON. More...

static bool	saveDependencyJSON (const UT_StringHolder &file_path, const PDG_WorkItem from, const PDG_WorkItem to, bool required, bool user_defined, const PDG_SerializationOptions &options, CheckpointType checkpoint=eCheckpointNone)
	Saves the specified work item dependency pair to the file, as JSON. More...

static bool	saveVersion (UT_WorkBuffer &buffer, const PDG_SerializationOptions &options)
	Saves a map with the data version to the buffer, as JSON. More...

static bool	saveVersion (std::ostream &ostream, const PDG_SerializationOptions &options)
	Saves a map with the data version to the stream, as JSON. More...

static bool	saveVersion (const UT_StringHolder &file_path, const PDG_SerializationOptions &options)
	Saves a map with the data version to the file, as JSON. More...

static bool	savePython (UT_WorkBuffer &buffer, const PDG_WorkItem *work_item, const PDG_SerializationOptions &options)
	Saves the specified work item to the buffer, as a Python script. More...

static PDG_WorkItem *	fromJSON (const UT_StringHolder &buffer, PDG_GraphContext *context, Map &compat_map, bool make_active, UT_WorkBuffer &errors)
	Loads a work item from a buffer containing JSON string data. More...

static PDG_WorkItem *	fromJSON (UT_IStream &istream, bool make_active, UT_WorkBuffer &errors)
	Loads a work item from a stream containing JSON data. More...

static PDG_WorkItem *	fromJSON (const UT_StringHolder &file_path, bool make_active, UT_WorkBuffer &errors)
	Loads a work item from a file path. More...

static PDG_WorkItem *	fromDict (const UT_OptionsHolder &dict, bool make_active, UT_WorkBuffer &errors)
	Loads a work item from a dict. More...

static bool	fromArrayJSON (PDG_WorkItemArray &work_items, UT_IStream &istream, PDG_GraphContext *context, bool is_compressed, UT_WorkBuffer &errors)
	Loads a work item array from a stream containing JSON data. More...

static bool	fromArrayJSON (Array &serialization_array, const UT_StringHolder &buffer, UT_WorkBuffer &errors)
	Loads a serialization object array from a buffer containing JSON data. More...

static bool	fromArrayJSON (Array &serialization_array, const UT_StringHolder &file_path, bool is_compressed, UT_WorkBuffer &errors)
	Loads a serialization object array from a file containing JSON data. More...

static bool	fromArrayDict (Array &serialization_array, const UT_OptionsHolder &dict, UT_WorkBuffer &errors)
	Loads a serialization object array from a dictionary. More...

static bool	statJSON (Stat &json_stat, const UT_StringHolder &buffer, UT_WorkBuffer &errors)
	Stats the JSON data in the specified string. More...

static bool	statJSON (Stat &json_stat, const UT_StringHolder &file_path, bool is_compressed, UT_WorkBuffer &errors)
	Stats the JSON data in the specified file. More...

static bool	statJSON (Stat &json_stat, UT_IStream &istream, bool is_compressed, UT_WorkBuffer &errors)
	Stats the JSON data in the stream. More...

static bool	statDict (Stat &dict_stat, const UT_OptionsHolder &dict, UT_WorkBuffer &errors)
	Stats the dictionary data. More...

static UT_StringHolder	createJSONPatch (const PDG_WorkItem *work_item, bool pretty_print)

static bool	applyJSONPatch (PDG_WorkItem *work_item, const UT_JSONValueMap &patch_map, UT_WorkBuffer &errors)

static bool	loadCheckpoint (PDG_GraphContext *context, const UT_StringHolder &file_path, UT_WorkBuffer &errors)
	Loads a checkpoint .json file. More...

Public Attributes
UT_StringArray	myLoopBeginStackNames

UT_StringArray	myStaticAncestorNames

UT_Array< int64 >	myLoopBeginStackIds

UT_Array< int64 >	myLoopBeginStackNumbers

UT_Array< int64 >	myLoopBeginStackIters

UT_Array< int64 >	myLoopBeginStackSizes

UT_Array< int64 >	myLoopBeginStackLockIds

Array	mySubItems

PDG_File::Array	myInputs

UT_StringHolder	myNodeName

UT_StringHolder	mySchedulerName

UT_StringHolder	myName

UT_StringHolder	myBaseName

UT_StringHolder	myBatchName

UT_StringHolder	myCommand

UT_StringHolder	myParentName

UT_StringHolder	myBatchParentName

UT_StringHolder	myCloneTargetName

UT_StringHolder	myCustomDataType

UT_StringHolder	myCustomData

PDG_AttributeMap	myAttributes

PDGT_Value::Map	myEnvironment

PDG_WorkItemID	myParentId

PDG_WorkItemID	myBatchParentId

PDG_WorkItemID	myCloneTargetId

PDG_WorkItemID	myId

int	myVersion

int	myIndex

int	myBatchIndex

int	myPriority

int	myInputExpansion

int	myBatchCount

int	myBatchOffset

int	myBatchStart

int	myBatchActivationCount

fpreal	myFrame

fpreal	myFrameStep

bool	myHasFrame

bool	myIsPostCook

bool	myIsStatic

bool	myIsControl

bool	myIsNoGenerate

bool	myIsClearEnvironment

bool	myIsCloneOutputFiles

bool	myIsFrozen

bool	myIsPartialCook

bool	myIsDynamicBatch

PDG_WorkItemState	myState

PDG_WorkItemType	myType

PDG_WorkItemExecutionType	myExecutionType

PDG_WorkItemCookType	myCookType

PDG_BatchActivation	myActivationMode

Static Public Attributes
static const UT_StringHolder	theNodeKey

static const UT_StringHolder	theSchedulerKey

static const UT_StringHolder	theIdKey

static const UT_StringHolder	theBatchParentIdKey

static const UT_StringHolder	theCloneTargetIdKey

static const UT_StringHolder	theLoopStackIdsKey

static const UT_StringHolder	theLoopStackNumbersKey

static const UT_StringHolder	theLoopStackItersKey

static const UT_StringHolder	theLoopStackSizesKey

static const UT_StringHolder	theLoopStackLockIdsKey

static const UT_StringHolder	theCustomDataTypeKey

static const UT_StringHolder	theCustomDataKey

static const UT_StringHolder	theAttributesKey

static const UT_StringHolder	theIndexKey

static const UT_StringHolder	theBatchIndexKey

static const UT_StringHolder	thePriorityKey

static const UT_StringHolder	theFrameKey

static const UT_StringHolder	theFrameStepKey

static const UT_StringHolder	theHasFrameKey

static const UT_StringHolder	theIsPostCookKey

static const UT_StringHolder	theIsStaticKey

static const UT_StringHolder	theIsNoGenerateKey

static const UT_StringHolder	theIsCloneOutputFilesKey

static const UT_StringHolder	theIsFrozenKey

static const UT_StringHolder	theStateKey

static const UT_StringHolder	theTypeKey

static const UT_StringHolder	theExecutionTypeKey

static const UT_StringHolder	theCookTypeKey

static const UT_StringHolder	theBatchNameKey

static const UT_StringHolder	theBatchCountKey

static const UT_StringHolder	theBatchOffsetKey

static const UT_StringHolder	theBatchStartKey

static const UT_StringHolder	theIsPartialCookKey

static const UT_StringHolder	theIsDynamicBatchKey

static const UT_StringHolder	theActivationModeKey

static const UT_StringHolder	theActivationCountKey

static const UT_StringHolder	theSubItemsKey

static const UT_StringHolder	thePatchOutputsKey

static const UT_StringHolder	thePatchAttributesKey

static const UT_StringHolder	thePatchGraphKey

static const UT_StringHolder	theDependencyFromKey

static const UT_StringHolder	theDependencyToKey

static const UT_StringHolder	theDependencyRequiredKey

static const UT_StringHolder	theVersionSectionKey

static const UT_StringHolder	theWorkItemSectionKey

static const UT_StringHolder	theWorkItemsSectionKey

static const UT_StringHolder	theGraphSectionKey

static const UT_StringHolder	theDependencySectionKey

static const UT_StringHolder	theNameKey

static const UT_StringHolder	theBaseNameKey

static const UT_StringHolder	theParentKey

static const UT_StringHolder	theParentIdKey

static const UT_StringHolder	theBatchParentKey

static const UT_StringHolder	theCloneTargetKey

static const UT_StringHolder	theAncestorsKey

static const UT_StringHolder	theLoopStackKey

static const UT_StringHolder	theIsClearEnvKey

static const UT_StringHolder	theEnvironmentKey

static const UT_StringHolder	theIsControlKey

static const UT_StringHolder	theExpansionKey

static const UT_StringHolder	theCommandKey

static const UT_StringHolder	theIsInProcessKey

static const int	theAttribVersionCurrent

static const int	theAttribV1

static const int	theAttribV2

static const int	theAttribV2Ids

static const int	theAttribV2Command

static const int	theAttribV2LoopInfo

static const int	theAttribV2CookType

static const int	theAttribV2LoopLock

Detailed Description

Helper class for loading and storing work items to serialization formats

Definition at line 44 of file PDG_WorkItemSerialization.h.

Member Typedef Documentation

using PDG_WorkItemSerialization::Array = UT_Array<PDG_WorkItemSerialization>

Definition at line 47 of file PDG_WorkItemSerialization.h.

using PDG_WorkItemSerialization::Map = UT_ArrayStringMap<PDG_WorkItem*>

Definition at line 48 of file PDG_WorkItemSerialization.h.

Member Enumeration Documentation

enum PDG_WorkItemSerialization::CheckpointType

Enumeration of checkpoint save types, which are used to determine which set of fields to write to the JSON object for a serialized work item

Enumerator
eCheckpointNone	Serialize all fields – no checkpointing is in progress.
eCheckpointInitial	Serialize the initial baseline fields for the work item.
eCheckpointUpdate	Serialize only fields that can be updated dynamically, when the work item cooks

Definition at line 64 of file PDG_WorkItemSerialization.h.

Constructor & Destructor Documentation

PDG_WorkItemSerialization::PDG_WorkItemSerialization ( int version = 0 )

Constructs an empty, default-initialized serialization object.

Member Function Documentation

static bool PDG_WorkItemSerialization::applyJSONPatch	(	PDG_WorkItem *	work_item,
		const UT_JSONValueMap &	patch_map,
		UT_WorkBuffer &	errors
	)

static

Updates work item outputs and attributes from the patch stored in the json map

static UT_StringHolder PDG_WorkItemSerialization::createJSONPatch	(	const PDG_WorkItem *	work_item,
		bool	pretty_print
	)

static

Creates a JSON patch from changed attributes and outputs on the work item

static bool PDG_WorkItemSerialization::fromArrayDict	(	Array &	serialization_array,
		const UT_OptionsHolder &	dict,
		UT_WorkBuffer &	errors
	)

static

Loads a serialization object array from a dictionary.

static bool PDG_WorkItemSerialization::fromArrayJSON	(	PDG_WorkItemArray &	work_items,
		UT_IStream &	istream,
		PDG_GraphContext *	context,
		bool	is_compressed,
		UT_WorkBuffer &	errors
	)

static

Loads a work item array from a stream containing JSON data.

static bool PDG_WorkItemSerialization::fromArrayJSON	(	Array &	serialization_array,
		const UT_StringHolder &	buffer,
		UT_WorkBuffer &	errors
	)

static

Loads a serialization object array from a buffer containing JSON data.

static bool PDG_WorkItemSerialization::fromArrayJSON	(	Array &	serialization_array,
		const UT_StringHolder &	file_path,
		bool	is_compressed,
		UT_WorkBuffer &	errors
	)

static

Loads a serialization object array from a file containing JSON data.

static PDG_WorkItem* PDG_WorkItemSerialization::fromDict	(	const UT_OptionsHolder &	dict,
		bool	make_active,
		UT_WorkBuffer &	errors
	)

static

Loads a work item from a dict.

static PDG_WorkItem* PDG_WorkItemSerialization::fromJSON	(	const UT_StringHolder &	buffer,
		PDG_GraphContext *	context,
		Map &	compat_map,
		bool	make_active,
		UT_WorkBuffer &	errors
	)

static

Loads a work item from a buffer containing JSON string data.

static PDG_WorkItem* PDG_WorkItemSerialization::fromJSON	(	UT_IStream &	istream,
		bool	make_active,
		UT_WorkBuffer &	errors
	)

static

Loads a work item from a stream containing JSON data.

static PDG_WorkItem* PDG_WorkItemSerialization::fromJSON	(	const UT_StringHolder &	file_path,
		bool	make_active,
		UT_WorkBuffer &	errors
	)

static

Loads a work item from a file path.

bool PDG_WorkItemSerialization::initializeDict	(	const UT_OptionsHolder &	dict,
		UT_WorkBuffer &	errors
	)

Initializes this instance from a dictionary.

bool PDG_WorkItemSerialization::initializeFile	(	const UT_StringHolder &	file_path,
		UT_WorkBuffer &	errors
	)

Initializes this instance from a JSON file.

bool PDG_WorkItemSerialization::initializeStream	(	UT_IStream &	istream,
		UT_WorkBuffer &	errors
	)

Initializes this instance from a stream of JSON data.

bool PDG_WorkItemSerialization::initializeString	(	const UT_StringHolder &	data,
		UT_WorkBuffer &	errors
	)

Initializes this instance from JSON string data.

bool PDG_WorkItemSerialization::loadAttributes	(	const UT_JSONValue &	value,
		PDG_AttributeSaveType	save_type,
		bool	reset
	)

Loads work item attributes from a JSON value.

bool PDG_WorkItemSerialization::loadAttributes	(	const UT_WorkBuffer &	buffer,
		PDG_AttributeSaveType	save_type,
		bool	reset
	)

Loads work item attributres from a buffer.

static bool PDG_WorkItemSerialization::loadCheckpoint	(	PDG_GraphContext *	context,
		const UT_StringHolder &	file_path,
		UT_WorkBuffer &	errors
	)

static

Loads a checkpoint .json file.

static bool PDG_WorkItemSerialization::saveArrayDict	(	UT_OptionsHolder &	dict,
		const PDG_WorkItemArray &	work_items,
		const PDG_SerializationOptions &	options,
		CheckpointType	checkpoint = `eCheckpointNone`
	)

static

Saves the specified work item array to UT_Options.

static bool PDG_WorkItemSerialization::saveArrayJSON	(	UT_WorkBuffer &	buffer,
		const PDG_WorkItemArray &	work_items,
		const PDG_SerializationOptions &	options,
		CheckpointType	checkpoint = `eCheckpointNone`
	)

static

Saves the specified work item array to the buffer, as JSON.

static bool PDG_WorkItemSerialization::saveArrayJSON	(	std::ostream &	ostream,
		const PDG_WorkItemArray &	work_items,
		const PDG_SerializationOptions &	options,
		CheckpointType	checkpoint = `eCheckpointNone`
	)

static

Saves the specified work item array to the stream, as JSON.

static bool PDG_WorkItemSerialization::saveArrayJSON	(	const UT_StringHolder &	file_path,
		const PDG_WorkItemArray &	work_items,
		const PDG_SerializationOptions &	options,
		CheckpointType	checkpoint = `eCheckpointNone`
	)

static

Saves the specified work item array to the file, as JSON.

static bool PDG_WorkItemSerialization::saveDependencyJSON	(	UT_WorkBuffer &	buffer,
		const PDG_WorkItem *	from,
		const PDG_WorkItem *	to,
		bool	required,
		bool	user_defined,
		const PDG_SerializationOptions &	options,
		CheckpointType	checkpoint = `eCheckpointNone`
	)

static

Saves the specified work item dependency pair to the buffer, as JSON.

static bool PDG_WorkItemSerialization::saveDependencyJSON	(	std::ostream &	ostream,
		const PDG_WorkItem *	from,
		const PDG_WorkItem *	to,
		bool	required,
		bool	user_defined,
		const PDG_SerializationOptions &	options,
		CheckpointType	checkpoint = `eCheckpointNone`
	)

static

Saves the specified work item dependency pair to the stream, as JSON.

static bool PDG_WorkItemSerialization::saveDependencyJSON	(	const UT_StringHolder &	file_path,
		const PDG_WorkItem *	from,
		const PDG_WorkItem *	to,
		bool	required,
		bool	user_defined,
		const PDG_SerializationOptions &	options,
		CheckpointType	checkpoint = `eCheckpointNone`
	)

static

Saves the specified work item dependency pair to the file, as JSON.

static bool PDG_WorkItemSerialization::saveDict	(	UT_OptionsHolder &	dict,
		const PDG_WorkItem *	work_item,
		const PDG_SerializationOptions &	options,
		CheckpointType	checkpoint = `eCheckpointNone`
	)

static

Saves the specified work item to the UT_Options as a dictionary.

static bool PDG_WorkItemSerialization::saveJSON	(	UT_WorkBuffer &	buffer,
		const PDG_WorkItem *	work_item,
		const PDG_SerializationOptions &	options,
		CheckpointType	checkpoint = `eCheckpointNone`
	)

static

Saves the specified work item to the buffer, as JSON.

static bool PDG_WorkItemSerialization::saveJSON	(	std::ostream &	ostream,
		const PDG_WorkItem *	work_item,
		const PDG_SerializationOptions &	options,
		CheckpointType	checkpoint = `eCheckpointNone`
	)

static

Saves the specified work item to the stream, as JSON.

static bool PDG_WorkItemSerialization::saveJSON	(	const UT_StringHolder &	file_path,
		const PDG_WorkItem *	work_item,
		const PDG_SerializationOptions &	options,
		CheckpointType	checkpoint = `eCheckpointNone`
	)

static

Saves the specified work item to the file, as JSON.

static bool PDG_WorkItemSerialization::savePython	(	UT_WorkBuffer &	buffer,
		const PDG_WorkItem *	work_item,
		const PDG_SerializationOptions &	options
	)

static

Saves the specified work item to the buffer, as a Python script.

static bool PDG_WorkItemSerialization::saveVersion	(	UT_WorkBuffer &	buffer,
		const PDG_SerializationOptions &	options
	)

static

Saves a map with the data version to the buffer, as JSON.

static bool PDG_WorkItemSerialization::saveVersion	(	std::ostream &	ostream,
		const PDG_SerializationOptions &	options
	)

static

Saves a map with the data version to the stream, as JSON.

static bool PDG_WorkItemSerialization::saveVersion	(	const UT_StringHolder &	file_path,
		const PDG_SerializationOptions &	options
	)

static

Saves a map with the data version to the file, as JSON.

static bool PDG_WorkItemSerialization::statDict	(	Stat &	dict_stat,
		const UT_OptionsHolder &	dict,
		UT_WorkBuffer &	errors
	)

static

Stats the dictionary data.

static bool PDG_WorkItemSerialization::statJSON	(	Stat &	json_stat,
		const UT_StringHolder &	buffer,
		UT_WorkBuffer &	errors
	)

static

Stats the JSON data in the specified string.

static bool PDG_WorkItemSerialization::statJSON	(	Stat &	json_stat,
		const UT_StringHolder &	file_path,
		bool	is_compressed,
		UT_WorkBuffer &	errors
	)

static

Stats the JSON data in the specified file.

static bool PDG_WorkItemSerialization::statJSON	(	Stat &	json_stat,
		UT_IStream &	istream,
		bool	is_compressed,
		UT_WorkBuffer &	errors
	)

static

Stats the JSON data in the stream.

PDG_WorkItem* PDG_WorkItemSerialization::toWorkItem	(	PDG_GraphContext *	context,
		PDG_WorkItemID	base_id,
		bool	strict,
		Map &	compat_map,
		UT_WorkBuffer &	errors
	)		const

Converts the serialization object to a PDG_WorkItem, in the given graph context

UT_StringHolder PDG_WorkItemSerialization::workItemName ( ) const

Returns the work item name. If the serialization object was created from the old, name-based format this returns the work item's name as listed in the json/python data. Otherwise, this method computes the name from the work item's node name and unique ID.