PLCnext API Documentation 25.0.2.69
Public Member Functions | List of all members
Arp::System::Commons::Json::JsonSerializationContext Class Reference

Json context used during Json reading and writing to hold the context information More...

#include <JsonSerializationContext.hpp>

Public Member Functions

 JsonSerializationContext (JsonDocument &document)
 Constructs an JsonSerializationContext instance. More...
 
 JsonSerializationContext (const JsonSerializationContext &arg)=delete
 
 JsonSerializationContext (JsonSerializationContext &&arg) noexcept
 Default move constructor.
 
JsonSerializationContextoperator= (const JsonSerializationContext &arg)=delete
 
JsonSerializationContextoperator= (JsonSerializationContext &&arg) noexcept
 Default move-assignment operator.
 
 ~JsonSerializationContext (void)
 Default destructor.
 
const JsonDocument & GetDocument (void)
 
String ResolvePath (const char *documentPath)
 Resolves a relative path into an absolute relative to the document path and replaces all placeholders More...
 
String ResolveRelativePath (const String &documentPath)
 Resolves a relative path into an absolute relative to the document path More...
 
String ResolvePlaceholder (const char *input)
 Resolves a string with a placeholder (Enviroment variables) More...
 
void InvalidJsonObjectOccurs (JsonReader &reader, const char *jsonObjectName)
 this operation should be called while xml serialisation when an unknown xml element is recognized More...
 
Impl & GetImpl (void)
 For internal use only.
 
const Impl & GetImpl (void) const
 

Detailed Description

Json context used during Json reading and writing to hold the context information

Constructor & Destructor Documentation

◆ JsonSerializationContext()

Arp::System::Commons::Json::JsonSerializationContext::JsonSerializationContext ( JsonDocument &  document)
explicit

Constructs an JsonSerializationContext instance.

Parameters
valueSpecifies the initial value of property ...

Member Function Documentation

◆ InvalidJsonObjectOccurs()

void Arp::System::Commons::Json::JsonSerializationContext::InvalidJsonObjectOccurs ( JsonReader reader,
const char *  jsonObjectName 
)

this operation should be called while xml serialisation when an unknown xml element is recognized

Parameters
readerJson reader object
jsonObjectNameJson Reader object name

◆ ResolvePath()

String Arp::System::Commons::Json::JsonSerializationContext::ResolvePath ( const char *  documentPath)

Resolves a relative path into an absolute relative to the document path and replaces all placeholders

Parameters
documentPathDocument path
Returns
Resolved string path

◆ ResolvePlaceholder()

String Arp::System::Commons::Json::JsonSerializationContext::ResolvePlaceholder ( const char *  input)

Resolves a string with a placeholder (Enviroment variables)

Parameters
inputStream with placeholder
Returns
Resolved string

◆ ResolveRelativePath()

String Arp::System::Commons::Json::JsonSerializationContext::ResolveRelativePath ( const String documentPath)

Resolves a relative path into an absolute relative to the document path

Parameters
documentPathDocument path
Returns
Resolved string path

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