WrapperTraitDataStream Class Reference

Class generator for setter trait. More...

#include <WrapperTraitDataStream.h>

Inheritance diagram for WrapperTraitDataStream:

Collaboration diagram for WrapperTraitDataStream:

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
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
	Add dependency in the setup.py.
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.
	WrapperTraitDataStream ()
	Consctructor of WrapperTraitDataStream.
virtual	~WrapperTraitDataStream ()
	Desctructor of WrapperTraitDataStream.

Detailed Description

Class generator for setter trait.

Definition at line 16 of file WrapperTraitDataStream.h.

Constructor & Destructor Documentation

WrapperTraitDataStream()

WrapperTraitDataStream::WrapperTraitDataStream

(

)

Consctructor of WrapperTraitDataStream.

Definition at line 519 of file WrapperTraitDataStream.cpp.

        :PAbstractWrapperTraitBackend()
{}

References PAbstractWrapperTraitBackend::PAbstractWrapperTraitBackend().

Here is the call graph for this function:

~WrapperTraitDataStream()

WrapperTraitDataStream::~WrapperTraitDataStream ( )

virtual

Desctructor of WrapperTraitDataStream.

Definition at line 524 of file WrapperTraitDataStream.cpp.

{}

Member Function Documentation

classMethodDeclaration()

void WrapperTraitDataStream::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 540 of file WrapperTraitDataStream.cpp.

                                                                                                                                       {
        if(!mode.enableDataStream){return;}
        PString className(wrapper_getClassName(classConfig));
        fs << "//Check function (used by data stream)\n";
        fs << "bool "+className+"_check(std::string & error, const "+className+" & obj);\n";
        
        fs << "//PhoenixDataStream interface\n";
        fs << "PyObject * "+className+"_fromBytes(PyObject *self, PyObject *args);\n";
        fs << "size_t "+className+"_fromMessage("+className+" & obj, DataStreamIter & iter);\n\n";
        
        fs << "PyObject * "+className+"_toBytes(PyObject *self, PyObject *args);\n";
        fs << "size_t "+className+"_toMessage("+className+" & obj, DataStreamIter & iter);\n\n";
        
        fs << "PyObject * "+className+"_getSizeInByte(PyObject *self, PyObject *args);\n";
        fs << "size_t "+className+"_getSize("+className+" & obj);\n\n";
        if(!classConfig.getIsEnum()){
                const PVecClassAttribute & vecAttr = classConfig.getListAttribute();
                fs << "//PhoenixDataStream interface under the hood for all attributes\n";
                for(PVecClassAttribute::const_iterator it(vecAttr.begin()); it != vecAttr.end(); ++it){
                        fs << "//PhoenixDataStream interface under the hood for " + it->getName() + " attribute\n";
                        fs << "bool "+className+"_" + it->getName() + "_fromMessage("+className+" & self, DataStreamIter &iter);\n";
                        fs << "bool "+className+"_" + it->getName() + "_toMessage("+className+" & self, DataStreamIter &iter);\n";
                        fs << "size_t "+className+"_" + it->getName() + "_getSize("+className+" & self);\n\n";
                }
        }
}

References GeneratorMode::enableDataStream, PClassConfig::getIsEnum(), PClassConfig::getListAttribute(), and wrapper_getClassName().

Here is the call graph for this function:

classMethodImplementation()

void WrapperTraitDataStream::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 572 of file WrapperTraitDataStream.cpp.

                                                                                                                                          {
        if(!mode.enableDataStream){return;}
        PString className(wrapper_getClassName(classConfig));
        data_stream_trait_wrapper_classImplCheck(fs, classConfig, mode.moduleName);
        data_stream_trait_wrapper_classPythonFromBytes(fs, classConfig, className);
        data_stream_trait_wrapper_classPythonToBytes(fs, classConfig, className);
        data_stream_trait_wrapper_classPythonGetSizeInBytes(fs, classConfig, className);
        if(!classConfig.getIsEnum()){
                const PVecClassAttribute & vecAttr = classConfig.getListAttribute();
                for(PVecClassAttribute::const_iterator it(vecAttr.begin()); it != vecAttr.end(); ++it){
                        data_stream_trait_wrapper_classAttributeFromMessage(fs, className, *it);
                        data_stream_trait_wrapper_classAttributeToMessage(fs, className, *it);
                        data_stream_trait_wrapper_classAttributeGetSize(fs, className, *it);
                }
        }
}

