Class to describe a basic class. More...

#include <PClassConfig.h>

Public Member Functions
void	addAttribute (const PClassAttribute &attribute)
	Adds an attribute to the class.

void	addListAttribute (const std::vector< PClassAttribute > &listAttribute)
	Adds a list of attributes to the class.

void	addListParentClass (const PVecString &listParentClass)
	Add a parent classes to the PClassConfig.

void	addListTemplate (const PVecString &listTemplate)
	Add a template to the PClassConfig.

void	addParentClass (const PString &parentClass)
	Add a parent class to the PClassConfig.

void	addTemplate (const PString &defTemplate)
	Add a template to the PClassConfig.

PString &	getClassDocumentation ()
	Returns the class documentation.

const PString &	getClassDocumentation () const
	Returns the class documentation.

bool	getIsEnum () const
	Say if the current PClassConfig is an enum.

std::vector< PClassAttribute > &	getListAttribute ()
	Returns the list of attributes of the class.

const std::vector< PClassAttribute > &	getListAttribute () const
	Returns the list of attributes of the class.

PVecString &	getListParentClass ()
	Returns the list of the parents of the class.

const PVecString &	getListParentClass () const
	Returns the list of the parents of the class.

PVecString &	getListTemplate ()
	Returns the list of the template of the class.

const PVecString &	getListTemplate () const
	Returns the list of the template of the class.

PString &	getName ()
	Returns the class name.

const PString &	getName () const
	Returns the class name.

PClassConfig &	operator= (const PClassConfig &other)
	Definition of equal operator of PClassConfig.

	PClassConfig ()
	Default constructeur of PClassConfig.

	PClassConfig (const PClassConfig &other)
	Copy constructor of PClassConfig.

void	setClassDocumentation (const PString &classDocumentation)
	Sets the class documentation.

void	setIsEnum (bool isEnum)
	Set if the current PClassConfig is an enum.

void	setListAttribute (const std::vector< PClassAttribute > &listAttribute)
	Sets the list of attributes of the class.

void	setListTemplate (const PVecString &listTemplate)
	Sets the list of template of the class.

void	setName (const PString &name)
	Sets the class name.

virtual	~PClassConfig ()
	Destructeur of PClassConfig.

Protected Member Functions
void	copyPClassConfig (const PClassConfig &other)
	Copy function of PClassConfig.

Private Member Functions
void	initialisationPClassConfig ()
	Initialisation function of the class PClassConfig.

Private Attributes
PString	p_classDocumentation
	Class documentation.

bool	p_isEnum
	True if it is an enum.

std::vector< PClassAttribute >	p_listAttribute
	List of the attribute of the class.

PVecString	p_listParentClass
	List of the parent classes of the current class.

PVecString	p_listTemplate
	List of the template definition of the current class.

PString	p_name
	Name of the class.

Detailed Description

Class to describe a basic class.

Definition at line 14 of file PClassConfig.h.

Constructor & Destructor Documentation

◆ PClassConfig() [1/2]

PClassConfig::PClassConfig ( )

Default constructeur of PClassConfig.

Definition at line 11 of file PClassConfig.cpp.

                          {
        initialisationPClassConfig();
}

References initialisationPClassConfig().

Referenced by copyPClassConfig(), operator=(), and PClassConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PClassConfig() [2/2]

PClassConfig::PClassConfig ( const PClassConfig & other )

Copy constructor of PClassConfig.

Parameters

other : class to copy

Definition at line 18 of file PClassConfig.cpp.

                                                    {
        copyPClassConfig(other);
}

References copyPClassConfig(), and PClassConfig().

Here is the call graph for this function:

◆ ~PClassConfig()

PClassConfig::~PClassConfig ( )

virtual

Destructeur of PClassConfig.

Definition at line 23 of file PClassConfig.cpp.

                           {
        
}

Member Function Documentation

◆ addAttribute()

void PClassConfig::addAttribute ( const PClassAttribute & attribute )

Adds an attribute to the class.

Parameters

attribute : attribute to add to the class

Definition at line 67 of file PClassConfig.cpp.

                                                                {
        p_listAttribute.push_back(attribute);
}

References p_listAttribute.

Referenced by addListAttribute(), parseClassConfigAttribut(), and parseEnumValue().

Here is the caller graph for this function:

◆ addListAttribute()

void PClassConfig::addListAttribute ( const std::vector< PClassAttribute > & listAttribute )

