PyOpal::PyElementNS::AttributeDef Struct Reference

#include <PyElement.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 73 of file PyElement.h.

Member Data Documentation

docString_m

std::string PyOpal::PyElementNS::AttributeDef::docString_m

Definition at line 76 of file PyElement.h.

Referenced by PyOpal::PyElementNS::PyElement< C >::getDocString().

opalName_m

std::string PyOpal::PyElementNS::AttributeDef::opalName_m

Definition at line 74 of file PyElement.h.

Referenced by PyOpal::PyElementNS::PyElement< C >::getDocString().

pyName_m

std::string PyOpal::PyElementNS::AttributeDef::pyName_m

Definition at line 75 of file PyElement.h.

Referenced by PyOpal::PyElementNS::PyElement< C >::getDocString().

type_m

AttributeType PyOpal::PyElementNS::AttributeDef::type_m

Definition at line 77 of file PyElement.h.

Referenced by PyOpal::PyElementNS::PyElement< C >::getDocString().

---

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

• /Users/gsell/src/OPAL/src/src/_PyOpal/PyElement.h