Describes a class attribute. More...

#include <PClassAttribute.h>

Public Member Functions
PString &	getDefaultValue ()
	Gets the defaultValue of the PClassAttribute.

const PString &	getDefaultValue () const
	Gets the defaultValue of the PClassAttribute.

PString &	getDocumentation ()
	Gets the documentation of the PClassAttribute.

const PString &	getDocumentation () const
	Gets the documentation of the PClassAttribute.

bool &	getIsEnum ()
	Gets the isEnum of the PClassAttribute.

bool	getIsEnum () const
	Gets the isEnum of the PClassAttribute.

bool &	getIsPointer ()
	Gets the isPointer of the PClassAttribute.

bool	getIsPointer () const
	Gets the isPointer of the PClassAttribute.

bool &	getIsReference ()
	Gets the isReference of the PClassAttribute.

bool	getIsReference () const
	Gets the isReference of the PClassAttribute.

PString &	getName ()
	Gets the name of the PClassAttribute.

const PString &	getName () const
	Gets the name of the PClassAttribute.

PString &	getType ()
	Gets the type of the PClassAttribute.

const PString &	getType () const
	Gets the type of the PClassAttribute.

PClassAttribute &	operator= (const PClassAttribute &other)
	Operator = of class PClassAttribute.

	PClassAttribute ()
	Constructor of class PClassAttribute.

	PClassAttribute (const PClassAttribute &other)
	Copy Constructor of class PClassAttribute.

void	setDefaultValue (const PString &defaultValue)
	Sets the defaultValue of the PClassAttribute.

void	setDocumentation (const PString &documentation)
	Sets the documentation of the PClassAttribute.

void	setIsEnum (bool isEnum)
	Sets the isEnum of the PClassAttribute.

void	setIsPointer (bool isPointer)
	Sets the isPointer of the PClassAttribute.

void	setIsReference (bool isReference)
	Sets the isReference of the PClassAttribute.

void	setName (const PString &name)
	Sets the name of the PClassAttribute.

void	setType (const PString &type)
	Sets the type of the PClassAttribute.

virtual	~PClassAttribute ()
	Destructor of class PClassAttribute.

Protected Member Functions
void	copyPClassAttribute (const PClassAttribute &other)
	Copy Function of class PClassAttribute.

Private Member Functions
void	initialisationPClassAttribute ()
	Initialisation Function of class PClassAttribute.

Private Attributes
PString	p_defaultValue
	Default value of the attribute.

PString	p_documentation
	Documentation string.

bool	p_isEnum
	True if the PClassAttribute is an enum.

bool	p_isPointer
	true if is a pointer

bool	p_isReference
	True if it is a reference.

PString	p_name
	Name of the attribute.

PString	p_type
	Type of the attribute.

Detailed Description

Describes a class attribute.

Definition at line 13 of file PClassAttribute.h.

Constructor & Destructor Documentation

◆ PClassAttribute() [1/2]

PClassAttribute::PClassAttribute ( )

Constructor of class PClassAttribute.

Definition at line 11 of file PClassAttribute.cpp.

                                {
        initialisationPClassAttribute();
}

References initialisationPClassAttribute().

Referenced by copyPClassAttribute(), operator=(), and PClassAttribute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PClassAttribute() [2/2]

PClassAttribute::PClassAttribute ( const PClassAttribute & other )

Copy Constructor of class PClassAttribute.

Parameters

other : PClassAttribute we want ot copy

Definition at line 18 of file PClassAttribute.cpp.

                                                             {
        copyPClassAttribute(other);
}

References copyPClassAttribute(), and PClassAttribute().

Here is the call graph for this function:

◆ ~PClassAttribute()

PClassAttribute::~PClassAttribute ( )

virtual

Destructor of class PClassAttribute.

Definition at line 23 of file PClassAttribute.cpp.

                                 {
        
}

Member Function Documentation

◆ copyPClassAttribute()

void PClassAttribute::copyPClassAttribute ( const PClassAttribute & other )

protected

Copy Function of class PClassAttribute.

Parameters

other : PClassAttribute we want ot copy

