Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::JsonSerializerContext Class Referencefinal

Inherits AZ::JsonBaseContext.

Public Member Functions

 JsonSerializerContext (JsonSerializerSettings &settings, rapidjson::Document::AllocatorType &jsonAllocator)
 
 JsonSerializerContext (const JsonSerializerContext &)=delete
 
 JsonSerializerContext (JsonSerializerContext &&)=delete
 
JsonSerializerContextoperator= (const JsonSerializerContext &)=delete
 
JsonSerializerContextoperator= (JsonSerializerContext &&)=delete
 
rapidjson::Document::AllocatorType & GetJsonAllocator ()
 The allocator used to add new values to the a json value, if needed.
 
bool ShouldKeepDefaults () const
 If true default value will be stored, otherwise only changed values will be stored.
 
- Public Member Functions inherited from AZ::JsonBaseContext
 JsonBaseContext (JsonSerializationMetadata &metadata, JsonSerializationResult::JsonIssueCallback reporting, StackedString::Format pathFormat, SerializeContext *serializeContext, JsonRegistrationContext *registrationContext)
 
JsonSerializationResult::Result Report (JsonSerializationResult::ResultCode result, AZStd::string_view message) const
 
JsonSerializationResult::Result Report (JsonSerializationResult::Tasks task, JsonSerializationResult::Outcomes outcome, AZStd::string_view message) const
 
void PushReporter (JsonSerializationResult::JsonIssueCallback callback)
 Push a (temporary) new callback to the reporter stack. The top reporter will always be used.
 
void PopReporter ()
 
const JsonSerializationResult::JsonIssueCallbackGetReporter () const
 Get the currently active reporter.
 
JsonSerializationResult::JsonIssueCallbackGetReporter ()
 Get the currently active reporter.
 
void PushPath (AZStd::string_view child)
 Add a child name to the path.
 
void PushPath (size_t index)
 Add an index to the path.
 
void PopPath ()
 Remove a previously added entry to the path.
 
const StackedStringGetPath () const
 Gets the path to the element that's currently being operated on.
 
JsonSerializationMetadataGetMetadata ()
 
const JsonSerializationMetadataGetMetadata () const
 
SerializeContextGetSerializeContext ()
 
const SerializeContextGetSerializeContext () const
 
JsonRegistrationContextGetRegistrationContext ()
 
const JsonRegistrationContextGetRegistrationContext () const
 

Additional Inherited Members

- Protected Attributes inherited from AZ::JsonBaseContext
AZStd::stack< JsonSerializationResult::JsonIssueCallbackm_reporters
 
StackedString m_path
 Path to the element that's currently being operated on.
 
JsonSerializationMetadatam_metadata
 
SerializeContextm_serializeContext = nullptr
 The Serialize Context that can be used to retrieve meta data during processing.
 
JsonRegistrationContextm_registrationContext = nullptr
 The registration context for the json serialization. This can be used to retrieve the handlers for specific types.
 

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