Lexis  1.1.0
Vocabulary of events and shared objects for BBP and HBP software
lexis::data::detail::Progress Class Reference
+ Inheritance diagram for lexis::data::detail::Progress:
+ Collaboration diagram for lexis::data::detail::Progress:

Public Types

typedef ::zerobuf::Vector< char > Operation
 

Public Member Functions

Progress::Operation & getOperation ()
 Get a reference to the Operation dynamic member. More...
 
const Progress::Operation & getOperation () const
 
void setOperation (char const *value, size_t size)
 Set the value of the Operation dynamic object from a char* and size. More...
 
std::string getOperationString () const
 
void setOperation (const std::string &value)
 Set the value of the Operation dynamic object from a std::string. More...
 
float getAmount () const
 
void setAmount (float value)
 Set the Amount value. More...
 
void compact (float threshold=0.1f) final
 
 Progress (const std::string &operationValue, const float &amountValue)
 
 Progress (const Progress &rhs)
 
 Progress (Progress &&rhs) noexcept
 
 Progress (const ::zerobuf::Zerobuf &rhs)
 
 Progress (::zerobuf::AllocatorPtr allocator)
 
Progressoperator= (const Progress &rhs)
 
Progressoperator= (Progress &&rhs)
 
std::string getSchema () const final
 
std::string getTypeName () const final
 
::zerobuf::uint128_t getTypeIdentifier () const final
 
size_t getZerobufStaticSize () const final
 
size_t getZerobufNumDynamics () const final
 
void _parseJSON (const Json::Value &json) final
 
void _createJSON (Json::Value &json) const final
 

Static Public Member Functions

static std::string ZEROBUF_SCHEMA ()
 
static std::string ZEROBUF_TYPE_NAME ()
 
::zerobuf::uint128_t ZEROBUF_TYPE_IDENTIFIER ()
 
static size_t ZEROBUF_STATIC_SIZE ()
 
static size_t ZEROBUF_NUM_DYNAMICS ()
 
static ConstProgressPtr create (const void *data, const size_t size)
 

Detailed Description

Definition at line 20 of file progress.h.

Member Function Documentation

Progress::Operation& lexis::data::detail::Progress::getOperation ( )

Get a reference to the Operation dynamic member.

Warning
: If the reference is used to modify the object, notifyChanged() needs to be explicitly called afterwards.
Returns
a reference to the Operation dynamic member.
void lexis::data::detail::Progress::setAmount ( float  value)

Set the Amount value.

notifyChanged() is internally called after the change has been done.

Parameters
valuethe Amount value
void lexis::data::detail::Progress::setOperation ( char const *  value,
size_t  size 
)

Set the value of the Operation dynamic object from a char* and size.

notifyChanged() is internally called after the data has been copied.

Parameters
valuea char* to the data to be set in the current object
sizethe size of the data to be set
void lexis::data::detail::Progress::setOperation ( const std::string &  value)

Set the value of the Operation dynamic object from a std::string.

notifyChanged() is internally called after the data has been copied.

Parameters
valuea std::string with the data to be set

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