gpg:: SnapshotMetadata
#include <snapshot_metadata.h>
Pojedyncza struktura danych, która umożliwia dostęp do informacji o stanie określonych metadanych zrzutu.
Podsumowanie
W przeciwieństwie do innych typów wartości pole SnapshotMetadata
nie jest ściśle stałe. SnapshotManager
interfejs API może zostać „zamknięty” zrzut i zmianę wyniku metody IsOpen(); takie interfejsy API uniwersalnie wymagają, aby SnapshotMetadata
przekazano w funkcji IsOpen().
Konstruktory i niszczyciele |
|
---|---|
SnapshotMetadata()
|
|
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
|
|
SnapshotMetadata(const SnapshotMetadata & copy_from)
Tworzy kopię istniejącego obiektu
SnapshotMetadata . |
|
SnapshotMetadata(SnapshotMetadata && move_from)
Przenosi istniejący obiekt
SnapshotMetadata . |
|
~SnapshotMetadata()
|
Funkcje publiczne |
|
---|---|
CoverImageURL() const
|
const std::string &
Zwraca adres URL zdjęcia okładki.
|
Description() const
|
const std::string &
Zwraca zwięzły opis metadanych zrzutu.
|
FileName() const
|
const std::string &
Zwraca nazwę pliku i unikalny identyfikator zrzutu.
|
IsOpen() const
|
bool
Zwraca wartość „prawda”, gdy metadane zwróconego zrzutu zostały wczytane z pasującymi danymi pliku.
|
LastModifiedTime() const
|
Zwraca czas ostatniej modyfikacji wpisu (wyrażony w milisekundach od początku epoki uniksowej).
|
PlayedTime() const
|
Zwraca czas odtwarzania powiązany z metadanymi tego zrzutu.
|
ProgressValue() const
|
int64_t
Zwraca ustawioną wartość postępu powiązaną z metadanymi tego zrzutu.
|
Valid() const
|
bool
Zwraca wartość prawda, gdy zwrócone metadane zrzutu są wypełnione danymi i towarzyszy im stan odpowiedzi. wartość „false” dla niewypełnianego zrzutu utworzonego przez użytkownika lub wypełnionego, któremu towarzyszy stan odpowiedzi „Niepowodzenie”.
|
operator=(const SnapshotMetadata & copy_from)
|
Przypisuje ten obiekt
SnapshotMetadata , kopiując go z innego. |
operator=(SnapshotMetadata && move_from)
|
Przypisuje ten obiekt
SnapshotMetadata , przenosząc do niego inny obiekt. |
Funkcje publiczne
CoverImageURL
const std::string & CoverImageURL() const
Zwraca adres URL zdjęcia okładki.
Opis
const std::string & Description() const
Zwraca zwięzły opis metadanych zrzutu.
Aby można było używać tej funkcji, SnapshotMetadata::Valid()
musi zwrócić wartość „true” (prawda).
Nazwa pliku
const std::string & FileName() const
Zwraca nazwę pliku i unikalny identyfikator zrzutu.
Nazwy zrzutów muszą mieć od 1 do 100 znaków niezarezerwowanych w adresie URL (a–z, A–Z, 0–9 lub symbole „-”, „.”, „_” lub „~”).
IsOpen
bool IsOpen() const
Zwraca wartość „prawda”, gdy metadane zwróconego zrzutu zostały wczytane z pasującymi danymi pliku.
Operacje związane z danymi, takie jak Read
, Commit
i Resolve
, działają tylko wtedy, gdy obiekt zawiera dane w pliku. Pomimo tego, że wartość ta jest spójna, zmienia się zgodnie z danymi bazowymi metadanych zrzutu. Na przykład wywołanie metody Commit
w tej operacji spowoduje, że funkcja IsOpen() zwróci wartość false (fałsz).
LastModifiedTime
Timestamp LastModifiedTime() const
Zwraca czas ostatniej modyfikacji wpisu (wyrażony w milisekundach od początku epoki uniksowej).
PlayedTime
gpg::Duration PlayedTime() const
Zwraca czas odtwarzania powiązany z metadanymi tego zrzutu.
ProgressValue
int64_t ProgressValue() const
Zwraca ustawioną wartość postępu powiązaną z metadanymi tego zrzutu.
Wartość postępu jest używana w automatycznym rozwiązywaniu konfliktów.
SnapshotMetadata
SnapshotMetadata()
SnapshotMetadata
SnapshotMetadata( std::shared_ptr< SnapshotMetadataImpl > impl )
Konstruuje obiekt SnapshotMetadata
z shared_ptr
do SnapshotMetadataImpl
.
Przeznaczony do użytku wewnętrznego w interfejsie API.
SnapshotMetadata
SnapshotMetadata( const SnapshotMetadata & copy_from )
Tworzy kopię istniejącego obiektu SnapshotMetadata
.
SnapshotMetadata
SnapshotMetadata( SnapshotMetadata && move_from )
Przenosi istniejący obiekt SnapshotMetadata
.
Prawidłowe
bool Valid() const
Zwraca wartość prawda, gdy zwrócone metadane zrzutu są wypełnione danymi i towarzyszy im stan odpowiedzi. wartość „false” dla niewypełnianego zrzutu utworzonego przez użytkownika lub wypełnionego, któremu towarzyszy stan odpowiedzi „Niepowodzenie”.
Aby można było używać tej funkcji, musi ona zwracać wartość „true” (prawda) w przypadku tego zrzutu (id
, Name
, Description
itp.).
operator=
SnapshotMetadata & operator=( const SnapshotMetadata & copy_from )
Przypisuje ten obiekt SnapshotMetadata
, kopiując go z innego.
operator=
SnapshotMetadata & operator=( SnapshotMetadata && move_from )
Przypisuje ten obiekt SnapshotMetadata
, przenosząc do niego inny obiekt.
~SnapshotMetadata
~SnapshotMetadata()