IProperty.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
#include <Gaudi/Details/PropertyBase.h>
#include <GaudiKernel/GaudiException.h>
#include <GaudiKernel/IInterface.h>
#include <GaudiKernel/INamedInterface.h>
#include <GaudiKernel/ToStream.h>
#include <iostream>
#include <string>
#include <string_view>
#include <vector>

class GAUDI_API IProperty : virtual public IInterface {
public:
  DeclareInterfaceID( IProperty, 3, 0 );

  StatusCode setProperty( const Gaudi::Details::PropertyBase& p ) { return setProperty( p.name(), p ); }
  virtual StatusCode setProperty( const std::string& name, const Gaudi::Details::PropertyBase& p ) = 0;
  virtual StatusCode setProperty( const std::string& s ) = 0;
  virtual StatusCode setPropertyRepr( const std::string& n, const std::string& r ) = 0;
  StatusCode setProperty( const std::string& name, const char* v ) { return setProperty( name, std::string{ v } ); }
  StatusCode setProperty( const std::string& name, const std::string& v ) {
    if ( !hasProperty( name ) ) return StatusCode::FAILURE;
    return setPropertyRepr( name, v );
  }

  template <class TYPE>
    requires( !std::is_base_of_v<Gaudi::Details::PropertyBase, TYPE> )
  StatusCode setProperty( const std::string& name, const TYPE& value ) {
    using Gaudi::Utils::toString;
    if ( !hasProperty( name ) ) return StatusCode::FAILURE;
    return setPropertyRepr( name, toString( value ) );
  }

  virtual StatusCode getProperty( Gaudi::Details::PropertyBase* p // Pointer to property to be set
  ) const = 0;
  virtual const Gaudi::Details::PropertyBase& getProperty( std::string_view name // Property name
  ) const = 0;
  virtual StatusCode getProperty( std::string_view n, std::string& v ) const = 0;
  virtual const std::vector<Gaudi::Details::PropertyBase*>& getProperties() const = 0;

  virtual bool hasProperty( std::string_view name ) const = 0;
};