YobeSDK  0.3.1
Yobe::IDTemplate Struct Referenceabstract

This struct is used to store biometric data of a user. More...

#include <yobe_id_template.hpp>

Public Member Functions

 IDTemplate (const IDTemplate &)=default
 
 IDTemplate (IDTemplate &&) noexcept=default
 
IDTemplateoperator= (const IDTemplate &)=default
 
IDTemplateoperator= (IDTemplate &&) noexcept=default
 
virtual bool IsValid () const =0
 Determines if the IDTemplate object is valid. More...
 
virtual void Serialize (std::ostream &out_stream) const =0
 Serializes the IDTemplate object. This can be used to save the object for later. More...
 

Static Public Member Functions

static std::shared_ptr< IDTemplateDeserialize (std::istream &in_stream)
 Deserializes the IDTemplate object. This can be used to read a saved object from a stream. More...
 

Detailed Description

This struct is used to store biometric data of a user.

Member Function Documentation

◆ IsValid()

virtual bool Yobe::IDTemplate::IsValid ( ) const
pure virtual

Determines if the IDTemplate object is valid.

Returns
True if the object is valid, false otherwise.

◆ Serialize()

virtual void Yobe::IDTemplate::Serialize ( std::ostream &  out_stream) const
pure virtual

Serializes the IDTemplate object. This can be used to save the object for later.

Parameters
out_streamThe stream to which the object will be written.

◆ Deserialize()

static std::shared_ptr<IDTemplate> Yobe::IDTemplate::Deserialize ( std::istream &  in_stream)
static

Deserializes the IDTemplate object. This can be used to read a saved object from a stream.

Parameters
in_streamThe stream from which to read the object.
Returns
A shared pointer to the newly created IDTemplate object.

The documentation for this struct was generated from the following file: