RHAPI_TimeFrame
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_TimeFrame | Time Frames are used to calculate the expiration of Inventory. |
struct FRHAPI_TimeFrame
struct FRHAPI_TimeFrame
: public FRHAPI_ModelTime Frames are used to calculate the expiration of Inventory.
Summary
| Members | Descriptions |
|---|---|
public FString Name_Optional | The name of the Time Frame. |
public bool Name_IsSet | true if Name_Optional has been set to a value |
public bool Active_Optional | Whether or not the Time Frame is active. |
public bool Active_IsSet | true if Active_Optional has been set to a value |
public int32 Episode_Optional | |
public bool Episode_IsSet | true if Episode_Optional has been set to a value |
public int32 EpisodeType_Optional | |
public bool EpisodeType_IsSet | true if EpisodeType_Optional has been set to a value |
public int32 HourInterval_Optional | Number of hours that this time frame lasts until restarting.0 interval means no repeating. |
public bool HourInterval_IsSet | true if HourInterval_Optional has been set to a value |
public FDateTime Start | Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone. |
public FDateTime End | Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone. |
public FRHAPI_CacheInfo CacheInfo_Optional | |
public bool CacheInfo_IsSet | true if CacheInfo_Optional has been set to a value |
public virtual bool FromJson(const TSharedPtr< FJsonValue > & JsonValue) | Fills this object with data from the passed in JSON. |
public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) const | Writes the data from this object into the specified JSON Writer stream. |
public inline FString & GetName() | Gets the value of Name_Optional, regardless of it having been set. |
public inline const FString & GetName() const | Gets the value of Name_Optional, regardless of it having been set. |
public inline const FString & GetName(const FString & DefaultValue) const | Gets the value of Name_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetName(FString & OutValue) const | Fills OutValue with the value of Name_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetNameOrNull() | Returns a pointer to Name_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetNameOrNull() const | Returns a pointer to Name_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetName(FString NewValue) | Sets the value of Name_Optional and also sets Name_IsSet to true. |
public inline void ClearName() | Clears the value of Name_Optional and sets Name_IsSet to false. |
public inline bool & GetActive() | Gets the value of Active_Optional, regardless of it having been set. |
public inline const bool & GetActive() const | Gets the value of Active_Optional, regardless of it having been set. |
public inline const bool & GetActive(const bool & DefaultValue) const | Gets the value of Active_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetActive(bool & OutValue) const | Fills OutValue with the value of Active_Optional and returns true if it has been set, otherwise returns false. |
public inline bool * GetActiveOrNull() | Returns a pointer to Active_Optional, if it has been set, otherwise returns nullptr. |
public inline const bool * GetActiveOrNull() const | Returns a pointer to Active_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetActive(bool NewValue) | Sets the value of Active_Optional and also sets Active_IsSet to true. |
public inline void ClearActive() | Clears the value of Active_Optional and sets Active_IsSet to false. |
public inline bool IsActiveDefaultValue() const | Returns true if Active_Optional is set and matches the default value. |
public inline void SetActiveToDefault() | Sets the value of Active_Optional to its default and also sets Active_IsSet to true. |
public inline int32 & GetEpisode() | Gets the value of Episode_Optional, regardless of it having been set. |
public inline const int32 & GetEpisode() const | Gets the value of Episode_Optional, regardless of it having been set. |
public inline const int32 & GetEpisode(const int32 & DefaultValue) const | Gets the value of Episode_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetEpisode(int32 & OutValue) const | Fills OutValue with the value of Episode_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetEpisodeOrNull() | Returns a pointer to Episode_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetEpisodeOrNull() const | Returns a pointer to Episode_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetEpisode(int32 NewValue) | Sets the value of Episode_Optional and also sets Episode_IsSet to true. |
public inline void ClearEpisode() | Clears the value of Episode_Optional and sets Episode_IsSet to false. |
public inline bool IsEpisodeDefaultValue() const | Returns true if Episode_Optional is set and matches the default value. |
public inline void SetEpisodeToDefault() | Sets the value of Episode_Optional to its default and also sets Episode_IsSet to true. |
public inline int32 & GetEpisodeType() | Gets the value of EpisodeType_Optional, regardless of it having been set. |
public inline const int32 & GetEpisodeType() const | Gets the value of EpisodeType_Optional, regardless of it having been set. |
public inline const int32 & GetEpisodeType(const int32 & DefaultValue) const | Gets the value of EpisodeType_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetEpisodeType(int32 & OutValue) const | Fills OutValue with the value of EpisodeType_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetEpisodeTypeOrNull() | Returns a pointer to EpisodeType_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetEpisodeTypeOrNull() const | Returns a pointer to EpisodeType_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetEpisodeType(int32 NewValue) | Sets the value of EpisodeType_Optional and also sets EpisodeType_IsSet to true. |
public inline void ClearEpisodeType() | Clears the value of EpisodeType_Optional and sets EpisodeType_IsSet to false. |
public inline bool IsEpisodeTypeDefaultValue() const | Returns true if EpisodeType_Optional is set and matches the default value. |
public inline void SetEpisodeTypeToDefault() | Sets the value of EpisodeType_Optional to its default and also sets EpisodeType_IsSet to true. |
public inline int32 & GetHourInterval() | Gets the value of HourInterval_Optional, regardless of it having been set. |
public inline const int32 & GetHourInterval() const | Gets the value of HourInterval_Optional, regardless of it having been set. |
public inline const int32 & GetHourInterval(const int32 & DefaultValue) const | Gets the value of HourInterval_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetHourInterval(int32 & OutValue) const | Fills OutValue with the value of HourInterval_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetHourIntervalOrNull() | Returns a pointer to HourInterval_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetHourIntervalOrNull() const | Returns a pointer to HourInterval_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetHourInterval(int32 NewValue) | Sets the value of HourInterval_Optional and also sets HourInterval_IsSet to true. |
public inline void ClearHourInterval() | Clears the value of HourInterval_Optional and sets HourInterval_IsSet to false. |
public inline bool IsHourIntervalDefaultValue() const | Returns true if HourInterval_Optional is set and matches the default value. |
public inline void SetHourIntervalToDefault() | Sets the value of HourInterval_Optional to its default and also sets HourInterval_IsSet to true. |
public inline FDateTime & GetStart() | Gets the value of Start. |
public inline const FDateTime & GetStart() const | Gets the value of Start. |
public inline void SetStart(FDateTime NewValue) | Sets the value of Start. |
public inline FDateTime & GetEnd() | Gets the value of End. |
public inline const FDateTime & GetEnd() const | Gets the value of End. |
public inline void SetEnd(FDateTime NewValue) | Sets the value of End. |
public inline FRHAPI_CacheInfo&GetCacheInfo() | Gets the value of CacheInfo_Optional, regardless of it having been set. |
public inline const FRHAPI_CacheInfo&GetCacheInfo() const | Gets the value of CacheInfo_Optional, regardless of it having been set. |
public inline const FRHAPI_CacheInfo&GetCacheInfo(const FRHAPI_CacheInfo & DefaultValue) const | Gets the value of CacheInfo_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetCacheInfo(FRHAPI_CacheInfo & OutValue) const | Fills OutValue with the value of CacheInfo_Optional and returns true if it has been set, otherwise returns false. |
public inline FRHAPI_CacheInfo*GetCacheInfoOrNull() | Returns a pointer to CacheInfo_Optional, if it has been set, otherwise returns nullptr. |
public inline const FRHAPI_CacheInfo*GetCacheInfoOrNull() const | Returns a pointer to CacheInfo_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetCacheInfo(FRHAPI_CacheInfo NewValue) | Sets the value of CacheInfo_Optional and also sets CacheInfo_IsSet to true. |
public inline void ClearCacheInfo() | Clears the value of CacheInfo_Optional and sets CacheInfo_IsSet to false. |
Members
public FString Name_Optional
The name of the Time Frame.
public bool Name_IsSet
true if Name_Optional has been set to a value
public bool Active_Optional
Whether or not the Time Frame is active.
public bool Active_IsSet
true if Active_Optional has been set to a value
public int32 Episode_Optional
public bool Episode_IsSet
true if Episode_Optional has been set to a value
public int32 EpisodeType_Optional
public bool EpisodeType_IsSet
true if EpisodeType_Optional has been set to a value
public int32 HourInterval_Optional
Number of hours that this time frame lasts until restarting.0 interval means no repeating.
public bool HourInterval_IsSet
true if HourInterval_Optional has been set to a value
public FDateTime Start
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public FDateTime End
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public FRHAPI_CacheInfo CacheInfo_Optional
public bool CacheInfo_IsSet
true if CacheInfo_Optional has been set to a value
public virtual bool FromJson(const TSharedPtr< FJsonValue > & JsonValue)
Fills this object with data from the passed in JSON.
Parameters
JsonValueData from the API call.
Returns
true if parsing of the JSON data was successful.
public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) const
Writes the data from this object into the specified JSON Writer stream.
Parameters
WriterJSON Writer stream to push .
public inline FString & GetName()
Gets the value of Name_Optional, regardless of it having been set.
public inline const FString & GetName() const
Gets the value of Name_Optional, regardless of it having been set.
public inline const FString & GetName(const FString & DefaultValue) const
Gets the value of Name_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetName(FString & OutValue) const
Fills OutValue with the value of Name_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetNameOrNull()
Returns a pointer to Name_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetNameOrNull() const
Returns a pointer to Name_Optional, if it has been set, otherwise returns nullptr.
public inline void SetName(FString NewValue)
Sets the value of Name_Optional and also sets Name_IsSet to true.
public inline void ClearName()
Clears the value of Name_Optional and sets Name_IsSet to false.
public inline bool & GetActive()
Gets the value of Active_Optional, regardless of it having been set.
public inline const bool & GetActive() const
Gets the value of Active_Optional, regardless of it having been set.
public inline const bool & GetActive(const bool & DefaultValue) const
Gets the value of Active_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetActive(bool & OutValue) const
Fills OutValue with the value of Active_Optional and returns true if it has been set, otherwise returns false.
public inline bool * GetActiveOrNull()
Returns a pointer to Active_Optional, if it has been set, otherwise returns nullptr.
public inline const bool * GetActiveOrNull() const
Returns a pointer to Active_Optional, if it has been set, otherwise returns nullptr.
public inline void SetActive(bool NewValue)
Sets the value of Active_Optional and also sets Active_IsSet to true.
public inline void ClearActive()
Clears the value of Active_Optional and sets Active_IsSet to false.
public inline bool IsActiveDefaultValue() const
Returns true if Active_Optional is set and matches the default value.
public inline void SetActiveToDefault()
Sets the value of Active_Optional to its default and also sets Active_IsSet to true.
public inline int32 & GetEpisode()
Gets the value of Episode_Optional, regardless of it having been set.
public inline const int32 & GetEpisode() const
Gets the value of Episode_Optional, regardless of it having been set.
public inline const int32 & GetEpisode(const int32 & DefaultValue) const
Gets the value of Episode_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetEpisode(int32 & OutValue) const
Fills OutValue with the value of Episode_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetEpisodeOrNull()
Returns a pointer to Episode_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetEpisodeOrNull() const
Returns a pointer to Episode_Optional, if it has been set, otherwise returns nullptr.
public inline void SetEpisode(int32 NewValue)
Sets the value of Episode_Optional and also sets Episode_IsSet to true.
public inline void ClearEpisode()
Clears the value of Episode_Optional and sets Episode_IsSet to false.
public inline bool IsEpisodeDefaultValue() const
Returns true if Episode_Optional is set and matches the default value.
public inline void SetEpisodeToDefault()
Sets the value of Episode_Optional to its default and also sets Episode_IsSet to true.
public inline int32 & GetEpisodeType()
Gets the value of EpisodeType_Optional, regardless of it having been set.
public inline const int32 & GetEpisodeType() const
Gets the value of EpisodeType_Optional, regardless of it having been set.
public inline const int32 & GetEpisodeType(const int32 & DefaultValue) const
Gets the value of EpisodeType_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetEpisodeType(int32 & OutValue) const
Fills OutValue with the value of EpisodeType_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetEpisodeTypeOrNull()
Returns a pointer to EpisodeType_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetEpisodeTypeOrNull() const
Returns a pointer to EpisodeType_Optional, if it has been set, otherwise returns nullptr.
public inline void SetEpisodeType(int32 NewValue)
Sets the value of EpisodeType_Optional and also sets EpisodeType_IsSet to true.
public inline void ClearEpisodeType()
Clears the value of EpisodeType_Optional and sets EpisodeType_IsSet to false.
public inline bool IsEpisodeTypeDefaultValue() const
Returns true if EpisodeType_Optional is set and matches the default value.
public inline void SetEpisodeTypeToDefault()
Sets the value of EpisodeType_Optional to its default and also sets EpisodeType_IsSet to true.
public inline int32 & GetHourInterval()
Gets the value of HourInterval_Optional, regardless of it having been set.
public inline const int32 & GetHourInterval() const
Gets the value of HourInterval_Optional, regardless of it having been set.
public inline const int32 & GetHourInterval(const int32 & DefaultValue) const
Gets the value of HourInterval_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetHourInterval(int32 & OutValue) const
Fills OutValue with the value of HourInterval_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetHourIntervalOrNull()
Returns a pointer to HourInterval_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetHourIntervalOrNull() const
Returns a pointer to HourInterval_Optional, if it has been set, otherwise returns nullptr.
public inline void SetHourInterval(int32 NewValue)
Sets the value of HourInterval_Optional and also sets HourInterval_IsSet to true.
public inline void ClearHourInterval()
Clears the value of HourInterval_Optional and sets HourInterval_IsSet to false.
public inline bool IsHourIntervalDefaultValue() const
Returns true if HourInterval_Optional is set and matches the default value.
public inline void SetHourIntervalToDefault()
Sets the value of HourInterval_Optional to its default and also sets HourInterval_IsSet to true.
public inline FDateTime & GetStart()
Gets the value of Start.
public inline const FDateTime & GetStart() const
Gets the value of Start.
public inline void SetStart(FDateTime NewValue)
Sets the value of Start.
public inline FDateTime & GetEnd()
Gets the value of End.
public inline const FDateTime & GetEnd() const
Gets the value of End.
public inline void SetEnd(FDateTime NewValue)
Sets the value of End.
public inline FRHAPI_CacheInfo&GetCacheInfo()
Gets the value of CacheInfo_Optional, regardless of it having been set.
public inline const FRHAPI_CacheInfo&GetCacheInfo() const
Gets the value of CacheInfo_Optional, regardless of it having been set.
public inline const FRHAPI_CacheInfo&GetCacheInfo(const FRHAPI_CacheInfo & DefaultValue) const
Gets the value of CacheInfo_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCacheInfo(FRHAPI_CacheInfo & OutValue) const
Fills OutValue with the value of CacheInfo_Optional and returns true if it has been set, otherwise returns false.
public inline FRHAPI_CacheInfo*GetCacheInfoOrNull()
Returns a pointer to CacheInfo_Optional, if it has been set, otherwise returns nullptr.
public inline const FRHAPI_CacheInfo*GetCacheInfoOrNull() const
Returns a pointer to CacheInfo_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCacheInfo(FRHAPI_CacheInfo NewValue)
Sets the value of CacheInfo_Optional and also sets CacheInfo_IsSet to true.
public inline void ClearCacheInfo()
Clears the value of CacheInfo_Optional and sets CacheInfo_IsSet to false.