Logo ROOT  
Reference Guide
ROOT::Experimental::RAttrBase Class Reference

Base class for all attributes, used with RDrawable.

Author
Sergey Linev s.lin.nosp@m.ev@g.nosp@m.si.de
Date
2019-09-17
Warning
This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!

Definition at line 39 of file RAttrBase.hxx.

Classes

struct  Rec_t
 
struct  Val_t
 

Public Member Functions

 RAttrBase ()=default
 
virtual ~RAttrBase ()=default
 

Protected Member Functions

 RAttrBase (const RAttrBase &src)
 
 RAttrBase (RAttrBase *parent, const std::string &prefix)
 
 RAttrBase (RDrawable *drawable, const std::string &prefix)
 
const Rec_t AccessAttr (const std::string &name) const
 Find attributes container and full-qualified name for value. More...
 
const Val_t AccessValue (const std::string &name, bool use_style=true) const
 Search value with given name in attributes. More...
 
void AssignDrawable (RDrawable *drawable, const std::string &prefix)
 Return value from attributes container - no style or defaults are used. More...
 
void AssignParent (RAttrBase *parent, const std::string &prefix)
 Assign parent object for this RAttrBase. More...
 
void Clear ()
 Clear all respective values from drawable. Only defaults can be used. More...
 
void ClearValue (const std::string &name)
 Clear value if any with specified name. More...
 
void CopyTo (RAttrBase &tgt, bool use_style=true) const
 Copy attributes into target object. More...
 
bool CopyValue (const std::string &name, const RAttrMap::Value_t &value, bool check_type=true)
 Copy attributes from other object. More...
 
Rec_t EnsureAttr (const std::string &name)
 Ensure attribute with give name exists - creates container for attributes if required. More...
 
template<typename RET_TYPE , typename MATCH_TYPE = void>
auto Eval (const std::string &name, bool use_dflts=true) const
 Evaluate attribute value. More...
 
virtual const RAttrMapGetDefaults () const
 Return default values for attributes, empty for base class. More...
 
const std::string & GetPrefix () const
 
template<typename T >
GetValue (const std::string &name) const
 
template<typename T = void>
bool HasValue (const std::string &name, bool check_defaults=false) const
 
bool IsSame (const RAttrBase &src, bool use_style=true) const
 Check if all values which are evaluated in this object are exactly the same as in tgt object. More...
 
bool IsValueEqual (const std::string &name, const RAttrMap::Value_t &value, bool use_style=false) const
 Check if provided value equal to attribute in the map. More...
 
void MoveTo (RAttrBase &tgt)
 Move all fields into target object. More...
 
RAttrBaseoperator= (const RAttrBase &src)
 
void SetNoValue (const std::string &name)
 Set <NoValue> for attribute. More...
 
void SetValue (const std::string &name, bool value)
 Set boolean value. More...
 
void SetValue (const std::string &name, const RPadLength &value)
 Set PadLength value. More...
 
void SetValue (const std::string &name, const std::string &value)
 Set string value. More...
 
void SetValue (const std::string &name, double value)
 Set double value. More...
 
void SetValue (const std::string &name, int value)
 Set integer value. More...
 

Private Attributes

RDrawablefDrawable {nullptr}
 ! drawable used to store attributes More...
 
std::unique_ptr< RAttrMapfOwnAttr
 own instance when deep copy is created, persistent for RColor and similar classes More...
 
RAttrBasefParent {nullptr}
 ! parent attributes, prefix applied to it More...
 
std::string fPrefix
 ! name prefix for all attributes values More...
 

Friends

bool operator!= (const RAttrBase &lhs, const RAttrBase &rhs)
 
bool operator== (const RAttrBase &lhs, const RAttrBase &rhs)
 
class RAttrMap
 

#include <ROOT/RAttrBase.hxx>

Inheritance diagram for ROOT::Experimental::RAttrBase:
[legend]

Constructor & Destructor Documentation

◆ RAttrBase() [1/4]

