TagDto Class Reference

The TagDto class It contains all fields of the TagDto class from the CREST API. More...

#include <CrestModel.h>

Collaboration diagram for TagDto:

Public Member Functions
	TagDto (std::string _name, std::string _timeType, std::string _description)
	TagDto ()
json	to_json () const

Static Public Member Functions
static TagDto	from_json (const json &j)

Public Attributes
std::string	name
std::string	timeType
std::string	objectType
std::string	synchronization
std::string	description
uint64_t	lastValidatedTime
uint64_t	endOfValidity
std::optional< std::string >	insertionTime
std::optional< std::string >	modificationTime

Detailed Description

The TagDto class It contains all fields of the TagDto class from the CREST API.

When using this to create a new Tag you don't need to set insertion and modification times.

Definition at line 97 of file CrestModel.h.

Constructor & Destructor Documentation

TagDto() [1/2]

TagDto::TagDto ( std::string  _name, std::string  _timeType, std::string  _description  )

inline

Definition at line 110 of file CrestModel.h.

                                                                        : name(_name), timeType(_timeType), 
        objectType(""), 
        synchronization("none"), 
        description(_description),
        lastValidatedTime(0), endOfValidity(0){
        
    }

TagDto() [2/2]

TagDto::TagDto ( )

inline

Definition at line 118 of file CrestModel.h.

            : name(""), timeType(""), objectType(""), synchronization("none"), description(""), lastValidatedTime(0), endOfValidity(0) {
   
    }

Member Function Documentation

from_json()

TagDto TagDto::from_json ( const json &  j )

static

Definition at line 188 of file CrestModel.cxx.

{
    TagDto tag;
    auto it = j.find("name");
    if (it != j.end())
    {
        tag.name = j["name"];
    }
    else
    {
        throw Crest::CrestException("ERROR in TagDto.from_json: JSON contains no tag name.");
    }
 
    tag.timeType = j.value("timeType", "");
    tag.objectType = j.value("payloadSpec", "");
    tag.synchronization = j.value("synchronization", "none");
    tag.description = j.value("description", "");
    tag.lastValidatedTime = j.value<uint64_t>("lastValidatedTime", 0);
    tag.endOfValidity = j.value<uint64_t>("endOfValidity", 0);
    if (j.contains(std::string{"insertionTime"}))
        tag.insertionTime = j.value("insertionTime", "");
    tag.modificationTime = j.value("modificationTime", "");
    return tag;
}

to_json()

json TagDto::to_json

(

)

const

Definition at line 172 of file CrestModel.cxx.

{
    json js = {};
    js["name"] = name;
    js["timeType"] = timeType;
    js["payloadSpec"] = objectType;
    js["synchronization"] = synchronization;
    if (insertionTime.has_value())
        js["insertionTime"] = insertionTime.value();
    js["description"] = description;
    js["lastValidatedTime"] = lastValidatedTime;
    js["endOfValidity"] = endOfValidity;
    if (modificationTime.has_value())
        js["modificationTime"] = modificationTime.value();
    return js;
}

Member Data Documentation

description

std::string TagDto::description

Definition at line 104 of file CrestModel.h.

endOfValidity

uint64_t TagDto::endOfValidity

Definition at line 106 of file CrestModel.h.

insertionTime

std::optional<std::string> TagDto::insertionTime

Definition at line 107 of file CrestModel.h.

lastValidatedTime

uint64_t TagDto::lastValidatedTime

Definition at line 105 of file CrestModel.h.

modificationTime

std::optional<std::string> TagDto::modificationTime

Definition at line 108 of file CrestModel.h.

name

std::string TagDto::name

Definition at line 100 of file CrestModel.h.

objectType

std::string TagDto::objectType

Definition at line 102 of file CrestModel.h.

synchronization

std::string TagDto::synchronization

Definition at line 103 of file CrestModel.h.

timeType

std::string TagDto::timeType

Definition at line 101 of file CrestModel.h.

---

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

• CrestModel.h
• CrestModel.cxx