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

Public Types

typedef ::zerobuf::Vector< uint64_t > Bins
 

Public Member Functions

Histogram::Bins & getBins ()
 Get a reference to the Bins dynamic member. More...
 
const Histogram::Bins & getBins () const
 
void setBins (uint64_t const *value, size_t size)
 Set the value of the Bins dynamic object from a uint64_t* and size. More...
 
std::vector< uint64_t > getBinsVector () const
 
void setBins (const std::vector< uint64_t > &value)
 Set the value of the Bins dynamic object from a std::vector< uint64_t >. More...
 
float getMin () const
 
void setMin (float value)
 Set the Min value. More...
 
float getMax () const
 
void setMax (float value)
 Set the Max value. More...
 
void compact (float threshold=0.1f) final
 
 Histogram (const std::vector< uint64_t > &binsValue, const float &minValue, const float &maxValue)
 
 Histogram (const Histogram &rhs)
 
 Histogram (Histogram &&rhs) noexcept
 
 Histogram (const ::zerobuf::Zerobuf &rhs)
 
 Histogram (::zerobuf::AllocatorPtr allocator)
 
Histogramoperator= (const Histogram &rhs)
 
Histogramoperator= (Histogram &&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 ConstHistogramPtr create (const void *data, const size_t size)
 

Detailed Description

Definition at line 18 of file histogram.h.

Member Function Documentation

Histogram::Bins& lexis::render::Histogram::getBins ( )

Get a reference to the Bins dynamic member.

Warning
: If the reference is used to modify the object, notifyChanged() needs to be explicitly called afterwards.
Returns
a reference to the Bins dynamic member.
void lexis::render::Histogram::setBins ( uint64_t const *  value,
size_t  size 
)

Set the value of the Bins dynamic object from a uint64_t* and size.

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

Parameters
valuea uint64_t* to the data to be set in the current object
sizethe size of the data to be set
void lexis::render::Histogram::setBins ( const std::vector< uint64_t > &  value)

Set the value of the Bins dynamic object from a std::vector< uint64_t >.

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

Parameters
valuea std::vector< uint64_t > object with the data to be set
void lexis::render::Histogram::setMax ( float  value)

Set the Max value.

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

Parameters
valuethe Max value
void lexis::render::Histogram::setMin ( float  value)

Set the Min value.

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

Parameters
valuethe Min value

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