ROOT::Experimental::RAttrBase::RAttrBase ( RDrawable drawable,
const std::string &  prefix 
)
inlineprotected

Definition at line 148 of file RAttrBase.hxx.

◆ RAttrBase() [2/4]

ROOT::Experimental::RAttrBase::RAttrBase ( RAttrBase parent,
const std::string &  prefix 
)
inlineprotected

Definition at line 150 of file RAttrBase.hxx.

◆ RAttrBase() [3/4]

ROOT::Experimental::RAttrBase::RAttrBase ( const RAttrBase src)
inlineprotected

Definition at line 152 of file RAttrBase.hxx.

◆ RAttrBase() [4/4]

ROOT::Experimental::RAttrBase::RAttrBase ( )
default

◆ ~RAttrBase()

virtual ROOT::Experimental::RAttrBase::~RAttrBase ( )
virtualdefault

Member Function Documentation

◆ AccessAttr()

const Rec_t ROOT::Experimental::RAttrBase::AccessAttr ( const std::string &  name) const
inlineprotected

Find attributes container and full-qualified name for value.

Definition at line 70 of file RAttrBase.hxx.

◆ AccessValue()

const Val_t ROOT::Experimental::RAttrBase::AccessValue ( const std::string &  name,
bool  use_style = true 
) const
inlineprotected

Search value with given name in attributes.

Definition at line 92 of file RAttrBase.hxx.

◆ AssignDrawable()

void ROOT::Experimental::RAttrBase::AssignDrawable ( RDrawable drawable,
const std::string &  prefix 
)
protected

Return value from attributes container - no style or defaults are used.

Definition at line 92 of file RAttrBase.cxx.

◆ AssignParent()

void ROOT::Experimental::RAttrBase::AssignParent ( RAttrBase parent,
const std::string &  prefix 
)
protected

Assign parent object for this RAttrBase.

Definition at line 103 of file RAttrBase.cxx.

◆ Clear()

void ROOT::Experimental::RAttrBase::Clear ( )
protected

Clear all respective values from drawable. Only defaults can be used.

Definition at line 180 of file RAttrBase.cxx.

◆ ClearValue()

void ROOT::Experimental::RAttrBase::ClearValue ( const std::string &  name)
protected

Clear value if any with specified name.

Definition at line 114 of file RAttrBase.cxx.

◆ CopyTo()

void ROOT::Experimental::RAttrBase::CopyTo ( RAttrBase tgt,
bool  use_style = true 
) const
protected

Copy attributes into target object.

Definition at line 58 of file RAttrBase.cxx.

◆ CopyValue()

bool ROOT::Experimental::RAttrBase::CopyValue ( const std::string &  name,
const RAttrMap::Value_t value,
bool  check_type = true 
)
protected

Copy attributes from other object.

Definition at line 28 of file RAttrBase.cxx.

◆ EnsureAttr()

Rec_t ROOT::Experimental::RAttrBase::EnsureAttr ( const std::string &  name)
inlineprotected

Ensure attribute with give name exists - creates container for attributes if required.

Definition at line 109 of file RAttrBase.hxx.

◆ Eval()

template<typename RET_TYPE , typename MATCH_TYPE = void>
auto ROOT::Experimental::RAttrBase::Eval ( const std::string &  name,
bool  use_dflts = true 
) const
inlineprotected

Evaluate attribute value.

Definition at line 129 of file RAttrBase.hxx.

◆ GetDefaults()

const ROOT::Experimental::RAttrMap & ROOT::Experimental::RAttrBase::GetDefaults ( ) const
protectedvirtual

Return default values for attributes, empty for base class.

Reimplemented in ROOT::Experimental::RAttrValue< T >.

Definition at line 19 of file RAttrBase.cxx.

◆ GetPrefix()

const std::string& ROOT::Experimental::RAttrBase::GetPrefix ( ) const
inlineprotected

Definition at line 168 of file RAttrBase.hxx.

◆ GetValue()

template<typename T >
T ROOT::Experimental::RAttrBase::GetValue ( const std::string &  name) const
inlineprotected

