vrs::JsonFormatProfileSpec Struct Reference

When printing out a DataLayout as json, this class allows to specify what should be included in the generated json message. More...

#include <DataLayout.h>

Public Member Functions
	JsonFormatProfileSpec (JsonFormatProfile profile)

Public Attributes
bool	publicNames = false
	Use internal names, or public names. "data_layout" vs. "metadata".
bool	prettyJson = false
	Format the text so that it is easier to read.
bool	value = false
	Include the value of the data piece elements.
bool	name = true
	Include the label name.
bool	type = true
	Include the type name.
bool	shortType = false
	Use the short version of the type names.
bool	index = true
	Include the index of the data pieces.
bool	defaults = true
	Include default values.
bool	tags = true
	Include tags.
bool	properties = true
	Includes properties.
bool	required = true
	Include the required flag.

Detailed Description

When printing out a DataLayout as json, this class allows to specify what should be included in the generated json message.

The default constructor provides the profile needed for the description of DataLayout stored in VRS files, to document a DataLayoutContentBlock. Therefore, this default profile should not be changed, or DataLayout blocks might not be read correctly.

Default values are for VRS internal usage: DO NOT CHANGE THIS FORMAT IN ANY WAY!

---

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

• vrs/DataLayout.h
• vrs/DataLayout.cpp