PDG_SerializationOptions Struct Reference

#include <PDG_SerializationOptions.h>

Public Types
enum	CompressType { eCompressAutomatic, eCompressNone, eCompressGZip }
	Enumeration of supported file compression t ypes. More...

Public Member Functions
	PDG_SerializationOptions ()
UT_CompressionType	compressionType (const UT_StringHolder *file_path=nullptr) const

Static Public Member Functions
static UT_CompressionType	compressionType (CompressType compress_type, const UT_StringHolder *file_path=nullptr)
static bool	isGZipFile (const UT_StringHolder &file_path)

Public Attributes
PDG_AttributeSaveType	myAttribSaveType
	The attribute data flattening mode. More...
CompressType	myCompressType
	Serialization compression mode. More...
bool	myBinary
	Whether or not the work item should be stored as binary data. More...
bool	myRecursive
	Whether or not the serialization should recurse into batches. More...
bool	myPrettyPrint
bool	mySkipDefault
bool	mySaveGlobalAttributes
	Whether or not graph level global attributes should be saved. More...
bool	mySaveBoundAttributes
	Whether or not bound attributes should be saved. More...

Detailed Description

Definition at line 21 of file PDG_SerializationOptions.h.

Member Enumeration Documentation

enum PDG_SerializationOptions::CompressType

Enumeration of supported file compression t ypes.

Enumerator
eCompressAutomatic
eCompressNone
eCompressGZip

Definition at line 24 of file PDG_SerializationOptions.h.

Constructor & Destructor Documentation

PDG_SerializationOptions::PDG_SerializationOptions ( )

inline

Constructs a new serialization struct with default values (automatic compression, flattened attributes, etc)

Definition at line 33 of file PDG_SerializationOptions.h.

Member Function Documentation

UT_CompressionType PDG_SerializationOptions::compressionType ( const UT_StringHolder *  file_path = nullptr ) const

inline

Converts the compression settings and optional file path to a UT_CompressionType. If the CompressType type is Automatic, then the extension on the file is used to determine whether or not gzip compression should be used

Definition at line 47 of file PDG_SerializationOptions.h.

static UT_CompressionType PDG_SerializationOptions::compressionType ( CompressType  compress_type, const UT_StringHolder *  file_path = nullptr  )

inlinestatic

Static version of the compressionType, whichc can be called without any arguments

Definition at line 55 of file PDG_SerializationOptions.h.

static bool PDG_SerializationOptions::isGZipFile ( const UT_StringHolder &  file_path )

inlinestatic

Returns true if the specified file has the .gz extension, otherwise return false

Definition at line 72 of file PDG_SerializationOptions.h.

Member Data Documentation

PDG_AttributeSaveType PDG_SerializationOptions::myAttribSaveType

The attribute data flattening mode.

Definition at line 81 of file PDG_SerializationOptions.h.

bool PDG_SerializationOptions::myBinary

Whether or not the work item should be stored as binary data.

Definition at line 87 of file PDG_SerializationOptions.h.

CompressType PDG_SerializationOptions::myCompressType

Serialization compression mode.

Definition at line 84 of file PDG_SerializationOptions.h.

bool PDG_SerializationOptions::myPrettyPrint

Whether or not the serialization should be human-readable or use minimal whitespace.

Definition at line 94 of file PDG_SerializationOptions.h.

bool PDG_SerializationOptions::myRecursive

Whether or not the serialization should recurse into batches.

Definition at line 90 of file PDG_SerializationOptions.h.

bool PDG_SerializationOptions::mySaveBoundAttributes

Whether or not bound attributes should be saved.

Definition at line 104 of file PDG_SerializationOptions.h.

bool PDG_SerializationOptions::mySaveGlobalAttributes

Whether or not graph level global attributes should be saved.

Definition at line 101 of file PDG_SerializationOptions.h.

bool PDG_SerializationOptions::mySkipDefault

Whether or not the serialization should skip fields that are at their default value

Definition at line 98 of file PDG_SerializationOptions.h.

---

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

• PDG/PDG_SerializationOptions.h