WrapperTraitGetterSetter Class Reference

Class generator for setter trait. More...

#include <WrapperTraitGetterSetter.h>

Inheritance diagram for WrapperTraitGetterSetter:

Collaboration diagram for WrapperTraitGetterSetter:

Public Member Functions
virtual void	classMethodDeclaration (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
	Declaration of class method.
virtual void	classMethodImplementation (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
	Implementation of class method.
virtual void	headerExtraInclude (std::ofstream &fs, const GeneratorMode &mode) const
	Add extra include on the header.
virtual void	registerClassGetterSetter (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
	Register class getter and setter.
virtual void	registerClassMember (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
	Register class member.
virtual void	registerClassMethod (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
	Register class method.
virtual void	setupAddDependency (std::ofstream &fs, const GeneratorMode &mode) const
virtual void	testCallFunction (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
	Call of the test function.
virtual void	testFunction (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
	Implementation of test function.
	WrapperTraitGetterSetter ()
	Consctructor of WrapperTraitGetterSetter.
virtual	~WrapperTraitGetterSetter ()
	Desctructor of WrapperTraitGetterSetter.

Detailed Description

Class generator for setter trait.

Definition at line 16 of file WrapperTraitGetterSetter.h.

Constructor & Destructor Documentation

WrapperTraitGetterSetter()

WrapperTraitGetterSetter::WrapperTraitGetterSetter

(

)

Consctructor of WrapperTraitGetterSetter.

Definition at line 11 of file WrapperTraitGetterSetter.cpp.

        :PAbstractWrapperTraitBackend()
{}

References PAbstractWrapperTraitBackend::PAbstractWrapperTraitBackend().

Here is the call graph for this function:

~WrapperTraitGetterSetter()

WrapperTraitGetterSetter::~WrapperTraitGetterSetter ( )

virtual

Desctructor of WrapperTraitGetterSetter.

Definition at line 16 of file WrapperTraitGetterSetter.cpp.

{}

Member Function Documentation

classMethodDeclaration()

void WrapperTraitGetterSetter::classMethodDeclaration ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

virtual

Declaration of class method.

Parameters

[out]	fs	: file to be completed
	classConfig	: PClassConfig to be used
	mode	: mode of the generator

Reimplemented from PAbstractWrapperTraitBackend.

Definition at line 32 of file WrapperTraitGetterSetter.cpp.

                                                                                                                                         {
        if(!mode.enableSetter || !mode.enableGetter || classConfig.getIsEnum()){return;}
        PString className(wrapper_getClassName(classConfig));
        const PVecClassAttribute & vecAttr = classConfig.getListAttribute();
        for(PVecClassAttribute::const_iterator it(vecAttr.begin()); it != vecAttr.end(); ++it){
                //If the type is simple, we do not need getter, setter and other methods
                if(getIsSimpleType(it->getType())){continue;}
                fs << "int "+className+"_set"+it->getName()+"("+className+" * self, PyObject * value, void * closure);\n";
                fs << "PyObject * "+className+"_get"+it->getName()+"("+className+" * self, void * closure);\n";
        }
}

References GeneratorMode::enableGetter, GeneratorMode::enableSetter, PClassConfig::getIsEnum(), getIsSimpleType(), PClassConfig::getListAttribute(), and wrapper_getClassName().

Here is the call graph for this function:

classMethodImplementation()

void WrapperTraitGetterSetter::classMethodImplementation ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

virtual

Implementation of class method.

Parameters

[out]	fs	: file to be completed
	classConfig	: PClassConfig to be used
	mode	: mode of the generator

Reimplemented from PAbstractWrapperTraitBackend.

Definition at line 49 of file WrapperTraitGetterSetter.cpp.

                                                                                                                                            {
        if(!mode.enableSetter || !mode.enableGetter || classConfig.getIsEnum()){return;}
        PString body, className(wrapper_getClassName(classConfig));
        const PVecClassAttribute & vecAttr = classConfig.getListAttribute();
        for(PVecClassAttribute::const_iterator it(vecAttr.begin()); it != vecAttr.end(); ++it){
                if(getIsSimpleType(it->getType())){continue;}
                PString attrName(it->getName()), attrDoc(it->getDocumentation());
                fs << "///Setter of the "+attrName+"\n";
                fs << "/**\t@param self : object "+className+"\n";
                fs << " * \t@param value : "+attrDoc+"\n";
                fs << " * \t@param closure : object closure for python API (it is a wrapper python grosse bidouille)\n";
                fs << " * \t@return 0 on success, -1 otherwise\n";
                fs << "*/\n";
                fs << "int "+className+"_set"+attrName+"("+className+" * self, PyObject * value, void * closure){\n";
                fs << "\tif(value == NULL){\n";
                fs << "\t\tPyErr_SetString(PyExc_TypeError, \"Cannot delete the "+className+"."+attrName+" attribute\");\n";
                fs << "\t\treturn -1;\n";
                fs << "\t}\n";
                fs << "\tPy_DECREF(self->"+attrName+");\n";
                fs << "\tPy_INCREF(value);\n";
                fs << "\tself->"+attrName+" = value;\n";
                fs << "\treturn 0;\n";
                fs << "}\n\n";
                
                fs << "///Setter of the "+attrName+"\n";
                fs << "/**\t@param self : object "+className+"\n";
                fs << " * \t@param closure : object closure for python API (it is a wrapper python grosse bidouille)\n";
                fs << " * \t@return "+attrDoc+"\n";
                fs << "*/\n";
                fs << "PyObject * "+className+"_get"+attrName+"("+className+" * self, void * closure){\n";
                fs << "\tPy_INCREF(self->"+attrName+");\n";
                fs << "\treturn self->"+attrName+";\n";
                fs << "}\n\n";
                
        }
}

References GeneratorMode::enableGetter, GeneratorMode::enableSetter, PClassConfig::getIsEnum(), getIsSimpleType(), PClassConfig::getListAttribute(), and wrapper_getClassName().

Here is the call graph for this function:

headerExtraInclude()

void WrapperTraitGetterSetter::headerExtraInclude ( std::ofstream & fs, const GeneratorMode & mode ) const

virtual

Add extra include on the header.

Parameters

[out]	fs	: file to be completed
	mode	: mode of the generator

Reimplemented from PAbstractWrapperTraitBackend.

Definition at line 22 of file WrapperTraitGetterSetter.cpp.

                                                                                                   {
        if(!mode.enableSetter || !mode.enableGetter){return;}
        
}

References GeneratorMode::enableGetter, and GeneratorMode::enableSetter.

registerClassGetterSetter()

void WrapperTraitGetterSetter::registerClassGetterSetter ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

virtual

Register class getter and setter.

Parameters

[out]	fs	: file to be completed
	classConfig	: PClassConfig to be used
	mode	: mode of the generator

Reimplemented from PAbstractWrapperTraitBackend.

Definition at line 108 of file WrapperTraitGetterSetter.cpp.

                                                                                                                                            {
        if(!mode.enableSetter || !mode.enableGetter){return;}
        PString className(wrapper_getClassName(classConfig));
        const PVecClassAttribute & vecAttr = classConfig.getListAttribute();
        for(PVecClassAttribute::const_iterator it(vecAttr.begin()); it != vecAttr.end(); ++it){
                if(getIsSimpleType(it->getType())){
                        continue;
                }
                fs << "\t{(char*)\""<<it->getName()+"\", (getter)"<<className+"_get"<<it->getName()<<", (setter)"<<className+"_set"+it->getName()<<", (char*)\""+it->getDocumentation().replace("///", "")+"\",  NULL},\n";
        }
}

References GeneratorMode::enableGetter, GeneratorMode::enableSetter, getIsSimpleType(), PClassConfig::getListAttribute(), and wrapper_getClassName().

Here is the call graph for this function:

registerClassMember()

void WrapperTraitGetterSetter::registerClassMember ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

virtual

Register class member.

Parameters

[out]	fs	: file to be completed
	classConfig	: PClassConfig to be used
	mode	: mode of the generator

Reimplemented from PAbstractWrapperTraitBackend.

Definition at line 91 of file WrapperTraitGetterSetter.cpp.

                                                                                                                                      {
        if(!mode.enableSetter || !mode.enableGetter){return;}
        PString className(wrapper_getClassName(classConfig));
        const PVecClassAttribute & vecAttr = classConfig.getListAttribute();
        for(PVecClassAttribute::const_iterator it(vecAttr.begin()); it != vecAttr.end(); ++it){
                if(!getIsSimpleType(it->getType())){
                        continue;
                }
                fs << "\t{(char*)\""<<it->getName()<<"\", "+getPythonStrForPythonApiType(it->getType())<<", offsetof("<<className<<", "<<it->getName()<<"), 0, (char*)\"Doc : "<<it->getDocumentation().replace("///", "")<<"\"},\n";
        }
}

References GeneratorMode::enableGetter, GeneratorMode::enableSetter, getIsSimpleType(), PClassConfig::getListAttribute(), getPythonStrForPythonApiType(), and wrapper_getClassName().

Here is the call graph for this function:

registerClassMethod()

void WrapperTraitGetterSetter::registerClassMethod ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

virtual

Register class method.

Parameters

[out]	fs	: file to be completed
	classConfig	: PClassConfig to be used
	mode	: mode of the generator

Reimplemented from PAbstractWrapperTraitBackend.

Definition at line 125 of file WrapperTraitGetterSetter.cpp.

                                                                                                                                      {
        if(!mode.enableSetter || !mode.enableGetter){return;}
        
}

References GeneratorMode::enableGetter, and GeneratorMode::enableSetter.

setupAddDependency()

virtual void PAbstractWrapperTraitBackend::setupAddDependency ( std::ofstream & fs, const GeneratorMode & mode ) const

inlinevirtualinherited

Reimplemented in WrapperTraitDataStream, and WrapperTraitTypeStream.

Definition at line 60 of file PAbstractTraitBackend.h.

{}

testCallFunction()

void WrapperTraitGetterSetter::testCallFunction ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

virtual

Call of the test function.

Parameters

[out]	fs	: file to be completed
	classConfig	: PClassConfig to be used
	mode	: mode of the generator

Reimplemented from PAbstractWrapperTraitBackend.

Definition at line 145 of file WrapperTraitGetterSetter.cpp.

                                                                                                                                   {
        if(!mode.enableSetter || !mode.enableGetter){return;}
        
}

References GeneratorMode::enableGetter, and GeneratorMode::enableSetter.

testFunction()

void WrapperTraitGetterSetter::testFunction ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

virtual

Implementation of test function.

Parameters

[out]	fs	: file to be completed
	classConfig	: PClassConfig to be used
	mode	: mode of the generator

Reimplemented from PAbstractWrapperTraitBackend.

Definition at line 135 of file WrapperTraitGetterSetter.cpp.

                                                                                                                               {
        if(!mode.enableSetter || !mode.enableGetter){return;}
        
}

References GeneratorMode::enableGetter, and GeneratorMode::enableSetter.

---

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

• /builds/CTA-LAPP/PHOENIX_LIBS2/code-generator/PhoenixGenerator/src/TraitBackEnd/PythonWrapper/WrapperTraitGetterSetter/WrapperTraitGetterSetter.h
• /builds/CTA-LAPP/PHOENIX_LIBS2/code-generator/PhoenixGenerator/src/TraitBackEnd/PythonWrapper/WrapperTraitGetterSetter/WrapperTraitGetterSetter.cpp