Definition at line 186 of file PClassAttribute.cpp.

                                                                      {
        p_type = other.p_type;
        p_name = other.p_name;
        p_defaultValue = other.p_defaultValue;
        p_isPointer = other.p_isPointer;
        p_isReference = other.p_isReference;
        p_documentation = other.p_documentation;
        p_isEnum = other.p_isEnum;
}

References p_defaultValue, p_documentation, p_isEnum, p_isPointer, p_isReference, p_name, p_type, and PClassAttribute().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultValue() [1/2]

PString & PClassAttribute::getDefaultValue ( )

Gets the defaultValue of the PClassAttribute.

Returns: defaultValue of the PClassAttribute

Definition at line 123 of file PClassAttribute.cpp.

                                          {
        return p_defaultValue;
}

References p_defaultValue.

◆ getDefaultValue() [2/2]

const PString & PClassAttribute::getDefaultValue ( ) const

Gets the defaultValue of the PClassAttribute.

Returns: defaultValue of the PClassAttribute

Definition at line 116 of file PClassAttribute.cpp.

                                                      {
        return p_defaultValue;
}

References p_defaultValue.

◆ getDocumentation() [1/2]

PString & PClassAttribute::getDocumentation ( )

Gets the documentation of the PClassAttribute.

Returns: documentation of the PClassAttribute

Definition at line 165 of file PClassAttribute.cpp.

                                           {
        return p_documentation;
}

References p_documentation.

◆ getDocumentation() [2/2]

const PString & PClassAttribute::getDocumentation ( ) const

Gets the documentation of the PClassAttribute.

Returns: documentation of the PClassAttribute

Definition at line 158 of file PClassAttribute.cpp.

                                                       {
        return p_documentation;
}

References p_documentation.

Referenced by project_wrapper_attributeDef().

Here is the caller graph for this function:

◆ getIsEnum() [1/2]

bool & PClassAttribute::getIsEnum ( )

Gets the isEnum of the PClassAttribute.

Returns: isEnum of the PClassAttribute

Definition at line 179 of file PClassAttribute.cpp.

                                 {
        return p_isEnum;
}

References p_isEnum.

◆ getIsEnum() [2/2]

bool PClassAttribute::getIsEnum ( ) const

Gets the isEnum of the PClassAttribute.

Returns: isEnum of the PClassAttribute

Definition at line 172 of file PClassAttribute.cpp.

                                     {
        return p_isEnum;
}

References p_isEnum.

Referenced by data_stream_trait_wrapper_classAttributeFromMessage(), data_stream_trait_wrapper_classAttributeGetSize(), data_stream_trait_wrapper_classAttributeToMessage(), pythonAssertTestValue(), and pythonDefaultTestValue().

Here is the caller graph for this function:

◆ getIsPointer() [1/2]

bool & PClassAttribute::getIsPointer ( )

Gets the isPointer of the PClassAttribute.

Returns: isPointer of the PClassAttribute

Definition at line 137 of file PClassAttribute.cpp.

                                    {
        return p_isPointer;
}

References p_isPointer.

◆ getIsPointer() [2/2]

bool PClassAttribute::getIsPointer ( ) const

Gets the isPointer of the PClassAttribute.

Returns: isPointer of the PClassAttribute

Definition at line 130 of file PClassAttribute.cpp.

                                        {
        return p_isPointer;
}

References p_isPointer.

◆ getIsReference() [1/2]

bool & PClassAttribute::getIsReference ( )

Gets the isReference of the PClassAttribute.

Returns: isReference of the PClassAttribute

Definition at line 151 of file PClassAttribute.cpp.

                                      {
        return p_isReference;
}

References p_isReference.

◆ getIsReference() [2/2]

bool PClassAttribute::getIsReference ( ) const

Gets the isReference of the PClassAttribute.

Returns: isReference of the PClassAttribute

Definition at line 144 of file PClassAttribute.cpp.

                                          {
        return p_isReference;
}

References p_isReference.

◆ getName() [1/2]

PString & PClassAttribute::getName ( )

Gets the name of the PClassAttribute.

Returns: name of the PClassAttribute

Definition at line 109 of file PClassAttribute.cpp.

                                  {
        return p_name;
}

