UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter Class Reference
+ Inheritance diagram for UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter:

Public Member Functions

virtual bool PopulateObjectHeader (UObject *Object, FRemoteObjectHeader &OutHeader) const
 
 FArchiveRemoteObjectWriter (UObject *InRootObject, FRemoteObjectData &OutObjectData, const FUObjectMigrationContext *InMigrationContext, const TCHAR *ArchiveName=nullptr, TSet< UObject * > *OutReferencedObjectsSet=nullptr)
 
virtual UObjectGetArchetypeFromLoader (const UObject *Obj) override
 
FNameIndexType AddNameToNameMap (const FName &Name)
 
FNameIndexType AddRemoteIdToIdMap (FRemoteObjectId RemoteId)
 
FNameIndexType AddPathNameToNameMap (UObject *Object)
 
virtual FArchiveoperator<< (UObject *&Obj) override
 
virtual FArchiveoperator<< (FName &Name) override
 
virtual FArchiveoperator<< (FLazyObjectPtr &Value) override
 
virtual FArchiveoperator<< (FObjectPtr &Value) override
 
virtual FArchiveoperator<< (FSoftObjectPtr &Value) override
 
virtual FArchiveoperator<< (FSoftObjectPath &Value) override
 
virtual FArchiveoperator<< (FWeakObjectPtr &Value) override
 
TArray< UObject * > & GetObjectsToSerialize ()
 
FORCENOINLINE void SerializeRemoteObject (UObject *Object, const FRemoteObjectHeader &Header)
 
- Public Member Functions inherited from UE::RemoteObject::Serialization::TArchiveRemoteObjectBase< FMemoryWriter >
 TArchiveRemoteObjectBase (FRemoteObjectData &InObjectData, const FUObjectMigrationContext *InContext, const TCHAR *InArchiveName)
 
virtual ~TArchiveRemoteObjectBase ()
 
virtual FString GetArchiveName () const override
 
virtual const FUObjectMigrationContextGetMigrationContext () const override
 
void SetRootObject (UObject *InRoot)
 
UObjectGetRootObject () const
 
- Public Member Functions inherited from TMemoryWriterBase< ArrayAllocatorType >
 TMemoryWriterBase (TArray< uint8, ArrayAllocatorType > &InBytes, bool bIsPersistent=false, bool bSetOffset=false, const FName InArchiveName=NAME_None)
 
virtual void Serialize (void *Data, int64 Num) override
 
int64 TotalSize () override
 
- Public Member Functions inherited from FMemoryArchive
void Seek (int64 InPos) final
 
int64 Tell () final
 
virtual FArchiveoperator<< (FName &Value)
 
virtual CORE_API FArchiveoperator<< (FText &Value)
 
virtual FArchiveoperator<< (UObject *&Value)
 
virtual FArchiveoperator<< (FField *&Value)
 
template<class T >
FArchiveoperator<< (TCheckedObjPtr< T > &Value)
 
virtual CORE_API FArchiveoperator<< (struct FLazyObjectPtr &Value)
 
virtual CORE_API FArchiveoperator<< (struct FObjectPtr &Value)
 
virtual CORE_API FArchiveoperator<< (struct FSoftObjectPtr &Value)
 
virtual CORE_API FArchiveoperator<< (struct FSoftObjectPath &Value)
 
virtual CORE_API FArchiveoperator<< (struct FWeakObjectPtr &Value)
 
- Public Member Functions inherited from FArchive
 FArchive ()=default
 
 FArchive (const FArchive &)=default
 
FArchiveoperator= (const FArchive &ArchiveToCopy)=default
 
virtual CORE_API ~FArchive ()
 
template<class T >
FArchiveoperator<< (TCheckedObjPtr< T > &Value)
 
virtual void ForceBlueprintFinalization ()
 
virtual void SerializeBits (void *V, int64 LengthBits)
 
virtual void SerializeInt (uint32 &Value, uint32 Max)
 
