SG::VarHandleKeyArrayProperty Class Reference

#include <VarHandleKeyArrayProperty.h>

Inheritance diagram for SG::VarHandleKeyArrayProperty:

Collaboration diagram for SG::VarHandleKeyArrayProperty:

Public Member Functions
	VarHandleKeyArrayProperty (const std::string &name, SG::VarHandleKeyArray &ref)
	Constructor with parameters. More...
VarHandleKeyArrayProperty &	operator= (const SG::VarHandleKeyArray &value)
	Assignment operator. More...
VarHandleKeyArrayProperty *	clone () const override
	Return a new copy of this Property object. More...
bool	load (Gaudi::Details::PropertyBase &destination) const override
	Set the value of another Property. More...
bool	assign (const Gaudi::Details::PropertyBase &source) override
	Set the value of this Property from another. More...
std::string	toString () const override
	Return a string representation of the value object. More...
void	toStream (std::ostream &out) const override
	Write a string representation of the value object to a stream. More...
StatusCode	fromString (const std::string &s) override
	Set this value object from a string. More...
const SG::VarHandleKeyArray &	value () const
	Return the value object for this Property. More...
bool	setValue (const SG::VarHandleKeyArray &value)
	Set the value object for this Property. More...

Private Attributes
SG::VarHandleKeyArray *	m_pValue
	Pointer to the real property. More...

Detailed Description

Definition at line 33 of file VarHandleKeyArrayProperty.h.

Constructor & Destructor Documentation

VarHandleKeyArrayProperty()

SG::VarHandleKeyArrayProperty::VarHandleKeyArrayProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	ref
	)

Constructor with parameters.

Parameters

name	Name of the property.
ref	Object which this property is setting.

Definition at line 21 of file VarHandleKeyArrayProperty.cxx.

    : PropertyWithHandlers( name, typeid( SG::VarHandleKeyArray ) ), 
      m_pValue( &ref ) 
  {
}

Member Function Documentation

assign()

bool SG::VarHandleKeyArrayProperty::assign ( const Gaudi::Details::PropertyBase &  source )

override

Set the value of this Property from another.

Parameters

destination

The Property from which the value should be copied.

The value object of this source is copied to that of this Property by converting to a string and back again. Returns true on success, false on failure.

Definition at line 80 of file VarHandleKeyArrayProperty.cxx.

{
  return fromString( source.toString() ).isSuccess();
}

clone()

VarHandleKeyArrayProperty * SG::VarHandleKeyArrayProperty::clone ( ) const

override

Return a new copy of this Property object.

The new object will be associated with the same value object as the original.

Definition at line 50 of file VarHandleKeyArrayProperty.cxx.

{
  return new VarHandleKeyArrayProperty( *this );
}

fromString()

StatusCode SG::VarHandleKeyArrayProperty::fromString ( const std::string &  s )

override

Set this value object from a string.

Parameters

s	String from which to initialize the value.

Returns failure if the conversion does not succeed.

Definition at line 118 of file VarHandleKeyArrayProperty.cxx.

{
  if (!Gaudi::Parsers::parse(*m_pValue, s).isSuccess()) {
    return StatusCode::FAILURE;
  }
  return useUpdateHandler()
    ? StatusCode::SUCCESS
    : StatusCode::FAILURE;
}

load()

bool SG::VarHandleKeyArrayProperty::load ( Gaudi::Details::PropertyBase &  destination ) const

override

Set the value of another Property.

Parameters

destination

The Property whose value is changed.

The value object of this Property is copied to that of destination by converting to a string and back again. Returns true on success, false on failure.

Definition at line 65 of file VarHandleKeyArrayProperty.cxx.

{
  return destination.assign( *this );
}

operator=()

VarHandleKeyArrayProperty & SG::VarHandleKeyArrayProperty::operator=

(

const SG::VarHandleKeyArray &

value

)

Assignment operator.

Parameters

value

Value from which to assign.

Copy the value object which we control from another value object.

Definition at line 36 of file VarHandleKeyArrayProperty.cxx.

{
  setValue( value );
  return *this;
}

setValue()

bool SG::VarHandleKeyArrayProperty::setValue

(

const SG::VarHandleKeyArray &

value

)

Set the value object for this Property.

Parameters

value

Value from which to copy.

Return true on success; false if the update handler failed.

Definition at line 147 of file VarHandleKeyArrayProperty.cxx.

{
  m_pValue->operator=(value);
  return useUpdateHandler();
}

toStream()

void SG::VarHandleKeyArrayProperty::toStream ( std::ostream &  out ) const

override

Write a string representation of the value object to a stream.

Parameters

out	Stream to which to write.

Definition at line 104 of file VarHandleKeyArrayProperty.cxx.

{
  useReadHandler();
  out << this->toString();
}

toString()

std::string SG::VarHandleKeyArrayProperty::toString ( ) const

override

Return a string representation of the value object.

Definition at line 90 of file VarHandleKeyArrayProperty.cxx.

{
  useReadHandler();
  std::ostringstream o;
  Gaudi::Utils::toStream(*m_pValue, o);
  return o.str();
}

value()

const SG::VarHandleKeyArray & SG::VarHandleKeyArrayProperty::value

(

)

const

Return the value object for this Property.

Definition at line 133 of file VarHandleKeyArrayProperty.cxx.

{
  useReadHandler();
  return *m_pValue;
}

Member Data Documentation

m_pValue

SG::VarHandleKeyArray* SG::VarHandleKeyArrayProperty::m_pValue

private

Pointer to the real property.

Reference would be better, but Reflex does not support references yet

Definition at line 64 of file VarHandleKeyArrayProperty.h.

---

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

• VarHandleKeyArrayProperty.h
• VarHandleKeyArrayProperty.cxx