Public Member Functions
	__init__ (self, str canonical, Optional[Sequence[str]] aliases=None, Optional[LhaID] ext=None)

	from_any (cls, Union["CustomObservableSpec", dict, tuple] value)

Public Attributes
	canonical

	aliases

	ext

Protected Member Functions
	_to_cpp (self)

Detailed Description

Python value object describing a custom observable registration.

Args:
    canonical: Canonical observable name to register.
    aliases: Optional aliases.
    ext: Optional FLHA id.

Definition at line 132 of file Mapper.py.

Constructor & Destructor Documentation

◆ init()

pyhyperiso.core.Common.Mapper.CustomObservableSpec.__init__	(		self,
		str	canonical,
		Optional[Sequence[str]]	aliases = `None`,
		Optional[LhaID]	ext = `None`
	)

Definition at line 141 of file Mapper.py.

Member Function Documentation

◆ _to_cpp()

pyhyperiso.core.Common.Mapper.CustomObservableSpec._to_cpp ( self )

protected

Convert this spec to the bound C++ ``CustomObservableSpec``.

Definition at line 151 of file Mapper.py.

◆ from_any()

pyhyperiso.core.Common.Mapper.CustomObservableSpec.from_any	(		cls,
		Union["CustomObservableSpec", dict, tuple]	value
	)

Build a spec from a spec object, dict, or tuple.

Accepted tuple shapes are ``(canonical,)``, ``(canonical, aliases)``,
and ``(canonical, aliases, ext)``.

Definition at line 160 of file Mapper.py.

Member Data Documentation

◆ aliases

pyhyperiso.core.Common.Mapper.CustomObservableSpec.aliases

Definition at line 148 of file Mapper.py.

◆ canonical

pyhyperiso.core.Common.Mapper.CustomObservableSpec.canonical

Definition at line 147 of file Mapper.py.

◆ ext

pyhyperiso.core.Common.Mapper.CustomObservableSpec.ext

Definition at line 149 of file Mapper.py.

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

/home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/pyhyperiso/core/Common/Mapper.py

Public Member Functions

Public Attributes

Protected Member Functions