virtual CORE_API void SerializeIntPacked (uint32 &Value)
 
virtual CORE_API void SerializeIntPacked64 (uint64 &Value)
 
virtual void Preload (UObject *Object)
 
FArchiveStateGetArchiveState ()
 
const FArchiveStateGetArchiveState () const
 
virtual void AttachBulkData (UObject *Owner, FBulkData *BulkData)
 
virtual void AttachBulkData (UE::Serialization::FEditorBulkData *BulkData)
 
virtual void DetachBulkData (FBulkData *BulkData, bool bEnsureBulkDataIsLoaded)
 
virtual void DetachBulkData (UE::Serialization::FEditorBulkData *BulkData, bool bEnsureBulkDataIsLoaded)
 
virtual bool SerializeBulkData (FBulkData &BulkData, const FBulkDataSerializationParams &Params)
 
virtual bool IsProxyOf (FArchive *InOther) const
 
virtual bool Precache (int64 PrecacheOffset, int64 PrecacheSize)
 
virtual void FlushCache ()
 
virtual bool SetCompressionMap (TArray< FCompressedChunk > *CompressedChunks, ECompressionFlags CompressionFlags)
 
virtual void Flush ()
 
virtual bool Close ()
 
CORE_API void SerializeCompressed (void *V, int64 Length, FName CompressionFormatCannotChange, ECompressionFlags Flags=COMPRESS_NoFlags, bool bTreatBufferAsFileReader=false)
 
CORE_API void SerializeCompressedNew (void *V, int64 Length, FName CompressionFormatToEncode, FName CompressionFormatToDecodeOldV1Files, ECompressionFlags Flags=COMPRESS_NoFlags, bool bTreatBufferAsFileReader=false, int64 *OutPartialReadLength=nullptr)
 
CORE_API void SerializeCompressedNew (void *V, int64 Length)
 
CORE_API void ByteSwap (void *V, int32 Length)
 
FArchiveByteOrderSerialize (void *V, int32 Length)
 
void StartSerializingDefaults ()
 
void StopSerializingDefaults ()
 
virtual void MarkScriptSerializationStart (const UObject *Obj)
 
virtual void MarkScriptSerializationEnd (const UObject *Obj)
 
virtual void MarkSearchableName (const TObjectPtr< const UObject > &TypeObject, const FName &ValueName) const
 
template<typename FmtType , typename... Types>
void Logf (const FmtType &Fmt, Types... Args)
 
virtual CORE_API void UsingCustomVersion (const struct FGuid &Guid)
 
virtual FArchiveGetCacheableArchive ()
 
void SetCookData (FArchiveCookData *InCookData)
 
FArchiveCookDataGetCookData ()
 
virtual CORE_API void PushSerializedProperty (class FProperty *InProperty, const bool bIsEditorOnlyProperty)
 
virtual CORE_API void PopSerializedProperty (class FProperty *InProperty, const bool bIsEditorOnlyProperty)
 
virtual bool AttachExternalReadDependency (FExternalReadCallback &ReadCallback)
 
template<SIZE_T Size>
bool FastPathLoad (void *InDest)
 
virtual void PushFileRegionType (EFileRegionType Type)
 
virtual void PopFileRegionType ()
 
CORE_API void SetArchiveState (const FArchiveState &InState)
 
CORE_API void SetError ()
 
CORE_API void ClearError ()
 
CORE_API void SetCriticalError ()
 
virtual FArchiveStateGetInnermostState ()
 
virtual void CountBytes (SIZE_T InNum, SIZE_T InMax)
 
virtual FLinkerGetLinker ()
 
virtual bool AtEnd ()
 
bool IsByteSwapping ()
 
void ThisContainsCode ()
 
void ThisContainsMap ()
 
CORE_API void ThisRequiresLocalizationGather ()
 
UE_FORCEINLINE_HINT FPackageFileVersion UEVer () const
 
UE_FORCEINLINE_HINT int32 LicenseeUEVer () const
 
UE_FORCEINLINE_HINT FEngineVersionBase EngineVer () const
 
