A generic object from the parameters library. More...

#include <object.h>

Inheritance diagram for lsst::modelfit::parameters::Object:

Public Member Functions
virtual std::string	repr (bool name_keywords=false, const std::string_view &namespace_separator=CC_NAMESPACE_SEPARATOR) const =0
	Return a full, callable string representation of this.

virtual std::string	str () const =0
	Return a brief, human-readable string representation of this.

virtual	~Object ()=default

Static Public Attributes
static constexpr std::string_view	CC_NAMESPACE_SEPARATOR = "::"
	The C++ namespace separator.

Friends
std::ostream &	operator<< (std::ostream &out, const Object &obj)

Detailed Description

A generic object from the parameters library.

Objects have string representations that are guaranteed to be valid in C++ and should also be valid in Python bindings, if implemented correctly. The interface may be expanded in the future.

Definition at line 39 of file object.h.

Constructor & Destructor Documentation

◆ ~Object()

virtual lsst::modelfit::parameters::Object::~Object ( )

virtualdefault

Member Function Documentation

◆ repr()

virtual std::string lsst::modelfit::parameters::Object::repr	(	bool	name_keywords = false,
		const std::string_view &	namespace_separator = CC_NAMESPACE_SEPARATOR ) const

pure virtual

Return a full, callable string representation of this.

Parameters

name_keywords	Whether to prefix arguments with "{name}=", where name is the arg name in the header (as with keyword arguments in Python).
namespace_separator	The string to use to delimit namespaces, i.e. :: in C++ and . in Python.

Returns: A callable string representation of this, which should return an an identical object to this.

Note: The representation with name_keywords=false must be callable in C++. The representation with name_keywords=true should be callable in Python, if there are any bindings.

Implemented in lsst::modelfit::parameters::Limits< double >, lsst::modelfit::parameters::Limits< T >, lsst::modelfit::parameters::Parameter< T, C >, lsst::gauss2d::fit::InverseTransform, lsst::gauss2d::fit::JanskyToABMagTransform, lsst::gauss2d::fit::NanojanskyToABMagTransform, lsst::gauss2d::fit::LogTransform, lsst::gauss2d::fit::Log10Transform, lsst::gauss2d::fit::LogitTransform, lsst::gauss2d::fit::LogitLimitedTransform, and lsst::modelfit::parameters::UnitTransform< T >.

◆ str()

virtual std::string lsst::modelfit::parameters::Object::str ( ) const

pure virtual

Return a brief, human-readable string representation of this.

Implemented in lsst::gauss2d::fit::InverseTransform, lsst::gauss2d::fit::JanskyToABMagTransform, lsst::gauss2d::fit::NanojanskyToABMagTransform, lsst::gauss2d::fit::LogTransform, lsst::gauss2d::fit::Log10Transform, lsst::gauss2d::fit::LogitTransform, lsst::gauss2d::fit::LogitLimitedTransform, lsst::modelfit::parameters::Limits< double >, lsst::modelfit::parameters::Limits< T >, lsst::modelfit::parameters::Parameter< T, C >, and lsst::modelfit::parameters::UnitTransform< T >.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	out,
		const Object &	obj )

friend

Definition at line 65 of file object.h.

                                                                      {
        out << obj.str();
        return out;
    }

Member Data Documentation

◆ CC_NAMESPACE_SEPARATOR

constexpr std::string_view lsst::modelfit::parameters::Object::CC_NAMESPACE_SEPARATOR = "::"

staticconstexpr

The C++ namespace separator.

Definition at line 42 of file object.h.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/modelfit_parameters/g35bb328faa+34a971ddd9/include/lsst/modelfit/parameters/object.h

Public Member Functions

Static Public Attributes

Friends