gpg:: SnapshotMetadata
#include <snapshot_metadata.h>
מבנה נתונים יחיד שמאפשר לכם לגשת לנתונים לגבי הסטטוס של מטא-נתונים של תמונת מצב ספציפית.
סיכום
בניגוד לסוגים אחרים של ערכים, SnapshotMetadata
לא קבוע בהכרח. ממשקי API של SnapshotManager
יכולים "לסגור" את תמונת המצב ולשנות את התוצאה של השיטה IsOpen(); ממשקי API כאלה דורשים באופן אוניברסלי ש-SnapshotMetadata
יעביר ב-IsOpen().
בונים והורסים |
|
---|---|
SnapshotMetadata()
|
|
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
|
|
SnapshotMetadata(const SnapshotMetadata & copy_from)
יוצר עותק של אובייקט
SnapshotMetadata קיים. |
|
SnapshotMetadata(SnapshotMetadata && move_from)
העברת אובייקט
SnapshotMetadata קיים. |
|
~SnapshotMetadata()
|
תפקידים ציבוריים |
|
---|---|
CoverImageURL() const
|
const std::string &
מחזירה את כתובת ה-URL של תמונת השער.
|
Description() const
|
const std::string &
הפונקציה מחזירה תיאור תמציתי של המטא-נתונים של תמונת המצב.
|
FileName() const
|
const std::string &
מחזירה את שם הקובץ ואת המזהה הייחודי של תמונת המצב.
|
IsOpen() const
|
bool
הפונקציה מחזירה את הערך True כשהמטא-נתונים שהוחזרו של תמונת המצב נטענים עם נתוני קובץ תואמים.
|
LastModifiedTime() const
|
מחזירה את השעה שבה הרשומה שונתה לאחרונה (מבוטאת כאלפיות שנייה מאז תחילת מערכת Unix).
|
PlayedTime() const
|
מחזירה את משך ההפעלה המשויך למטא נתונים של תמונת המצב הזו.
|
ProgressValue() const
|
int64_t
מחזירה את ערך ההתקדמות שהוגדר המשויך למטא נתונים של תמונת המצב הזו.
|
Valid() const
|
bool
הפונקציה מחזירה את הערך True כאשר המטא-נתונים של תמונת המצב שהוחזרו מאוכלסים בנתונים ולצידם סטטוס תגובה לא מוצלח. הערך FALSE לגבי תמונת מצב שלא אוכלסה על ידי המשתמש או לגבי תמונה מאוכלסת שמלוּוה בסטטוס תגובה לא מוצלח.
|
operator=(const SnapshotMetadata & copy_from)
|
הפונקציה מקצה את האובייקט
SnapshotMetadata הזה על ידי העתקה מאובייקט אחר. |
operator=(SnapshotMetadata && move_from)
|
הפונקציה הזאת מקצה את האובייקט
SnapshotMetadata על ידי העברה של אובייקט אחר אליו. |
תפקידים ציבוריים
CoverImageURL
const std::string & CoverImageURL() const
מחזירה את כתובת ה-URL של תמונת השער.
התיאור
const std::string & Description() const
הפונקציה מחזירה תיאור תמציתי של המטא-נתונים של תמונת המצב.
כדי שאפשר יהיה להשתמש בפונקציה הזו, הפונקציה SnapshotMetadata::Valid()
חייבת להחזיר true.
FileName
const std::string & FileName() const
מחזירה את שם הקובץ ואת המזהה הייחודי של תמונת המצב.
השמות של קובצי ה-snapshot חייבים לכלול בין 1 ל-100 תווים שלא שמורים בכתובות URL (a-z, A-Z, 0-9 או הסמלים '-', '.', '_' או '~').
IsOpen
bool IsOpen() const
הפונקציה מחזירה את הערך True כשהמטא-נתונים שהוחזרו של תמונת המצב נטענים עם נתוני קובץ תואמים.
פעולות שקשורות לנתונים כמו Read
, Commit
ו-Resolve
יפעלו רק אם לאובייקט יש נתונים בקובץ. למרות שאין יציבות, הערך הזה משתנה כדי לשקף את הנתונים הבסיסיים של המטא-נתונים של תמונת המצב. לדוגמה, קריאה ל-Commit
על הפעולה תוביל לכך ש-IsOpen() יחזיר false;
LastModifiedTime
Timestamp LastModifiedTime() const
מחזירה את השעה שבה הרשומה שונתה לאחרונה (מבוטאת כאלפיות שנייה מאז תחילת מערכת Unix).
PlayedTime
gpg::Duration PlayedTime() const
מחזירה את משך ההפעלה המשויך למטא נתונים של תמונת המצב הזו.
ProgressValue
int64_t ProgressValue() const
מחזירה את ערך ההתקדמות שהוגדר המשויך למטא נתונים של תמונת המצב הזו.
ערך ההתקדמות משמש לפתרון אוטומטי של התנגשויות.
SnapshotMetadata
SnapshotMetadata()
SnapshotMetadata
SnapshotMetadata( std::shared_ptr< SnapshotMetadataImpl > impl )
בונה אובייקט SnapshotMetadata
מ-shared_ptr
ל-SnapshotMetadataImpl
.
מיועד לשימוש פנימי על ידי ה-API.
SnapshotMetadata
SnapshotMetadata( const SnapshotMetadata & copy_from )
יוצר עותק של אובייקט SnapshotMetadata
קיים.
SnapshotMetadata
SnapshotMetadata( SnapshotMetadata && move_from )
העברת אובייקט SnapshotMetadata
קיים.
נתונים תקפים
bool Valid() const
הפונקציה מחזירה את הערך True כאשר המטא-נתונים של תמונת המצב שהוחזרו מאוכלסים בנתונים ולצידם סטטוס תגובה לא מוצלח. הערך FALSE לגבי תמונת מצב שלא אוכלסה על ידי המשתמש או לגבי תמונה מאוכלסת שמלוּוה בסטטוס תגובה לא מוצלח.
הפונקציה הזו חייבת להחזיר true עבור פונקציות getter (id
, Name
, Description
וכו') בתמונת המצב הזו כדי שניתן יהיה להשתמש בהן.
אופרטור=
SnapshotMetadata & operator=( const SnapshotMetadata & copy_from )
הפונקציה מקצה את האובייקט SnapshotMetadata
הזה על ידי העתקה מאובייקט אחר.
אופרטור=
SnapshotMetadata & operator=( SnapshotMetadata && move_from )
הפונקציה הזאת מקצה את האובייקט SnapshotMetadata
על ידי העברה של אובייקט אחר אליו.
~SnapshotMetadata
~SnapshotMetadata()