virtual CORE_API uint32 EngineNetVer () const
 
virtual CORE_API uint32 GameNetVer () const
 
CORE_API int32 CustomVer (const struct FGuid &Key) const
 
UE_FORCEINLINE_HINT bool IsLoading () const
 
UE_FORCEINLINE_HINT bool IsLoadingFromCookedPackage () const
 
UE_FORCEINLINE_HINT bool IsSaving () const
 
bool IsTransacting () const
 
UE_FORCEINLINE_HINT bool IsTextFormat () const
 
UE_FORCEINLINE_HINT bool WantBinaryPropertySerialization () const
 
UE_FORCEINLINE_HINT bool UseUnversionedPropertySerialization () const
 
UE_FORCEINLINE_HINT bool IsForcingUnicode () const
 
UE_FORCEINLINE_HINT bool IsPersistent () const
 
UE_FORCEINLINE_HINT bool GetError () const
 
UE_FORCEINLINE_HINT bool IsError () const
 
UE_FORCEINLINE_HINT bool IsCriticalError () const
 
UE_FORCEINLINE_HINT bool ContainsCode () const
 
UE_FORCEINLINE_HINT bool ContainsMap () const
 
bool RequiresLocalizationGather () const
 
UE_FORCEINLINE_HINT bool ForceByteSwapping () const
 
UE_FORCEINLINE_HINT bool IsSerializingDefaults () const
 
UE_FORCEINLINE_HINT bool IsIgnoringArchetypeRef () const
 
UE_FORCEINLINE_HINT bool DoDelta () const
 
UE_FORCEINLINE_HINT bool DoIntraPropertyDelta () const
 
UE_FORCEINLINE_HINT bool IsIgnoringOuterRef () const
 
UE_FORCEINLINE_HINT bool IsIgnoringClassGeneratedByRef () const
 
UE_FORCEINLINE_HINT bool IsIgnoringClassRef () const
 
UE_FORCEINLINE_HINT bool IsAllowingLazyLoading () const
 
UE_FORCEINLINE_HINT bool IsObjectReferenceCollector () const
 
UE_FORCEINLINE_HINT bool IsModifyingWeakAndStrongReferences () const
 
UE_FORCEINLINE_HINT bool IsCountingMemory () const
 
UE_FORCEINLINE_HINT uint32 GetPortFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyPortFlags (uint32 Flags) const
 
UE_FORCEINLINE_HINT bool HasAllPortFlags (uint32 Flags) const
 
uint32 GetDebugSerializationFlags () const
 
UE_FORCEINLINE_HINT bool ShouldSkipBulkData () const
 
UE_FORCEINLINE_HINT int64 GetMaxSerializeSize () const
 
virtual CORE_API const FCustomVersionContainerGetCustomVersions () const
 
virtual CORE_API void SetCustomVersions (const FCustomVersionContainer &CustomVersionContainer)
 
virtual CORE_API void ResetCustomVersions ()
 
CORE_API void SetCustomVersion (const struct FGuid &Key, int32 Version, FName FriendlyName)
 
void SetByteSwapping (bool Enabled)
 
void SetPortFlags (uint32 InPortFlags)
 
virtual void SetDebugSerializationFlags (uint32 InCustomFlags)
 
bool IsFilterEditorOnly () const
 
virtual void SetFilterEditorOnly (bool InFilterEditorOnly)
 
bool IsSavingOptionalObject () const
 
virtual void SetSavingOptionalObject (bool InSavingOptionalObject)
 
bool IsSaveGame () const
 
UE_FORCEINLINE_HINT bool IsNetArchive () const
 
UE_FORCEINLINE_HINT bool IsCooking () const
 
UE_FORCEINLINE_HINT const ITargetPlatformCookingTarget () const
 
void SetSavePackageData (FArchiveSavePackageData *InSavePackageData)
 
FArchiveSavePackageDataGetSavePackageData ()
 