References p_name.

◆ getName() [2/2]

const PString & PClassAttribute::getName ( ) const

Gets the name of the PClassAttribute.

Returns: name of the PClassAttribute

Definition at line 102 of file PClassAttribute.cpp.

                                              {
        return p_name;
}

References p_name.

Referenced by data_stream_trait_wrapper_callAttributeCheck(), data_stream_trait_wrapper_classAttributeFromMessage(), data_stream_trait_wrapper_classAttributeGetSize(), data_stream_trait_wrapper_classAttributeToMessage(), project_wrapper_attributeDef(), pythonAssertTestValue(), and pythonDefaultTestValue().

Here is the caller graph for this function:

◆ getType() [1/2]

PString & PClassAttribute::getType ( )

Gets the type of the PClassAttribute.

Returns: type of the PClassAttribute

Definition at line 95 of file PClassAttribute.cpp.

                                  {
        return p_type;
}

References p_type.

◆ getType() [2/2]

const PString & PClassAttribute::getType ( ) const

Gets the type of the PClassAttribute.

Returns: type of the PClassAttribute

Definition at line 88 of file PClassAttribute.cpp.

                                              {
        return p_type;
}

References p_type.

Referenced by data_stream_trait_wrapper_callAttributeCheck(), data_stream_trait_wrapper_classAttributeFromMessage(), data_stream_trait_wrapper_classAttributeGetSize(), data_stream_trait_wrapper_classAttributeToMessage(), project_wrapper_attributeDef(), pythonAssertTestValue(), and pythonDefaultTestValue().

Here is the caller graph for this function:

◆ initialisationPClassAttribute()

void PClassAttribute::initialisationPClassAttribute ( )

private

Initialisation Function of class PClassAttribute.

Definition at line 197 of file PClassAttribute.cpp.

                                                   {
        p_type = "";
        p_name = "";
        p_defaultValue = "";
        p_isPointer = false;
        p_isReference = false;
        p_documentation = "";
        p_isEnum = false;
}

References p_defaultValue, p_documentation, p_isEnum, p_isPointer, p_isReference, p_name, and p_type.

Referenced by PClassAttribute().

Here is the caller graph for this function:

◆ operator=()

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

Operator = of class PClassAttribute.

Parameters

other : PClassAttribute we want ot copy

Returns: copied class PClassAttribute

Definition at line 31 of file PClassAttribute.cpp.

                                                                           {
        copyPClassAttribute(other);
        return *this;
}

References copyPClassAttribute(), and PClassAttribute().

Here is the call graph for this function:

◆ setDefaultValue()

void PClassAttribute::setDefaultValue ( const PString & defaultValue )

Sets the defaultValue of the PClassAttribute.

Parameters

defaultValue : defaultValue of the PClassAttribute

Definition at line 53 of file PClassAttribute.cpp.

                                                                 {
        p_defaultValue = defaultValue;
}

References p_defaultValue.

Referenced by parseEnumValue().

Here is the caller graph for this function:

◆ setDocumentation()

void PClassAttribute::setDocumentation ( const PString & documentation )

Sets the documentation of the PClassAttribute.

Parameters

documentation : documentation of the PClassAttribute

Definition at line 74 of file PClassAttribute.cpp.

                                                                   {
        p_documentation = documentation;
}

References p_documentation.

Referenced by createClassAttribute(), and createClassAttribute().

Here is the caller graph for this function:

◆ setIsEnum()

void PClassAttribute::setIsEnum ( bool isEnum )

Sets the isEnum of the PClassAttribute.

Parameters

isEnum : isEnum of the PClassAttribute

Definition at line 81 of file PClassAttribute.cpp.

                                          {
        p_isEnum = isEnum;
}

References p_isEnum.

◆ setIsPointer()

void PClassAttribute::setIsPointer ( bool isPointer )

Sets the isPointer of the PClassAttribute.

Parameters

isPointer : isPointer of the PClassAttribute

Definition at line 60 of file PClassAttribute.cpp.

                                                {
        p_isPointer = isPointer;
}

References p_isPointer.

Referenced by createClassAttribute().

Here is the caller graph for this function:

