HDK
|
#include <PDG_WorkItemSerialization.h>
Classes | |
struct | Stat |
Public Types | |
enum | CheckpointType { eCheckpointNone, eCheckpointInitial, eCheckpointUpdate } |
using | Array = UT_Array< PDG_WorkItemSerialization > |
using | Map = UT_StringMap< 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_AttributeMap::SaveType save_type, bool reset) |
Loads work item attributes from a JSON value. More... | |
bool | loadAttributes (const UT_WorkBuffer &buffer, PDG_AttributeMap::SaveType 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... | |
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 | 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 | 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 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 | 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 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... | |
Helper class for loading and storing work items to serialization formats
Definition at line 42 of file PDG_WorkItemSerialization.h.
Definition at line 45 of file PDG_WorkItemSerialization.h.
Definition at line 46 of file PDG_WorkItemSerialization.h.
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
Definition at line 62 of file PDG_WorkItemSerialization.h.
PDG_WorkItemSerialization::PDG_WorkItemSerialization | ( | int | version = 0 | ) |
Constructs an empty, default-initialized serialization object.
|
static |
Updates work item outputs and attributes from the patch stored in the json map
|
static |
Creates a JSON patch from changed attributes and outputs on the work item
|
static |
Loads a work item array from a stream containing JSON data.
|
static |
Loads a serialization object array from a buffer containing JSON data.
|
static |
Loads a serialization object array from a file containing JSON data.
|
static |
Loads a work item from a buffer containing JSON string data.
|
static |
Loads a work item from a stream containing JSON data.
|
static |
Loads a work item from a file path.
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_AttributeMap::SaveType | save_type, | ||
bool | reset | ||
) |
Loads work item attributes from a JSON value.
bool PDG_WorkItemSerialization::loadAttributes | ( | const UT_WorkBuffer & | buffer, |
PDG_AttributeMap::SaveType | save_type, | ||
bool | reset | ||
) |
Loads work item attributres from a buffer.
|
static |
Loads a checkpoint .json file.
|
static |
Saves the specified work item array to the buffer, as JSON.
|
static |
Saves the specified work item array to the stream, as JSON.
|
static |
Saves the specified work item array to the file, as JSON.
|
static |
Saves the specified work item dependency pair to the buffer, as JSON.
|
static |
Saves the specified work item dependency pair to the stream, as JSON.
|
static |
Saves the specified work item dependency pair to the file, as JSON.
|
static |
Saves the specified work item to the buffer, as JSON.
|
static |
Saves the specified work item to the stream, as JSON.
|
static |
Saves the specified work item to the file, as JSON.
|
static |
Saves the specified work item to the buffer, as a Python script.
|
static |
Saves a map with the data version to the buffer, as JSON.
|
static |
Saves a map with the data version to the stream, as JSON.
|
static |
Saves a map with the data version to the file, as JSON.
|
static |
Stats the JSON data in the specified string.
|
static |
Stats the JSON data in the specified file.
|
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.
PDG_BatchActivation PDG_WorkItemSerialization::myActivationMode |
Definition at line 612 of file PDG_WorkItemSerialization.h.
|
mutable |
Definition at line 576 of file PDG_WorkItemSerialization.h.
UT_StringHolder PDG_WorkItemSerialization::myBaseName |
Definition at line 566 of file PDG_WorkItemSerialization.h.
int PDG_WorkItemSerialization::myBatchActivationCount |
Definition at line 592 of file PDG_WorkItemSerialization.h.
int PDG_WorkItemSerialization::myBatchCount |
Definition at line 589 of file PDG_WorkItemSerialization.h.
int PDG_WorkItemSerialization::myBatchIndex |
Definition at line 586 of file PDG_WorkItemSerialization.h.
UT_StringHolder PDG_WorkItemSerialization::myBatchName |
Definition at line 567 of file PDG_WorkItemSerialization.h.
int PDG_WorkItemSerialization::myBatchOffset |
Definition at line 590 of file PDG_WorkItemSerialization.h.
PDG_WorkItemID PDG_WorkItemSerialization::myBatchParentId |
Definition at line 580 of file PDG_WorkItemSerialization.h.
UT_StringHolder PDG_WorkItemSerialization::myBatchParentName |
Definition at line 570 of file PDG_WorkItemSerialization.h.
int PDG_WorkItemSerialization::myBatchStart |
Definition at line 591 of file PDG_WorkItemSerialization.h.
PDG_WorkItemID PDG_WorkItemSerialization::myCloneTargetId |
Definition at line 581 of file PDG_WorkItemSerialization.h.
UT_StringHolder PDG_WorkItemSerialization::myCloneTargetName |
Definition at line 571 of file PDG_WorkItemSerialization.h.
UT_StringHolder PDG_WorkItemSerialization::myCommand |
Definition at line 568 of file PDG_WorkItemSerialization.h.
PDG_WorkItemCookType PDG_WorkItemSerialization::myCookType |
Definition at line 611 of file PDG_WorkItemSerialization.h.
UT_StringHolder PDG_WorkItemSerialization::myCustomData |
Definition at line 574 of file PDG_WorkItemSerialization.h.
UT_StringHolder PDG_WorkItemSerialization::myCustomDataType |
Definition at line 573 of file PDG_WorkItemSerialization.h.
PDGT_Value::Map PDG_WorkItemSerialization::myEnvironment |
Definition at line 577 of file PDG_WorkItemSerialization.h.
PDG_WorkItemExecutionType PDG_WorkItemSerialization::myExecutionType |
Definition at line 610 of file PDG_WorkItemSerialization.h.
fpreal PDG_WorkItemSerialization::myFrame |
Definition at line 594 of file PDG_WorkItemSerialization.h.
fpreal PDG_WorkItemSerialization::myFrameStep |
Definition at line 595 of file PDG_WorkItemSerialization.h.
bool PDG_WorkItemSerialization::myHasFrame |
Definition at line 596 of file PDG_WorkItemSerialization.h.
PDG_WorkItemID PDG_WorkItemSerialization::myId |
Definition at line 582 of file PDG_WorkItemSerialization.h.
int PDG_WorkItemSerialization::myIndex |
Definition at line 585 of file PDG_WorkItemSerialization.h.
int PDG_WorkItemSerialization::myInputExpansion |
Definition at line 588 of file PDG_WorkItemSerialization.h.
PDG_File::Array PDG_WorkItemSerialization::myInputs |
Definition at line 561 of file PDG_WorkItemSerialization.h.
bool PDG_WorkItemSerialization::myIsClearEnvironment |
Definition at line 602 of file PDG_WorkItemSerialization.h.
bool PDG_WorkItemSerialization::myIsCloneOutputFiles |
Definition at line 603 of file PDG_WorkItemSerialization.h.
bool PDG_WorkItemSerialization::myIsControl |
Definition at line 600 of file PDG_WorkItemSerialization.h.
bool PDG_WorkItemSerialization::myIsDynamicBatch |
Definition at line 606 of file PDG_WorkItemSerialization.h.
bool PDG_WorkItemSerialization::myIsFrozen |
Definition at line 604 of file PDG_WorkItemSerialization.h.
bool PDG_WorkItemSerialization::myIsNoGenerate |
Definition at line 601 of file PDG_WorkItemSerialization.h.
bool PDG_WorkItemSerialization::myIsPartialCook |
Definition at line 605 of file PDG_WorkItemSerialization.h.
bool PDG_WorkItemSerialization::myIsPostCook |
Definition at line 598 of file PDG_WorkItemSerialization.h.
bool PDG_WorkItemSerialization::myIsStatic |
Definition at line 599 of file PDG_WorkItemSerialization.h.
Definition at line 553 of file PDG_WorkItemSerialization.h.
Definition at line 555 of file PDG_WorkItemSerialization.h.
Definition at line 557 of file PDG_WorkItemSerialization.h.
UT_StringArray PDG_WorkItemSerialization::myLoopBeginStackNames |
Definition at line 550 of file PDG_WorkItemSerialization.h.
Definition at line 554 of file PDG_WorkItemSerialization.h.
Definition at line 556 of file PDG_WorkItemSerialization.h.
UT_StringHolder PDG_WorkItemSerialization::myName |
Definition at line 565 of file PDG_WorkItemSerialization.h.
UT_StringHolder PDG_WorkItemSerialization::myNodeName |
Definition at line 563 of file PDG_WorkItemSerialization.h.
PDG_WorkItemID PDG_WorkItemSerialization::myParentId |
Definition at line 579 of file PDG_WorkItemSerialization.h.
UT_StringHolder PDG_WorkItemSerialization::myParentName |
Definition at line 569 of file PDG_WorkItemSerialization.h.
int PDG_WorkItemSerialization::myPriority |
Definition at line 587 of file PDG_WorkItemSerialization.h.
UT_StringHolder PDG_WorkItemSerialization::mySchedulerName |
Definition at line 564 of file PDG_WorkItemSerialization.h.
PDG_WorkItemState PDG_WorkItemSerialization::myState |
Definition at line 608 of file PDG_WorkItemSerialization.h.
UT_StringArray PDG_WorkItemSerialization::myStaticAncestorNames |
Definition at line 551 of file PDG_WorkItemSerialization.h.
Array PDG_WorkItemSerialization::mySubItems |
Definition at line 559 of file PDG_WorkItemSerialization.h.
PDG_WorkItemType PDG_WorkItemSerialization::myType |
Definition at line 609 of file PDG_WorkItemSerialization.h.
int PDG_WorkItemSerialization::myVersion |
Definition at line 584 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 478 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 477 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 506 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 455 of file PDG_WorkItemSerialization.h.
Definition at line 521 of file PDG_WorkItemSerialization.h.
Definition at line 524 of file PDG_WorkItemSerialization.h.
Definition at line 532 of file PDG_WorkItemSerialization.h.
Definition at line 542 of file PDG_WorkItemSerialization.h.
Definition at line 528 of file PDG_WorkItemSerialization.h.
Definition at line 537 of file PDG_WorkItemSerialization.h.
Definition at line 547 of file PDG_WorkItemSerialization.h.
Definition at line 518 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 501 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 472 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 457 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 471 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 473 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 446 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 504 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 474 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 447 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 505 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 512 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 470 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 454 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 453 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 487 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 489 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 496 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 488 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 509 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 469 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 511 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 459 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 460 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 495 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 461 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 445 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 456 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 508 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 465 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 510 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 476 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 466 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 513 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 464 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 475 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 462 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 463 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 448 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 450 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 507 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 452 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 449 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 451 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 500 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 443 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 503 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 502 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 483 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 484 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 482 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 458 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 444 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 467 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 479 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 468 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 492 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 493 of file PDG_WorkItemSerialization.h.
|
static |
Definition at line 494 of file PDG_WorkItemSerialization.h.