Adds a list of attributes to the class.

Parameters

listAttribute : list of attributes to add to the class

Definition at line 74 of file PClassConfig.cpp.

                                                                                   {
        for(std::vector<PClassAttribute>::const_iterator it(listAttribute.begin()); it != listAttribute.end(); ++it){
                addAttribute(*it);
        }
}

References addAttribute().

Here is the call graph for this function:

◆ addListParentClass()

void PClassConfig::addListParentClass ( const PVecString & listParentClass )

Add a parent classes to the PClassConfig.

Parameters

listParentClass : list of parent classes we want to add in the PClassConfig

Definition at line 90 of file PClassConfig.cpp.

                                                                       {
        for(PVecString::const_iterator it(listParentClass.begin()); it != listParentClass.end(); ++it){
                addParentClass(*it);
        }
}

References addParentClass().

Here is the call graph for this function:

◆ addListTemplate()

void PClassConfig::addListTemplate ( const PVecString & listTemplate )

Add a template to the PClassConfig.

Parameters

listTemplate : list of templates we want to add in the PClassConfig

Definition at line 106 of file PClassConfig.cpp.

                                                                 {
        for(PVecString::const_iterator it(listTemplate.begin()); it != listTemplate.end(); ++it){
                addTemplate(*it);
        }
}

References addTemplate().

Here is the call graph for this function:

◆ addParentClass()

void PClassConfig::addParentClass ( const PString & parentClass )

Add a parent class to the PClassConfig.

Parameters

parentClass : parent class we want to add in the PClassConfig

Definition at line 83 of file PClassConfig.cpp.

                                                            {
        p_listParentClass.push_back(parentClass);
}

References p_listParentClass.

Referenced by addListParentClass(), and parseParentOfClassConfig().

Here is the caller graph for this function:

◆ addTemplate()

void PClassConfig::addTemplate ( const PString & defTemplate )

Add a template to the PClassConfig.

Parameters

defTemplate : template we want to add in the PClassConfig

Definition at line 99 of file PClassConfig.cpp.

                                                         {
        p_listTemplate.push_back(defTemplate);
}

References p_listTemplate.

Referenced by addListTemplate().

Here is the caller graph for this function:

◆ copyPClassConfig()

void PClassConfig::copyPClassConfig ( const PClassConfig & other )

protected

Copy function of PClassConfig.

Parameters

other : class to copy

Definition at line 177 of file PClassConfig.cpp.

                                                             {
        p_listAttribute = other.p_listAttribute;
        p_name = other.p_name;
        p_classDocumentation = other.p_classDocumentation;
        p_listParentClass = other.p_listParentClass;
        p_listTemplate = other.p_listTemplate;
        p_isEnum = other.p_isEnum;
}

References p_classDocumentation, p_isEnum, p_listAttribute, p_listParentClass, p_listTemplate, p_name, and PClassConfig().

Referenced by operator=(), and PClassConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClassDocumentation() [1/2]

PString & PClassConfig::getClassDocumentation ( )

Returns the class documentation.

Returns: class documentation

Definition at line 137 of file PClassConfig.cpp.

137{return p_classDocumentation;}

References p_classDocumentation.

◆ getClassDocumentation() [2/2]

const PString & PClassConfig::getClassDocumentation ( ) const

Returns the class documentation.

Returns: class documentation

Definition at line 132 of file PClassConfig.cpp.

132{return p_classDocumentation;}

References p_classDocumentation.

Referenced by generator_class_cpp_header(), generator_enum_cpp_header(), project_wrapper_classImplPythonType(), and wrapper_generator_class_header().

Here is the caller graph for this function:

◆ getIsEnum()

bool PClassConfig::getIsEnum ( ) const

Say if the current PClassConfig is an enum.

Returns: true if the current PClassConfig is an enum, false otherwise

Definition at line 172 of file PClassConfig.cpp.

172{return p_isEnum;}

References p_isEnum.

