NanobindTraitDataStream Class Reference

Class generator for Nanobind property trait. More...

#include <NanobindTraitDataStream.h>

Inheritance diagram for NanobindTraitDataStream:

Collaboration diagram for NanobindTraitDataStream:

Public Member Functions
virtual void	headerExtraInclude (std::set< std::string > &includes, const PClassConfig &classConfig, const GeneratorMode &mode) const
virtual void	headerTestInclude (std::ofstream &fs, const GeneratorMode &mode, const PString &baseFileName) const
	NanobindTraitDataStream ()
	Constructor of NanobindTraitDataStream.
virtual void	registerConstructor (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
virtual void	registerMethod (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
virtual void	registerProperty (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
virtual void	registerStaticMethod (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
virtual void	testCallFunction (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode) const
virtual void	testFunction (std::ofstream &fs, const PClassConfig &classConfig, const GeneratorMode &mode, const PString &baseFileName) const
virtual	~NanobindTraitDataStream ()
	Destructor of NanobindTraitDataStream.

Detailed Description

Class generator for Nanobind property trait.

Definition at line 15 of file NanobindTraitDataStream.h.

Constructor & Destructor Documentation

NanobindTraitDataStream()

NanobindTraitDataStream::NanobindTraitDataStream

(

)

Constructor of NanobindTraitDataStream.

Definition at line 10 of file NanobindTraitDataStream.cpp.

: PAbstractNanobindTraitBackend()
{}

References PAbstractNanobindTraitBackend::PAbstractNanobindTraitBackend().

Here is the call graph for this function:

~NanobindTraitDataStream()

NanobindTraitDataStream::~NanobindTraitDataStream ( )

virtual

Destructor of NanobindTraitDataStream.

Definition at line 15 of file NanobindTraitDataStream.cpp.

{}

Member Function Documentation

headerExtraInclude()

virtual void PAbstractNanobindTraitBackend::headerExtraInclude ( std::set< std::string > & includes, const PClassConfig & classConfig, const GeneratorMode & mode ) const

inlinevirtualinherited

Reimplemented in NanobindTraitInclude.

Definition at line 70 of file PAbstractTraitBackend.h.

{}

headerTestInclude()

virtual void PAbstractNanobindTraitBackend::headerTestInclude ( std::ofstream & fs, const GeneratorMode & mode, const PString & baseFileName ) const

inlinevirtualinherited

Reimplemented in NanobindTraitTestSetup.

Definition at line 71 of file PAbstractTraitBackend.h.

{}

registerConstructor()

virtual void PAbstractNanobindTraitBackend::registerConstructor ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

inlinevirtualinherited

Reimplemented in NanobindTraitMethod.

Definition at line 76 of file PAbstractTraitBackend.h.

{}

registerMethod()

void NanobindTraitDataStream::registerMethod ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

virtual

Registration of static method

Parameters

fs	stream to write to
classConfig	config of the class
mode	generator mode

Reimplemented from PAbstractNanobindTraitBackend.

Definition at line 86 of file NanobindTraitDataStream.cpp.

                                                                                                                                {
        if(!mode.enableDataStream){return;}
        PString name(classConfig.getName());
 
        registerSerializationMethods(fs, classConfig, mode);
        registerDeserializationMethods(fs, classConfig, mode);
        registerSizeMethod(fs, classConfig, mode);
}

References GeneratorMode::enableDataStream, PClassConfig::getName(), registerDeserializationMethods(), registerSerializationMethods(), and registerSizeMethod().

Here is the call graph for this function:

registerProperty()

virtual void PAbstractNanobindTraitBackend::registerProperty ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

inlinevirtualinherited

Reimplemented in NanobindTraitProperty.

Definition at line 73 of file PAbstractTraitBackend.h.

{}

registerStaticMethod()

virtual void PAbstractNanobindTraitBackend::registerStaticMethod ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode ) const

inlinevirtualinherited

Reimplemented in NanobindTraitCheckStream, and NanobindTraitTypeStream.

Definition at line 74 of file PAbstractTraitBackend.h.

{}

testCallFunction()

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

virtual

Generation of unit test call function

Parameters

fs	stream to write to
classConfig	config of the class
mode	generator mode

Reimplemented from PAbstractNanobindTraitBackend.

Definition at line 184 of file NanobindTraitDataStream.cpp.

                                                                                                                                  {
        if(!mode.enableDataStream){return;}
        PString name(classConfig.getName());
        fs << "\ttest_data_stream_conversion()" << std::endl;
        fs << "\ttest_serialization_type_errors()" << std::endl;
}

References GeneratorMode::enableDataStream, and PClassConfig::getName().

Here is the call graph for this function:

testFunction()

void NanobindTraitDataStream::testFunction ( std::ofstream & fs, const PClassConfig & classConfig, const GeneratorMode & mode, const PString & baseFileName ) const

virtual

Generation of unit test function

Parameters

fs	stream to write to
classConfig	config of the class
mode	generator mode
baseFileName	: base name of the configuration

Test base serialization/deserialization

Test edge cases for serialization/deserialization

Reimplemented from PAbstractNanobindTraitBackend.

Definition at line 118 of file NanobindTraitDataStream.cpp.

                                                                                                                                                            {
        if(!mode.enableDataStream){return;}
        PString name(classConfig.getName());
        PString moduleName = baseFileName.toLower();
        fs << "def test_data_stream_conversion():" << std::endl;
        fs << "\t\"\"\"Test data stream conversion\"\"\"" << std::endl;
        
        const PVecClassAttribute & listAttr(classConfig.getListAttribute());
        if(classConfig.getIsEnum()){
                if(listAttr.size() != 0lu){
                        fs << "\ttest_value1 = " << moduleName << "." << name << "." << listAttr.front().getName() << std::endl;
                }
                fs << "\tdata_stream = test_value1.to_bytes()" << std::endl;
                fs << "\tassert data_stream == bytearray(b'\\x00\\x00\\x00\\x00')" << std::endl;
                fs << "\ttest_value2 = " << moduleName << "." << name << ".from_bytes(data_stream)" << std::endl;
                fs << std::endl;
                fs << "\tassert test_value1.get_size() == 4" << std::endl;
                fs << "\tassert test_value1 == test_value2" << std::endl;
                fs << std::endl;
        }else{
                fs << "\t" << name.toLower() << " = " << moduleName << "." << name << "()" << std::endl;
                fs << "\t# Set some example values" << std::endl;
                for(PVecClassAttribute::const_iterator it(listAttr.begin()); it != listAttr.end(); ++it){
                        PString defaultValue = getTestDefaultValueTypeInPython(it->getType());
                        if(defaultValue != ""){
                                fs << "\t" << name.toLower() << "." << it->getName() << " = " << defaultValue << std::endl;
                        }
                }
                fs << std::endl;
                fs << "\tdata_stream = " << name.toLower() << ".to_bytes()" << std::endl;
                fs << std::endl;
                fs << "\tnew_" << name.toLower() << " = " << moduleName << "." << name << "()" << std::endl;
                fs << "\tnew_" << name.toLower() << " = " << moduleName << "." << name << ".from_bytes(data_stream)" << std::endl;
                fs << std::endl;
                for(PVecClassAttribute::const_iterator it(listAttr.begin()); it != listAttr.end(); ++it){
                        PString defaultValue = getTestDefaultValueTypeInPython(it->getType());
                        if(defaultValue != ""){
                                fs << "\tassert new_" << name.toLower() << "." << it->getName() << " == " << defaultValue << std::endl;
                        }
                }
                fs << std::endl;
                fs << "def test_serialization_type_errors():" << std::endl;
                fs << "\t\"\"\"Test erro types for from_bytes\"\"\"" << std::endl;
                fs << std::endl;
                fs << "\t" << name.toLower() << " = " << moduleName << "." << name << "()" << std::endl;
                fs << "\twith pytest.raises(TypeError, match=\".*from_bytes\\(\\): incompatible function arguments.*\"):" << std::endl;
                fs << "\t\tresult = " << name.toLower() << ".from_bytes(\"A string is not a bytearray !!!\")  # deserialize string instead of bytearray" << std::endl;
                fs << std::endl;
                fs << "\twith pytest.raises(TypeError, match=\".*from_bytes\\(\\): incompatible function arguments.*\"):" << std::endl;
                fs << "\t\tresult = " << name.toLower() << ".from_bytes(42)  #  deserialize instead of bytearray" << std::endl;
                fs << std::endl;
                fs << "\twith pytest.raises(TypeError, match=\".*from_bytes\\(\\): incompatible function arguments.*\"):" << std::endl;
                fs << "\t\tresult = " << name.toLower() << ".from_bytes([1, 2, 3, 4])  # deserialize list instead of bytearray" << std::endl;
                fs << std::endl;
        }
        if(classConfig.getIsEnum()){
                failed_enum_deserialization(fs, classConfig, mode, baseFileName);
        }
}

References GeneratorMode::enableDataStream, failed_enum_deserialization(), PClassConfig::getIsEnum(), PClassConfig::getListAttribute(), PClassConfig::getName(), and getTestDefaultValueTypeInPython().

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/Nanobind/NanobindTraitDataStream/NanobindTraitDataStream.h
• /builds/CTA-LAPP/PHOENIX_LIBS2/code-generator/PhoenixGenerator/src/TraitBackEnd/Nanobind/NanobindTraitDataStream/NanobindTraitDataStream.cpp