gpg::SnapshotMetadata

#include <snapshot_metadata.h>

מבנה נתונים יחיד שמאפשר לגשת לנתונים על הסטטוס של מטא-נתונים ספציפיים בתמונת המצב.

סיכום

בניגוד לסוגים אחרים של ערכים, SnapshotMetadata לא ניתן לשינוי בהחלטה. SnapshotManager ממשקי API יכולים "לסגור" תמונת המצב, ושינוי התוצאה של השיטה IsOpen(); באופן כללי, ממשקי API כאלה דורשים שה-SnapshotMetadata יעבור ב-IsOpen().

בנייה
SnapshotMetadata()
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
יוצרת אובייקט SnapshotMetadata מ-shared_ptr ל-SnapshotMetadataImpl.
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 epoch]).
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

מחזירה את שם הקובץ והמזהה הייחודי של תמונת המצב.

השמות של תמונות המצב חייבים לכלול בין 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 epoch]).

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 וכו') בתמונת המצב.

operator=

SnapshotMetadata & operator=(
  const SnapshotMetadata & copy_from
)

הקצאת אובייקט SnapshotMetadata זה על ידי העתקה מאובייקט אחר.

operator=

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

הקצאת אובייקט SnapshotMetadata זה על ידי העברת אובייקט אחר אליו.

~SnapshotMetadata

 ~SnapshotMetadata()