Referenced by CppTraitCheckStream::classExtraFunctionDeclaration(), CppTraitDataStream::classExtraFunctionDeclaration(), CppTraitFromString::classExtraFunctionDeclaration(), CppTraitTypeStream::classExtraFunctionDeclaration(), CppTraitCheckStream::classExtraFunctionImplementation(), CppTraitConfigStream::classExtraFunctionImplementation(), CppTraitFromString::classExtraFunctionImplementation(), CppTraitTypeStream::classExtraFunctionImplementation(), WrapperTraitDataStream::classMethodDeclaration(), WrapperTraitGetterSetter::classMethodDeclaration(), WrapperTraitDataStream::classMethodImplementation(), WrapperTraitGetterSetter::classMethodImplementation(), data_stream_trait_wrapper_classImplCheck(), data_stream_trait_wrapper_classPythonFromBytes(), data_stream_trait_wrapper_classPythonGetSizeInBytes(), data_stream_trait_wrapper_classPythonToBytes(), generator_class_cpp_source(), project_wrapper_classTest(), CppTraitCopy::protectedMethodDeclaration(), CppTraitCopy::protectedMethodImplementation(), CppTraitCopy::publicMethodDeclaration(), CppTraitDataStream::publicMethodDeclaration(), CppTraitGetter::publicMethodDeclaration(), CppTraitSetter::publicMethodDeclaration(), CppTraitCopy::publicMethodImplementation(), CppTraitGetter::publicMethodImplementation(), CppTraitSetter::publicMethodImplementation(), CppTraitCopy::testCallFunction(), CppTraitFromString::testCallFunction(), CppTraitCopy::testFunction(), CppTraitFromString::testFunction(), CppTraitTypeStream::testFunction(), and WrapperTraitDataStream::testFunction().

Here is the caller graph for this function:

◆ getListAttribute() [1/2]

std::vector< PClassAttribute > & PClassConfig::getListAttribute ( )

Returns the list of attributes of the class.

Returns: list of attributes of the class

Definition at line 147 of file PClassConfig.cpp.

147{return p_listAttribute;}

References p_listAttribute.

◆ getListAttribute() [2/2]

const std::vector< PClassAttribute > & PClassConfig::getListAttribute ( ) const

Returns the list of attributes of the class.

Returns: list of attributes of the class

Definition at line 142 of file PClassConfig.cpp.

142{return p_listAttribute;}

References p_listAttribute.

Referenced by class_createCheckClassEquality(), class_createTestClassCopy(), class_saveClassInitialisationFunctionImpl(), CppTraitCheckStream::classExtraFunctionDeclaration(), CppTraitCheckStream::classExtraFunctionImplementation(), CppTraitConfigStream::classExtraFunctionImplementation(), CppTraitFromString::classExtraFunctionImplementation(), WrapperTraitDataStream::classMethodDeclaration(), WrapperTraitGetterSetter::classMethodDeclaration(), WrapperTraitDataStream::classMethodImplementation(), WrapperTraitGetterSetter::classMethodImplementation(), data_stream_trait_wrapper_classImplCheck(), data_stream_trait_wrapper_classPythonFromBytes(), data_stream_trait_wrapper_classPythonGetSizeInBytes(), data_stream_trait_wrapper_classPythonToBytes(), generator_class_cpp_header(), generator_enum_cpp_header(), project_wrapper_enumImplNewc(), CppTraitCopy::protectedMethodImplementation(), CppTraitDataStream::publicMethodDeclaration(), CppTraitGetter::publicMethodDeclaration(), CppTraitSetter::publicMethodDeclaration(), CppTraitGetter::publicMethodImplementation(), CppTraitSetter::publicMethodImplementation(), WrapperTraitGetterSetter::registerClassGetterSetter(), WrapperTraitGetterSetter::registerClassMember(), CppTraitFromString::testFunction(), WrapperTraitDataStream::testFunction(), wrapper_generator_class_header(), wrapper_generator_class_implDealloc(), and wrapper_generator_class_implNewc().

Here is the caller graph for this function:

◆ getListParentClass() [1/2]

PVecString & PClassConfig::getListParentClass ( )

Returns the list of the parents of the class.

Returns: list of the parents of the class

Definition at line 157 of file PClassConfig.cpp.

157{return p_listParentClass;}

References p_listParentClass.

◆ getListParentClass() [2/2]

const PVecString & PClassConfig::getListParentClass ( ) const

Returns the list of the parents of the class.

Returns: list of the parents of the class

Definition at line 152 of file PClassConfig.cpp.

152{return p_listParentClass;}

References p_listParentClass.

Referenced by class_saveClassConstructorImpl(), and generator_class_cpp_header().

Here is the caller graph for this function:

◆ getListTemplate() [1/2]

PVecString & PClassConfig::getListTemplate ( )