UE_FORCEINLINE_HINT FArchiveCookContextGetCookContext ()
 
virtual bool UseToResolveEnumerators () const
 
virtual bool ShouldSkipProperty (const FProperty *InProperty) const
 
virtual void SetSerializedProperty (FProperty *InProperty)
 
UE_FORCEINLINE_HINT class FPropertyGetSerializedProperty () const
 
CORE_API void GetSerializedPropertyChain (TArray< class FProperty * > &OutProperties) const
 
UE_FORCEINLINE_HINT const FArchiveSerializedPropertyChainGetSerializedPropertyChain () const
 
virtual CORE_API void SetSerializedPropertyChain (const FArchiveSerializedPropertyChain *InSerializedPropertyChain, class FProperty *InSerializedPropertyOverride=nullptr)
 
virtual void SetSerializeContext (FUObjectSerializeContext *InLoadContext)
 
virtual CORE_API void Reset ()
 
virtual CORE_API void SetIsLoading (bool bInIsLoading)
 
virtual CORE_API void SetIsLoadingFromCookedPackage (bool bInIsLoadingFromCookedPackage)
 
virtual CORE_API void SetIsSaving (bool bInIsSaving)
 
virtual CORE_API void SetIsTransacting (bool bInIsTransacting)
 
virtual CORE_API void SetIsTextFormat (bool bInIsTextFormat)
 
virtual CORE_API void SetWantBinaryPropertySerialization (bool bInWantBinaryPropertySerialization)
 
virtual CORE_API void SetUseUnversionedPropertySerialization (bool bInUseUnversioned)
 
virtual CORE_API void SetForceUnicode (bool bInForceUnicode)
 
virtual CORE_API void SetIsPersistent (bool bInIsPersistent)
 
virtual CORE_API void SetUEVer (FPackageFileVersion InVer)
 
virtual CORE_API void SetLicenseeUEVer (int32 InVer)
 
virtual CORE_API void SetEngineVer (const FEngineVersionBase &InVer)
 
virtual CORE_API void SetEngineNetVer (const uint32 InEngineNetVer)
 
virtual CORE_API void SetGameNetVer (const uint32 InGameNetVer)
 
UE_FORCEINLINE_HINT bool ShouldSkipCompilingAssets () const
 
CORE_API void SetShouldSkipUpdateCustomVersion (bool bShouldSkip)
 
UE_FORCEINLINE_HINT bool ShouldSkipUpdateCustomVersion () const
 
CORE_API void SetMigratingRemoteObjects (bool bMigrating)
 
UE_FORCEINLINE_HINT constexpr bool IsMigratingRemoteObjects () const
 

Static Public Member Functions

static FRemoteObjectReferenceInfo GetReferenceInfo (const FObjectPtr &ObjPtr, UObject *InRootObject)
 

Protected Member Functions

virtual FRemoteObjectReferenceInfo GetReferenceInfo (const FObjectPtr &ObjPtr) const
 
virtual void WriteObjectReference (const FRemoteObjectReferenceInfo &RefInfo)
 
void WriteObjectPtr (const FObjectPtr &ObjPtr)
 
- Protected Member Functions inherited from FMemoryArchive
 FMemoryArchive ()
 
- Protected Member Functions inherited from FArchive
void SetShouldSkipCompilingAssets (bool Enabled)
 

Protected Attributes

TArray< UObject * > ObjectsToSerialize
 
TSet< UObject * > SerializedObjects
 
TMap< FName, FNameIndexTypeNameMap
 
TMap< UObject *, FNameIndexTypePathNameMap
 
TMap< FRemoteObjectId, FNameIndexTypeRemoteIdMap
 
TSet< UObject * > * ReferencedObjectsSet = nullptr
 
- Protected Attributes inherited from UE::RemoteObject::Serialization::TArchiveRemoteObjectBase< FMemoryWriter >
UObjectRootObject
 
FRemoteObjectDataObjectData
 
const FUObjectMigrationContextMigrationContext
 
TArray< uint8SerializedBytes
 