Definition at line 182 of file RAttrBase.hxx.

◆ HasValue()

template<typename T = void>
bool ROOT::Experimental::RAttrBase::HasValue ( const std::string &  name,
bool  check_defaults = false 
) const
inlineprotected

Definition at line 175 of file RAttrBase.hxx.

◆ IsSame()

bool ROOT::Experimental::RAttrBase::IsSame ( const RAttrBase src,
bool  use_style = true 
) const
protected

Check if all values which are evaluated in this object are exactly the same as in tgt object.

Definition at line 80 of file RAttrBase.cxx.

◆ IsValueEqual()

bool ROOT::Experimental::RAttrBase::IsValueEqual ( const std::string &  name,
const RAttrMap::Value_t value,
bool  use_style = false 
) const
protected

Check if provided value equal to attribute in the map.

Definition at line 47 of file RAttrBase.cxx.

◆ MoveTo()

void ROOT::Experimental::RAttrBase::MoveTo ( RAttrBase tgt)
protected

Move all fields into target object.

Definition at line 69 of file RAttrBase.cxx.

◆ operator=()

RAttrBase& ROOT::Experimental::RAttrBase::operator= ( const RAttrBase src)
inlineprotected

Definition at line 154 of file RAttrBase.hxx.

◆ SetNoValue()

void ROOT::Experimental::RAttrBase::SetNoValue ( const std::string &  name)
protected

Set <NoValue> for attribute.

Ensure that value can not be configured via style - defaults will be used Equivalent to css syntax { attrname:; }

Definition at line 124 of file RAttrBase.cxx.

◆ SetValue() [1/5]

void ROOT::Experimental::RAttrBase::SetValue ( const std::string &  name,
bool  value 
)
protected

Set boolean value.

Definition at line 133 of file RAttrBase.cxx.

◆ SetValue() [2/5]

void ROOT::Experimental::RAttrBase::SetValue ( const std::string &  name,
const RPadLength value 
)
protected

Set PadLength value.

Definition at line 169 of file RAttrBase.cxx.

◆ SetValue() [3/5]

void ROOT::Experimental::RAttrBase::SetValue ( const std::string &  name,
const std::string &  value 
)
protected

Set string value.

Definition at line 160 of file RAttrBase.cxx.

◆ SetValue() [4/5]

void ROOT::Experimental::RAttrBase::SetValue ( const std::string &  name,
double  value 
)
protected

Set double value.

Definition at line 151 of file RAttrBase.cxx.

◆ SetValue() [5/5]

void ROOT::Experimental::RAttrBase::SetValue ( const std::string &  name,
int  value 
)
protected

Set integer value.

Definition at line 142 of file RAttrBase.cxx.

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( const RAttrBase lhs,
const RAttrBase rhs 
)
friend

Definition at line 193 of file RAttrBase.hxx.

◆ operator==

bool operator== ( const RAttrBase lhs,
const RAttrBase rhs 
)
friend

Definition at line 192 of file RAttrBase.hxx.

◆ RAttrMap

friend class RAttrMap
friend

Definition at line 41 of file RAttrBase.hxx.

Member Data Documentation

◆ fDrawable

RDrawable* ROOT::Experimental::RAttrBase::fDrawable {nullptr}
private

! drawable used to store attributes

Definition at line 43 of file RAttrBase.hxx.

◆ fOwnAttr

std::unique_ptr<RAttrMap> ROOT::Experimental::RAttrBase::fOwnAttr
private

own instance when deep copy is created, persistent for RColor and similar classes

Definition at line 44 of file RAttrBase.hxx.

◆ fParent

RAttrBase* ROOT::Experimental::RAttrBase::fParent {nullptr}
private

! parent attributes, prefix applied to it

Definition at line 46 of file RAttrBase.hxx.

◆ fPrefix

std::string ROOT::Experimental::RAttrBase::fPrefix
private

! name prefix for all attributes values

Definition at line 45 of file RAttrBase.hxx.


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