◆ setIsReference()

void PClassAttribute::setIsReference ( bool isReference )

Sets the isReference of the PClassAttribute.

Parameters

isReference : isReference of the PClassAttribute

Definition at line 67 of file PClassAttribute.cpp.

                                                    {
        p_isReference = isReference;
}

References p_isReference.

Referenced by createClassAttribute().

Here is the caller graph for this function:

◆ setName()

void PClassAttribute::setName ( const PString & name )

Sets the name of the PClassAttribute.

Parameters

name	: name of the PClassAttribute

Definition at line 46 of file PClassAttribute.cpp.

                                                 {
        p_name = name;
}

References p_name.

Referenced by createClassAttribute(), and createClassAttribute().

Here is the caller graph for this function:

◆ setType()

void PClassAttribute::setType ( const PString & type )

Sets the type of the PClassAttribute.

Parameters

type	: type of the PClassAttribute

Definition at line 39 of file PClassAttribute.cpp.

                                                 {
        p_type = type;
}

References p_type.

Referenced by createClassAttribute(), and createClassAttribute().

Here is the caller graph for this function:

Member Data Documentation

◆ p_defaultValue

PString PClassAttribute::p_defaultValue

private

Default value of the attribute.

Definition at line 49 of file PClassAttribute.h.

Referenced by copyPClassAttribute(), getDefaultValue(), getDefaultValue(), initialisationPClassAttribute(), and setDefaultValue().

◆ p_documentation

PString PClassAttribute::p_documentation

private

Documentation string.

Definition at line 55 of file PClassAttribute.h.

Referenced by copyPClassAttribute(), getDocumentation(), getDocumentation(), initialisationPClassAttribute(), and setDocumentation().

◆ p_isEnum

bool PClassAttribute::p_isEnum

private

True if the PClassAttribute is an enum.

Definition at line 57 of file PClassAttribute.h.

Referenced by copyPClassAttribute(), getIsEnum(), getIsEnum(), initialisationPClassAttribute(), and setIsEnum().

◆ p_isPointer

bool PClassAttribute::p_isPointer

private

true if is a pointer

Definition at line 51 of file PClassAttribute.h.

Referenced by copyPClassAttribute(), getIsPointer(), getIsPointer(), initialisationPClassAttribute(), and setIsPointer().

◆ p_isReference

bool PClassAttribute::p_isReference

private

True if it is a reference.

Definition at line 53 of file PClassAttribute.h.

Referenced by copyPClassAttribute(), getIsReference(), getIsReference(), initialisationPClassAttribute(), and setIsReference().

◆ p_name

PString PClassAttribute::p_name

private

Name of the attribute.

Definition at line 47 of file PClassAttribute.h.

Referenced by copyPClassAttribute(), getName(), getName(), initialisationPClassAttribute(), and setName().

◆ p_type

PString PClassAttribute::p_type

private

Type of the attribute.

Definition at line 45 of file PClassAttribute.h.

Referenced by copyPClassAttribute(), getType(), getType(), initialisationPClassAttribute(), and setType().

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PClassAttribute() [1/2]

◆ PClassAttribute() [2/2]

◆ ~PClassAttribute()

Member Function Documentation

◆ copyPClassAttribute()

◆ getDefaultValue() [1/2]

◆ getDefaultValue() [2/2]

◆ getDocumentation() [1/2]

◆ getDocumentation() [2/2]

◆ getIsEnum() [1/2]

◆ getIsEnum() [2/2]

◆ getIsPointer() [1/2]

◆ getIsPointer() [2/2]

◆ getIsReference() [1/2]

◆ getIsReference() [2/2]

◆ getName() [1/2]

◆ getName() [2/2]

◆ getType() [1/2]

◆ getType() [2/2]

◆ initialisationPClassAttribute()

◆ operator=()

◆ setDefaultValue()

◆ setDocumentation()

◆ setIsEnum()

◆ setIsPointer()

◆ setIsReference()

◆ setName()

◆ setType()

Member Data Documentation

◆ p_defaultValue

◆ p_documentation

◆ p_isEnum

◆ p_isPointer

◆ p_isReference

◆ p_name

◆ p_type