Returns the list of the template of the class.

Returns: list of the template of the class

Definition at line 167 of file PClassConfig.cpp.

167{return p_listTemplate;}

References p_listTemplate.

◆ getListTemplate() [2/2]

const PVecString & PClassConfig::getListTemplate ( ) const

Returns the list of the template of the class.

Returns: list of the template of the class

Definition at line 162 of file PClassConfig.cpp.

162{return p_listTemplate;}

References p_listTemplate.

Referenced by CppTraitCheckStream::classExtraFunctionDeclaration(), CppTraitTypeStream::classExtraFunctionDeclaration(), CppTraitCheckStream::classExtraFunctionImplementation(), CppTraitConfigStream::classExtraFunctionImplementation(), CppTraitTypeStream::classExtraFunctionImplementation(), generator_class_cpp_header(), and generator_class_cpp_source().

Here is the caller graph for this function:

◆ getName() [1/2]

PString & PClassConfig::getName ( )

Returns the class name.

Returns: class name

Definition at line 127 of file PClassConfig.cpp.

127{return p_name;}

References p_name.

◆ getName() [2/2]

const PString & PClassConfig::getName ( ) const

Returns the class name.

Returns: class name

Definition at line 122 of file PClassConfig.cpp.

122{return p_name;}

References p_name.

Referenced by class_createCheckClassEquality(), class_createTestClassCopy(), class_saveClassConstructorImpl(), class_saveClassDestructorImpl(), class_saveClassInitialisationFunctionImpl(), CppTraitCheckStream::classExtraFunctionDeclaration(), CppTraitConfigStream::classExtraFunctionDeclaration(), CppTraitDataStream::classExtraFunctionDeclaration(), CppTraitFromString::classExtraFunctionDeclaration(), CppTraitTypeStream::classExtraFunctionDeclaration(), CppTraitCheckStream::classExtraFunctionImplementation(), CppTraitConfigStream::classExtraFunctionImplementation(), CppTraitFromString::classExtraFunctionImplementation(), CppTraitTypeStream::classExtraFunctionImplementation(), WrapperTraitTypeStream::classMethodImplementation(), generator_class_cpp_header(), generator_class_test(), generator_class_testCMakeLists(), generator_enum_cpp_header(), parsePClassConfig(), project_wrapper_classImplPythonType(), project_wrapper_classTest(), project_wrapper_enumImplNewc(), CppTraitCopy::protectedMethodDeclaration(), CppTraitCopy::protectedMethodImplementation(), CppTraitCopy::publicMethodDeclaration(), CppTraitDataStream::publicMethodDeclaration(), CppTraitCopy::publicMethodImplementation(), CppTraitGetter::publicMethodImplementation(), CppTraitSetter::publicMethodImplementation(), CppTraitCopy::testCallFunction(), CppTraitFromString::testCallFunction(), CppTraitTypeStream::testCallFunction(), WrapperTraitTypeStream::testCallFunction(), CppTraitFromString::testFunction(), CppTraitTypeStream::testFunction(), WrapperTraitDataStream::testFunction(), WrapperTraitTypeStream::testFunction(), wrapper_generator_class_implDealloc(), wrapper_generator_class_implNewc(), and wrapper_getClassName().

Here is the caller graph for this function:

◆ initialisationPClassConfig()

void PClassConfig::initialisationPClassConfig ( )

private

Initialisation function of the class PClassConfig.

Definition at line 187 of file PClassConfig.cpp.

                                             {
        p_isEnum = false;
}

References p_isEnum.

Referenced by PClassConfig().

Here is the caller graph for this function:

◆ operator=()

PClassConfig & PClassConfig::operator= ( const PClassConfig & other )

Definition of equal operator of PClassConfig.

Parameters

other : class to copy

Returns: copied class

Definition at line 31 of file PClassConfig.cpp.

                                                                  {
        copyPClassConfig(other);
        return *this;
}

References copyPClassConfig(), and PClassConfig().

Here is the call graph for this function:

◆ setClassDocumentation()

void PClassConfig::setClassDocumentation ( const PString & classDocumentation )

Sets the class documentation.

Parameters

classDocumentation : class documentation

Definition at line 39 of file PClassConfig.cpp.

                                                                          {
        p_classDocumentation = classDocumentation;
}

References p_classDocumentation.

Referenced by parseEnumConfig(), and parsePClassConfig().

Here is the caller graph for this function:

