1. Epic GamesDeveloper
  3. UWebAPICodeGeneratorBase

UWebAPICodeGeneratorBase

WebAPICodeGenerator base implementation.

API > API/Plugins > API/Plugins/WebAPIEditor

WebAPICodeGenerator base implementation. Converts WebAPI schema to code gen primitives. Use of this baseclass is optional.

   
Name UWebAPICodeGeneratorBase
Type class
Header File /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/CodeGen/WebAPICodeGenerator.h
Include Path #include "CodeGen/WebAPICodeGenerator.h"

Syntax

UCLASS (Abstract)  
class UWebAPICodeGeneratorBase :  
    public UObject ,  
    public IWebAPICodeGeneratorInterface

Inheritance Hierarchy

Implements Interfaces

Constants

Name Type Remarks Include Path
LogName const TCHAR *   CodeGen/WebAPICodeGenerator.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual TFuture< EWebAPIGenerationResult > GenerateEnum ( const TWeakObjectPtr< UWebAPIDefinition >& InDefinition,
const TSharedPtr< FWebAPICodeGenEnum >& InEnum
)

 Converts the given Enum to a CodeGen Enum object. CodeGen/WebAPICodeGenerator.h  

virtual TFuture< EWebAPIGenerationResult > GenerateFile ( const TWeakObjectPtr< UWebAPIDefinition >& InDefinition,
const TSharedPtr< FWebAPICodeGenFile >& InFile
)

 Converts the given Definition to a CodeGen File object. CodeGen/WebAPICodeGenerator.h  

virtual TFuture< EWebAPIGenerationResult > GenerateModel ( const TWeakObjectPtr< UWebAPIDefinition >& InDefinition,
const TSharedPtr< FWebAPICodeGenStruct >& InStruct
)

 Converts the given Model to a CodeGen Struct object. CodeGen/WebAPICodeGenerator.h  

virtual TFuture< EWebAPIGenerationResult > GenerateServiceOperations ( const TWeakObjectPtr< UWebAPIDefinition >& InDefinition,
const FString& InServiceName,
const TArray< TSharedPtr< FWebAPICodeGenOperation > >& InOperations
)

 Converts the given Service to a CodeGen Operation array. CodeGen/WebAPICodeGenerator.h  

virtual TFuture< EWebAPIGenerationResult > GenerateSettings ( const TWeakObjectPtr< UWebAPIDefinition >& InDefinition,
const TSharedPtr< FWebAPICodeGenClass >& InSettingsClass
)

 Converts the given Definition to a CodeGen Settings object. CodeGen/WebAPICodeGenerator.h  

Overridden from IWebAPICodeGeneratorInterface

Name Remarks Include Path Unreal Specifiers

virtual TFuture< EWebAPIGenerationResult > Generate ( const TWeakObjectPtr< UWebAPIDefinition >& InDefinition
)

 Generate code for the given WebAPI Definition. CodeGen/WebAPICodeGenerator.h  

virtual TFuture< bool > IsAvailable()

 Check to see if this generator is available for use. CodeGen/WebAPICodeGenerator.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool CheckNameConflicts ( const TWeakObjectPtr< UWebAPIDefinition >& InDefinition,
const TArray< TSharedPtr< CodeGenType > >& InItems
) const

   CodeGen/WebAPICodeGenerator.h  

bool CheckNameConflicts ( const TWeakObjectPtr< UWebAPIDefinition >& InDefinition,
const TArray< TSharedPtr< FWebAPICodeGenFile > >& InItems
) const

   CodeGen/WebAPICodeGenerator.h  

bool CheckNameConflicts ( const TWeakObjectPtr< UWebAPIDefinition >& InDefinition,
const TArray< TSharedPtr< FWebAPICodeGenFile > >& InItems
) const

      

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page