Open 3D Engine AzCore API Reference 25.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
AZ::JsonBasicContainerSerializer Class Reference

Inherits AZ::BaseJsonSerializer.

Public Member Functions

 AZ_RTTI (JsonBasicContainerSerializer, "{3E2D0315-BC21-4127-91A3-E5EFE6826ECE}", BaseJsonSerializer)
 
JsonSerializationResult::Result Load (void *outputValue, const Uuid &outputValueTypeId, const rapidjson::Value &inputValue, JsonDeserializerContext &context) override
 
JsonSerializationResult::Result Store (rapidjson::Value &outputValue, const void *inputValue, const void *defaultValue, const Uuid &valueTypeId, JsonSerializerContext &context) override
 
- Public Member Functions inherited from AZ::BaseJsonSerializer
 AZ_RTTI (BaseJsonSerializer, "{7291FFDC-D339-40B5-BB26-EA067A327B21}")
 
virtual OperationFlags GetOperationsFlags () const
 Returns the operation flags which tells the Json Serialization how this custom json serializer can be used.
 

Public Attributes

 AZ_CLASS_ALLOCATOR_DECL
 

Protected Member Functions

virtual bool ShouldClearContainer (const JsonDeserializerContext &context) const
 
- Protected Member Functions inherited from AZ::BaseJsonSerializer
JsonSerializationResult::ResultCode ContinueLoading (void *object, const Uuid &typeId, const rapidjson::Value &value, JsonDeserializerContext &context, ContinuationFlags flags=ContinuationFlags::None)
 
JsonSerializationResult::ResultCode ContinueStoring (rapidjson::Value &output, const void *object, const void *defaultObject, const Uuid &typeId, JsonSerializerContext &context, ContinuationFlags flags=ContinuationFlags::None)
 
JsonSerializationResult::ResultCode LoadTypeId (Uuid &typeId, const rapidjson::Value &input, JsonDeserializerContext &context, const Uuid *baseTypeId=nullptr, bool *isExplicit=nullptr)
 
JsonSerializationResult::ResultCode StoreTypeId (rapidjson::Value &output, const Uuid &typeId, JsonSerializerContext &context)
 
JsonSerializationResult::ResultCode ContinueLoadingFromJsonObjectField (void *object, const Uuid &typeId, const rapidjson::Value &value, rapidjson::Value::StringRefType memberName, JsonDeserializerContext &context, ContinuationFlags flags=ContinuationFlags::None)
 Helper function similar to ContinueLoading, but loads the data as a member of 'value' rather than 'value' itself, if it exists.
 
JsonSerializationResult::ResultCode ContinueStoringToJsonObjectField (rapidjson::Value &output, rapidjson::Value::StringRefType newMemberName, const void *object, const void *defaultObject, const Uuid &typeId, JsonSerializerContext &context, ContinuationFlags flags=ContinuationFlags::None)
 Helper function similar to ContinueStoring, but stores the data as a member of 'output' rather than overwriting 'output'.
 
bool IsExplicitDefault (const rapidjson::Value &value)
 
rapidjson::Value GetExplicitDefault ()
 

Additional Inherited Members

- Public Types inherited from AZ::BaseJsonSerializer
enum class  ContinuationFlags {
  None = 0 , ResolvePointer = 1 << 0 , ReplaceDefault = 1 << 1 , LoadAsNewInstance = 1 << 2 ,
  IgnoreTypeSerializer = 1 << 3
}
 
enum class  OperationFlags { None = 0 , ManualDefault = 1 << 0 , InitializeNewInstance = 1 << 1 }
 

Member Function Documentation

◆ Load()

JsonSerializationResult::Result AZ::JsonBasicContainerSerializer::Load ( void *  outputValue,
const Uuid &  outputValueTypeId,
const rapidjson::Value &  inputValue,
JsonDeserializerContext &  context 
)
overridevirtual

Transforms the data from the rapidjson Value to outputValue, if the conversion is possible and supported. The serializer is responsible for casting to the proper type and safely writing to the outputValue memory.

Note
The default implementation is to load the object ignoring a custom serializers for the type, which allows for custom serializers to modify the object after all default loading has occurred.

Reimplemented from AZ::BaseJsonSerializer.

◆ ShouldClearContainer()

virtual bool AZ::JsonBasicContainerSerializer::ShouldClearContainer ( const JsonDeserializerContext &  context) const
protectedvirtual

When this function returns true then the container will be cleared before applying the data from the json document. When returns false any elements in the container will be kept and not overwritten.

◆ Store()

JsonSerializationResult::Result AZ::JsonBasicContainerSerializer::Store ( rapidjson::Value &  outputValue,
const void *  inputValue,
const void *  defaultValue,
const Uuid &  valueTypeId,
JsonSerializerContext &  context 
)
overridevirtual

Write the input value to a rapidjson value if the default value is not null and doesn't match the input value, otherwise an error is returned and sets the rapidjson value to a null value.

Note
The default implementation is to store the object ignoring custom serializers.

Reimplemented from AZ::BaseJsonSerializer.

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