References data_stream_trait_wrapper_classAttributeFromMessage(), data_stream_trait_wrapper_classAttributeGetSize(), data_stream_trait_wrapper_classAttributeToMessage(), data_stream_trait_wrapper_classImplCheck(), data_stream_trait_wrapper_classPythonFromBytes(), data_stream_trait_wrapper_classPythonGetSizeInBytes(), data_stream_trait_wrapper_classPythonToBytes(), GeneratorMode::enableDataStream, PClassConfig::getIsEnum(), PClassConfig::getListAttribute(), GeneratorMode::moduleName, and wrapper_getClassName().

Here is the call graph for this function:

headerExtraInclude()

void WrapperTraitDataStream::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 530 of file WrapperTraitDataStream.cpp.

                                                                                                 {
        if(!mode.enableDataStream){return;}
        fs << "#include \"phoenix_data_stream.h\"" << std::endl;
}

References GeneratorMode::enableDataStream.

registerClassGetterSetter()

void WrapperTraitDataStream::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 594 of file WrapperTraitDataStream.cpp.

                                                                                                                                          {
        if(!mode.enableDataStream){return;}
        
}

References GeneratorMode::enableDataStream.

registerClassMember()

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

inlinevirtualinherited

Reimplemented in WrapperTraitEmpty, WrapperTraitGetterSetter, and WrapperTraitTypeStream.

Definition at line 53 of file PAbstractTraitBackend.h.

{}

registerClassMethod()

void WrapperTraitDataStream::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 604 of file WrapperTraitDataStream.cpp.

                                                                                                                                    {
        if(!mode.enableDataStream){return;}
        PString className(wrapper_getClassName(classConfig));
        fs << "\t{\"fromBytes\", (PyCFunction)"<<className<<"_fromBytes,  METH_VARARGS, \"Doc : load a "<<className<<" from PyByteArray\"},\n";
        fs << "\t{\"toBytes\", (PyCFunction)"<<className<<"_toBytes,  METH_NOARGS, \"Doc : convert a "<<className<<" to PyByteArray\"},\n";
        fs << "\t{\"getSize\", (PyCFunction)"<<className<<"_getSizeInByte,  METH_NOARGS, \"Doc : Get the size of "<<className<<" in bytes\"},\n";
}

References GeneratorMode::enableDataStream, and wrapper_getClassName().

Here is the call graph for this function:

setupAddDependency()

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

virtual

Add dependency in the setup.py.

Parameters

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

Reimplemented from PAbstractWrapperTraitBackend.

Definition at line 654 of file WrapperTraitDataStream.cpp.

                                                                                                 {
        if(!mode.enableTypeStream){return;}
        fs << "addWrapperDependency(listIncludeDir, listLibDir, listLib, \"phoenixdatastream-config\", [\"phoenix_data_stream\"])" << std::endl;
}

References GeneratorMode::enableTypeStream.

testCallFunction()

void WrapperTraitDataStream::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 645 of file WrapperTraitDataStream.cpp.

                                                                                                                                 {
        if(!mode.enableDataStream){return;}
        
}

References GeneratorMode::enableDataStream.

testFunction()

void WrapperTraitDataStream::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 617 of file WrapperTraitDataStream.cpp.

                                                                                                                             {
        if(!mode.enableDataStream || classConfig.getIsEnum()){return;}
        PString className(classConfig.getName()), moduleName(mode.moduleName);
        fs << "#Unit Test of the " + className + "\n";
        fs << "def test_datastream_"+className+"():\n";
        fs << "\t#Let's test the stream now\n";
        fs << "\tshadok = "+moduleName+"."+className+"()\n";
        const std::vector<PClassAttribute> & vecAttr = classConfig.getListAttribute();
        for(std::vector<PClassAttribute>::const_iterator it(vecAttr.begin()); it != vecAttr.end(); ++it){
                fs << pythonDefaultTestValue("shadok", *it, moduleName, "\t", mode.mapClass);
        }
        fs << "\tstream = shadok.toBytes()\n";
        fs << "\tassert len(stream) != 0\n";
        fs << "\t\n";
        fs << "\tother = "+moduleName+"."+className+"()\n";
        fs << "\tother.fromBytes(stream)\n";
        for(std::vector<PClassAttribute>::const_iterator it(vecAttr.begin()); it != vecAttr.end(); ++it){
                fs << pythonAssertTestValue("other", *it, moduleName, "\t", mode.mapClass);
        }
        fs << "\t\n";
        fs << "\t\n";
}

References GeneratorMode::enableDataStream, PClassConfig::getIsEnum(), PClassConfig::getListAttribute(), PClassConfig::getName(), GeneratorMode::mapClass, GeneratorMode::moduleName, pythonAssertTestValue(), and pythonDefaultTestValue().

Here is the call graph for this function:

---

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

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