HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ArFilesystemAsset Class Reference

#include <filesystemAsset_v2.h>

+ Inheritance diagram for ArFilesystemAsset:

Public Member Functions

AR_API ArFilesystemAsset (FILE *file)
 
AR_API ~ArFilesystemAsset ()
 Closes the file owned by this object. More...
 
virtual AR_API size_t GetSize () const override
 Returns the size of the file held by this object. More...
 
virtual AR_API std::shared_ptr
< const char > 
GetBuffer () const override
 
virtual AR_API size_t Read (void *buffer, size_t count, size_t offset) const override
 
virtual AR_API std::pair< FILE
*, size_t > 
GetFileUnsafe () const override
 
- Public Member Functions inherited from ArAsset
virtual AR_API ~ArAsset ()
 
 ArAsset (const ArAsset &)=delete
 
ArAssetoperator= (const ArAsset &)=delete
 

Static Public Member Functions

static AR_API std::shared_ptr
< ArFilesystemAsset
Open (const ArResolvedPath &resolvedPath)
 
static AR_API ArTimestamp GetModificationTimestamp (const ArResolvedPath &resolvedPath)
 

Additional Inherited Members

- Protected Member Functions inherited from ArAsset
AR_API ArAsset ()
 

Detailed Description

ArAsset implementation for asset represented by a file on a filesystem.

Definition at line 48 of file filesystemAsset_v2.h.

Constructor & Destructor Documentation

AR_API ArFilesystemAsset::ArFilesystemAsset ( FILE *  file)
explicit

Constructs an ArFilesystemAsset for the given file. The ArFilesystemAsset object takes ownership of file and will close the file handle on destruction.

AR_API ArFilesystemAsset::~ArFilesystemAsset ( )

Closes the file owned by this object.

Member Function Documentation

virtual AR_API std::shared_ptr<const char> ArFilesystemAsset::GetBuffer ( ) const
overridevirtual

Creates a read-only memory map for the file held by this object and returns a pointer to the start of the mapped contents.

Implements ArAsset.

virtual AR_API std::pair<FILE*, size_t> ArFilesystemAsset::GetFileUnsafe ( ) const
overridevirtual

Returns the FILE* handle this object was created with and an offset of 0, since the asset's contents are located at the beginning of the file.

Implements ArAsset.

static AR_API ArTimestamp ArFilesystemAsset::GetModificationTimestamp ( const ArResolvedPath resolvedPath)
static

Returns an ArTimestamp holding the mtime of the file at resolvedPath. Returns an invalid ArTimestamp if the mtime could not be retrieved.

virtual AR_API size_t ArFilesystemAsset::GetSize ( ) const
overridevirtual

Returns the size of the file held by this object.

Implements ArAsset.

static AR_API std::shared_ptr<ArFilesystemAsset> ArFilesystemAsset::Open ( const ArResolvedPath resolvedPath)
static

Constructs a new ArFilesystemAsset for the file at resolvedPath. Returns a null pointer if the file could not be opened.

Examples:
USD/USD_TmpArResolver.C.
virtual AR_API size_t ArFilesystemAsset::Read ( void buffer,
size_t  count,
size_t  offset 
) const
overridevirtual

Reads count bytes from the file held by this object at the given offset into buffer.

Implements ArAsset.


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