◆ setIsEnum()

void PClassConfig::setIsEnum ( bool isEnum )

Set if the current PClassConfig is an enum.

Parameters

isEnum : true if the current PClassConfig is an enum

Definition at line 115 of file PClassConfig.cpp.

                                       {
        p_isEnum = isEnum;
}

References p_isEnum.

Referenced by parseEnumConfig().

Here is the caller graph for this function:

◆ setListAttribute()

void PClassConfig::setListAttribute ( const std::vector< PClassAttribute > & listAttribute )

Sets the list of attributes of the class.

Parameters

listAttribute : list of the attributes of the class

Definition at line 53 of file PClassConfig.cpp.

                                                                                   {
        p_listAttribute = listAttribute;
}

References p_listAttribute.

◆ setListTemplate()

void PClassConfig::setListTemplate ( const PVecString & listTemplate )

Sets the list of template of the class.

Parameters

listTemplate : list of the template of the class

Definition at line 60 of file PClassConfig.cpp.

                                                                 {
        p_listTemplate = listTemplate;
}

References p_listTemplate.

Referenced by parsePClassConfig().

Here is the caller graph for this function:

◆ setName()

void PClassConfig::setName ( const PString & name )

Sets the class name.

Parameters

name	: name of the class

Definition at line 46 of file PClassConfig.cpp.

                                              {
        p_name = name;
}

References p_name.

Referenced by parseEnumConfig(), and parsePClassConfig().

Here is the caller graph for this function:

Member Data Documentation

◆ p_classDocumentation

PString PClassConfig::p_classDocumentation

private

Class documentation.

Definition at line 53 of file PClassConfig.h.

Referenced by copyPClassConfig(), getClassDocumentation(), getClassDocumentation(), and setClassDocumentation().

◆ p_isEnum

bool PClassConfig::p_isEnum

private

True if it is an enum.

Definition at line 63 of file PClassConfig.h.

Referenced by copyPClassConfig(), getIsEnum(), initialisationPClassConfig(), and setIsEnum().

◆ p_listAttribute

std::vector<PClassAttribute> PClassConfig::p_listAttribute

private

List of the attribute of the class.

Definition at line 57 of file PClassConfig.h.

Referenced by addAttribute(), copyPClassConfig(), getListAttribute(), getListAttribute(), and setListAttribute().

◆ p_listParentClass

PVecString PClassConfig::p_listParentClass

private

List of the parent classes of the current class.

Definition at line 59 of file PClassConfig.h.

Referenced by addParentClass(), copyPClassConfig(), getListParentClass(), and getListParentClass().

◆ p_listTemplate

PVecString PClassConfig::p_listTemplate

private

List of the template definition of the current class.

Definition at line 61 of file PClassConfig.h.

Referenced by addTemplate(), copyPClassConfig(), getListTemplate(), getListTemplate(), and setListTemplate().

◆ p_name

PString PClassConfig::p_name

private

Name of the class.

Definition at line 55 of file PClassConfig.h.

Referenced by copyPClassConfig(), getName(), getName(), and setName().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/code-generator/PhoenixGenerator/src/Representation/PClassConfig.h
/builds/CTA-LAPP/PHOENIX_LIBS2/code-generator/PhoenixGenerator/src/Representation/PClassConfig.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PClassConfig() [1/2]

◆ PClassConfig() [2/2]

◆ ~PClassConfig()

Member Function Documentation

◆ addAttribute()

◆ addListAttribute()

◆ addListParentClass()

◆ addListTemplate()

◆ addParentClass()

◆ addTemplate()

◆ copyPClassConfig()

◆ getClassDocumentation() [1/2]

◆ getClassDocumentation() [2/2]

◆ getIsEnum()

◆ getListAttribute() [1/2]

◆ getListAttribute() [2/2]

◆ getListParentClass() [1/2]

◆ getListParentClass() [2/2]

◆ getListTemplate() [1/2]

◆ getListTemplate() [2/2]

◆ getName() [1/2]

◆ getName() [2/2]

◆ initialisationPClassConfig()

◆ operator=()

◆ setClassDocumentation()

◆ setIsEnum()

◆ setListAttribute()

◆ setListTemplate()

◆ setName()

Member Data Documentation

◆ p_classDocumentation

◆ p_isEnum

◆ p_listAttribute

◆ p_listParentClass

◆ p_listTemplate

◆ p_name