FString ArchiveName
 
- Protected Attributes inherited from TMemoryWriterBase< ArrayAllocatorType >
TArray< uint8, ArrayAllocatorType > & Bytes
 
const FName ArchiveName
 
- Protected Attributes inherited from FMemoryArchive
int64 Offset
 

Additional Inherited Members

- Public Attributes inherited from FArchive
FFastPathLoadBufferActiveFPLB
 
FFastPathLoadBuffer InlineFPLB
 
uint8 ArContainsCode: 1
 
uint8 ArContainsMap: 1
 
UE_DEPRECATED(5.6, "Public access to ArRequiresLocalizationGather has been deprecated - please use Ar.RequiresLocalizationGather() and Ar.ThisRequiresLocalizationGather() for getting and setting respectively.") uint8 ArRequiresLocalizationGather uint8 ArForceByteSwapping: 1
 
uint8 ArIgnoreArchetypeRef: 1
 
uint8 ArNoDelta: 1
 
uint8 ArNoIntraPropertyDelta: 1
 
uint8 ArIgnoreOuterRef: 1
 
uint8 ArIgnoreClassGeneratedByRef: 1
 
uint8 ArIgnoreClassRef: 1
 
uint8 ArAllowLazyLoading: 1
 
uint8 ArIsObjectReferenceCollector: 1
 
uint8 ArIsModifyingWeakAndStrongReferences: 1
 
uint8 ArIsCountingMemory: 1
 
uint8 ArShouldSkipBulkData: 1
 
uint8 ArIsFilterEditorOnly: 1
 
uint8 ArIsSavingOptionalObject: 1
 
uint8 ArIsSaveGame: 1
 
uint8 ArIsNetArchive: 1
 
uint8 ArUseCustomPropertyList: 1
 
int32 ArSerializingDefaults
 
uint32 ArPortFlags
 
int64 ArMaxSerializeSize
 
uint8 ArMergeOverrides: 1
 
uint8 ArPreserveArrayElements: 1
 
const struct FCustomPropertyListNodeArCustomPropertyList
 
- Static Protected Member Functions inherited from FArchive
static CORE_API void LinkProxy (FArchiveState &Inner, FArchiveState &Proxy)
 
static CORE_API void UnlinkProxy (FArchiveState &Inner, FArchiveState &Proxy)
 

Constructor & Destructor Documentation

◆ FArchiveRemoteObjectWriter()

UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::FArchiveRemoteObjectWriter ( UObject InRootObject,
FRemoteObjectData OutObjectData,
const FUObjectMigrationContext InMigrationContext,
const TCHAR ArchiveName = nullptr,
TSet< UObject * > *  OutReferencedObjectsSet = nullptr 
)
inline

Member Function Documentation

◆ AddNameToNameMap()

FNameIndexType UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::AddNameToNameMap ( const FName Name)
inline

◆ AddPathNameToNameMap()

FNameIndexType UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::AddPathNameToNameMap ( UObject Object)
inline

◆ AddRemoteIdToIdMap()

FNameIndexType UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::AddRemoteIdToIdMap ( FRemoteObjectId  RemoteId)
inline

◆ GetArchetypeFromLoader()

virtual UObject * UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::GetArchetypeFromLoader ( const UObject Obj)
inlineoverridevirtual

Called to retrieve the archetype from the event driven loader. If this returns null, then call GetArchetype yourself.

Reimplemented from FArchive.

Reimplemented in UE::RemoteObject::Serialization::FArchetypeDeltaWriter.

◆ GetObjectsToSerialize()

TArray< UObject * > & UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::GetObjectsToSerialize ( )
inline

◆ GetReferenceInfo() [1/2]

virtual FRemoteObjectReferenceInfo UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::GetReferenceInfo ( const FObjectPtr ObjPtr) const
inlineprotectedvirtual

◆ GetReferenceInfo() [2/2]

static FRemoteObjectReferenceInfo UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::GetReferenceInfo ( const FObjectPtr ObjPtr,
UObject InRootObject 
)
inlinestatic

