PyOpal::PyOpalObjectNS::AttributeDef Struct Reference

#include <PyOpalObject.h>

Public Attributes
std::string	opalName_m
std::string	pyName_m
std::string	docString_m
AttributeType	type_m

Detailed Description

AttributeDef defines an attribute opalName_m: the name of the opal Attribute pyName_m: the name that will be visible to the user in python. Properties should be_lower_case_with_underscores to comply with python API docString_m: docstring. If left empty (""), PyElement will generate a docstring like "py_name (type): Attribute help string" type_m: python type.

Definition at line 94 of file PyOpalObject.h.

Member Data Documentation

std::string PyOpal::PyOpalObjectNS::AttributeDef::docString_m

Definition at line 97 of file PyOpalObject.h.

Referenced by PyOpal::PyOpalObjectNS::PyOpalObject< C >::getDocString().

std::string PyOpal::PyOpalObjectNS::AttributeDef::opalName_m

Definition at line 95 of file PyOpalObject.h.

Referenced by PyOpal::PyOpalObjectNS::PyOpalObject< C >::getDocString(), and PyOpal::PyOpalObjectNS::PyOpalObject< C >::setAttributes().

std::string PyOpal::PyOpalObjectNS::AttributeDef::pyName_m

Definition at line 96 of file PyOpalObject.h.

Referenced by PyOpal::PyOpalObjectNS::PyOpalObject< C >::getDocString().

AttributeType PyOpal::PyOpalObjectNS::AttributeDef::type_m

Definition at line 98 of file PyOpalObject.h.

Referenced by PyOpal::PyOpalObjectNS::PyOpalObject< C >::getDocString(), and PyOpal::PyOpalObjectNS::PyOpalObject< C >::setAttributes().

---

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

• src/PyOpal/PyCore/PyOpalObject.h