◆ operator<<() [1/7]

virtual FArchive & UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::operator<< ( FLazyObjectPtr Value)
inlineoverridevirtual

Serializes a lazy object pointer value from or into this archive.

Most of the time, FLazyObjectPtrs are serialized as UObject*, but some archives need to override this.

Parameters
ValueThe value to serialize.
Returns
This instance.

Reimplemented from FArchive.

◆ operator<<() [2/7]

virtual FArchive & UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::operator<< ( FName Value)
inlineoverridevirtual

Serializes an FName value from or into this archive.

This operator can be implemented by sub-classes that wish to serialize FName instances.

Parameters
ValueThe value to serialize.
Returns
This instance.

Reimplemented from FMemoryArchive.

◆ operator<<() [3/7]

virtual FArchive & UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::operator<< ( FObjectPtr Value)
inlineoverridevirtual

Serializes a wrapped object pointer value from or into this archive.

Most of the time, FObjectPtrs are serialized as UObject*, but some archives need to override this.

Parameters
ValueThe value to serialize.
Returns
This instance.

Reimplemented from FArchive.

◆ operator<<() [4/7]

virtual FArchive & UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::operator<< ( FSoftObjectPath Value)
inlineoverridevirtual

Serializes soft object paths from or into this archive.

Parameters
ValueSoft object path to serialize.
Returns
This instance.

Reimplemented from FArchive.

◆ operator<<() [5/7]

virtual FArchive & UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::operator<< ( FSoftObjectPtr Value)
inlineoverridevirtual

Serializes asset pointer from or into this archive.

Most of the time, FSoftObjectPtr are serialized as UObject *, but some archives need to override this.

Parameters
ValueThe asset pointer to serialize.
Returns
This instance.

Reimplemented from FArchive.

◆ operator<<() [6/7]

virtual FArchive & UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::operator<< ( FWeakObjectPtr Value)
inlineoverridevirtual

Serializes FWeakObjectPtr value from or into this archive.

This operator can be implemented by sub-classes that wish to serialize FWeakObjectPtr instances.

Parameters
ValueThe value to serialize.
Returns
This instance.

bEvenIfGarbage

Reimplemented from FArchive.

◆ operator<<() [7/7]

virtual FArchive & UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::operator<< ( UObject *&  Value)
inlineoverridevirtual

Serializes an UObject value from or into this archive.

This operator can be implemented by sub-classes that wish to serialize UObject instances.

Parameters
ValueThe value to serialize.
Returns
This instance.

Reimplemented from FMemoryArchive.

◆ PopulateObjectHeader()

virtual bool UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::PopulateObjectHeader ( UObject Object,
FRemoteObjectHeader OutHeader 
) const
inlinevirtual

◆ SerializeRemoteObject()

FORCENOINLINE void UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::SerializeRemoteObject ( UObject Object,
const FRemoteObjectHeader Header 
)
inline

◆ WriteObjectPtr()

void UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::WriteObjectPtr ( const FObjectPtr ObjPtr)
inlineprotected

◆ WriteObjectReference()

virtual void UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::WriteObjectReference ( const FRemoteObjectReferenceInfo RefInfo)
inlineprotectedvirtual

Member Data Documentation

◆ NameMap

TMap<FName, FNameIndexType> UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::NameMap
protected

◆ ObjectsToSerialize

TArray<UObject*> UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::ObjectsToSerialize
protected

◆ PathNameMap

TMap<UObject*, FNameIndexType> UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::PathNameMap
protected

◆ ReferencedObjectsSet

TSet<UObject*>* UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::ReferencedObjectsSet = nullptr
protected

◆ RemoteIdMap

TMap<FRemoteObjectId, FNameIndexType> UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::RemoteIdMap
protected

◆ SerializedObjects

TSet<UObject*> UE::RemoteObject::Serialization::FArchiveRemoteObjectWriter::SerializedObjects
protected

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