Abtract field to be read from a protocol buffer message. More...

#include <AbtractField.h>

Public Member Functions
	AbtractField ()
	Constructor of class AbtractField.

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

void **&	getArrayPtr ()
	Gets the arrayPtr of the AbtractField.

void **	getArrayPtr () const
	Gets the arrayPtr of the AbtractField.

size_t &	getId ()
	Gets the id of the AbtractField.

size_t	getId () const
	Gets the id of the AbtractField.

bool &	getIsArray ()
	Gets the isArray of the AbtractField.

bool	getIsArray () const
	Gets the isArray of the AbtractField.

bool &	getIsOffsetReady ()
	Gets the isOffsetReady of the AbtractField.

bool	getIsOffsetReady () const
	Gets the isOffsetReady of the AbtractField.

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

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

size_t *&	getNbElement ()
	Gets the nbElement of the AbtractField.

size_t *	getNbElement () const
	Gets the nbElement of the AbtractField.

size_t &	getOffset ()
	Gets the offset of the AbtractField.

size_t	getOffset () const
	Gets the offset of the AbtractField.

FieldType::FieldType &	getType ()
	Gets the type of the AbtractField.

const FieldType::FieldType &	getType () const
	Gets the type of the AbtractField.

size_t &	getTypeSize ()
	Gets the typeSize of the AbtractField.

size_t	getTypeSize () const
	Gets the typeSize of the AbtractField.

void *&	getVarPtr ()
	Gets the varPtr of the AbtractField.

void *	getVarPtr () const
	Gets the varPtr of the AbtractField.

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

void	setArrayPtr (void **arrayPtr)
	Sets the arrayPtr of the AbtractField.

void	setId (size_t id)
	Sets the id of the AbtractField.

void	setIsArray (bool isArray)
	Sets the isArray of the AbtractField.

void	setIsOffsetReady (bool isOffsetReady)
	Sets the isOffsetReady of the AbtractField.

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

void	setNbElement (size_t *nbElement)
	Sets the nbElement of the AbtractField.

void	setOffset (size_t offset)
	Sets the offset of the AbtractField.

void	setType (const FieldType::FieldType &type)
	Sets the type of the AbtractField.

void	setTypeSize (size_t typeSize)
	Sets the typeSize of the AbtractField.

void	setVarPtr (void *varPtr)
	Sets the varPtr of the AbtractField.

virtual	~AbtractField ()
	Destructor of class AbtractField.

Protected Member Functions
void	copyAbtractField (const AbtractField &other)
	Copy Function of class AbtractField.

Private Member Functions
void	initialisationAbtractField ()
	Initialisation Function of class AbtractField.

Private Attributes
void **	p_arrayPtr
	Pointer to the array to be updated.

size_t	p_id
	Id of the field.

bool	p_isArray
	True if the Field contains an array of value, false if not.

bool	p_isOffsetReady
	True if the offset is computed and can be used on the next read.

PString	p_name
	Name of the Field.

size_t *	p_nbElement
	Number of element of the field (NULL for scalar)

size_t	p_offset
	Offset to get the data on the next read.

FieldType::FieldType	p_type
	Type of the Field.

size_t	p_typeSize
	Expected size of the variable type.

void *	p_varPtr
	Pointer to the variable to be updated.

Detailed Description

Abtract field to be read from a protocol buffer message.

Definition at line 16 of file AbtractField.h.

Constructor & Destructor Documentation

◆ AbtractField() [1/2]

AbtractField::AbtractField ( )

Constructor of class AbtractField.

Definition at line 13 of file AbtractField.cpp.

                          {
        initialisationAbtractField();
}

References initialisationAbtractField().

Referenced by AbtractField(), copyAbtractField(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AbtractField() [2/2]

AbtractField::AbtractField ( const AbtractField & other )

Copy Constructor of class AbtractField.

Parameters

other : AbtractField we want ot copy

Definition at line 20 of file AbtractField.cpp.

                                                    {
        copyAbtractField(other);
}

References AbtractField(), and copyAbtractField().

Here is the call graph for this function:

◆ ~AbtractField()

AbtractField::~AbtractField ( )

virtual

Destructor of class AbtractField.

Definition at line 25 of file AbtractField.cpp.

                           {
        
}

Member Function Documentation

◆ copyAbtractField()

void AbtractField::copyAbtractField ( const AbtractField & other )

protected

Copy Function of class AbtractField.

Parameters

other : AbtractField we want ot copy

Definition at line 251 of file AbtractField.cpp.

                                                             {
        p_name = other.p_name;
        p_id = other.p_id;
        p_type = other.p_type;
        p_typeSize = other.p_typeSize;
        p_isArray = other.p_isArray;
        p_nbElement = other.p_nbElement;
        p_varPtr = other.p_varPtr;
        p_arrayPtr = other.p_arrayPtr;
        p_isOffsetReady = other.p_isOffsetReady;
        p_offset = other.p_offset;
}

References AbtractField(), p_arrayPtr, p_id, p_isArray, p_isOffsetReady, p_name, p_nbElement, p_offset, p_type, p_typeSize, and p_varPtr.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getArrayPtr() [1/2]

void **& AbtractField::getArrayPtr ( )

Gets the arrayPtr of the AbtractField.

Returns: arrayPtr of the AbtractField

Definition at line 216 of file AbtractField.cpp.

                                   {
        return p_arrayPtr;
}

References p_arrayPtr.

◆ getArrayPtr() [2/2]

void ** AbtractField::getArrayPtr ( ) const

Gets the arrayPtr of the AbtractField.

Returns: arrayPtr of the AbtractField

Definition at line 209 of file AbtractField.cpp.

                                       {
        return p_arrayPtr;
}

References p_arrayPtr.

◆ getId() [1/2]

size_t & AbtractField::getId ( )

Gets the id of the AbtractField.

Returns: id of the AbtractField

Definition at line 132 of file AbtractField.cpp.

                            {
        return p_id;
}

References p_id.

◆ getId() [2/2]

size_t AbtractField::getId ( ) const

Gets the id of the AbtractField.

Returns: id of the AbtractField

Definition at line 125 of file AbtractField.cpp.

                                {
        return p_id;
}

References p_id.

◆ getIsArray() [1/2]

bool & AbtractField::getIsArray ( )

Gets the isArray of the AbtractField.

Returns: isArray of the AbtractField

Definition at line 174 of file AbtractField.cpp.

                               {
        return p_isArray;
}

References p_isArray.

◆ getIsArray() [2/2]

bool AbtractField::getIsArray ( ) const

Gets the isArray of the AbtractField.

Returns: isArray of the AbtractField

Definition at line 167 of file AbtractField.cpp.

                                   {
        return p_isArray;
}

References p_isArray.

◆ getIsOffsetReady() [1/2]

bool & AbtractField::getIsOffsetReady ( )

Gets the isOffsetReady of the AbtractField.

Returns: isOffsetReady of the AbtractField

Definition at line 230 of file AbtractField.cpp.

                                     {
        return p_isOffsetReady;
}

References p_isOffsetReady.

◆ getIsOffsetReady() [2/2]

bool AbtractField::getIsOffsetReady ( ) const

Gets the isOffsetReady of the AbtractField.

Returns: isOffsetReady of the AbtractField

Definition at line 223 of file AbtractField.cpp.

                                         {
        return p_isOffsetReady;
}

References p_isOffsetReady.

◆ getName() [1/2]

PString & AbtractField::getName ( )

Gets the name of the AbtractField.

Returns: name of the AbtractField

Definition at line 118 of file AbtractField.cpp.

                               {
        return p_name;
}

References p_name.

◆ getName() [2/2]

const PString & AbtractField::getName ( ) const

Gets the name of the AbtractField.

Returns: name of the AbtractField

Definition at line 111 of file AbtractField.cpp.

                                           {
        return p_name;
}

References p_name.

◆ getNbElement() [1/2]

size_t *& AbtractField::getNbElement ( )

Gets the nbElement of the AbtractField.

Returns: nbElement of the AbtractField

Definition at line 188 of file AbtractField.cpp.

                                     {
        return p_nbElement;
}

References p_nbElement.

◆ getNbElement() [2/2]

size_t * AbtractField::getNbElement ( ) const

Gets the nbElement of the AbtractField.

Returns: nbElement of the AbtractField

Definition at line 181 of file AbtractField.cpp.

                                         {
        return p_nbElement;
}

References p_nbElement.

◆ getOffset() [1/2]

size_t & AbtractField::getOffset ( )

Gets the offset of the AbtractField.

Returns: offset of the AbtractField

Definition at line 244 of file AbtractField.cpp.

                                {
        return p_offset;
}

References p_offset.

◆ getOffset() [2/2]

size_t AbtractField::getOffset ( ) const

Gets the offset of the AbtractField.

Returns: offset of the AbtractField

Definition at line 237 of file AbtractField.cpp.

                                    {
        return p_offset;
}

References p_offset.

◆ getType() [1/2]

FieldType::FieldType & AbtractField::getType ( )

Gets the type of the AbtractField.

Returns: type of the AbtractField

Definition at line 146 of file AbtractField.cpp.

                                          {
        return p_type;
}

References p_type.

◆ getType() [2/2]

const FieldType::FieldType & AbtractField::getType ( ) const

Gets the type of the AbtractField.

Returns: type of the AbtractField

Definition at line 139 of file AbtractField.cpp.

                                                      {
        return p_type;
}

References p_type.

◆ getTypeSize() [1/2]

size_t & AbtractField::getTypeSize ( )

Gets the typeSize of the AbtractField.

Returns: typeSize of the AbtractField

Definition at line 160 of file AbtractField.cpp.

                                  {
        return p_typeSize;
}

References p_typeSize.

◆ getTypeSize() [2/2]

size_t AbtractField::getTypeSize ( ) const

Gets the typeSize of the AbtractField.

Returns: typeSize of the AbtractField

Definition at line 153 of file AbtractField.cpp.

                                      {
        return p_typeSize;
}

References p_typeSize.

◆ getVarPtr() [1/2]

void *& AbtractField::getVarPtr ( )

Gets the varPtr of the AbtractField.

Returns: varPtr of the AbtractField

Definition at line 202 of file AbtractField.cpp.

                                {
        return p_varPtr;
}

References p_varPtr.

◆ getVarPtr() [2/2]

void * AbtractField::getVarPtr ( ) const

Gets the varPtr of the AbtractField.

Returns: varPtr of the AbtractField

Definition at line 195 of file AbtractField.cpp.

                                    {
        return p_varPtr;
}

References p_varPtr.

◆ initialisationAbtractField()

void AbtractField::initialisationAbtractField ( )

private

Initialisation Function of class AbtractField.

Definition at line 265 of file AbtractField.cpp.

                                             {
        p_name = "";
        p_id = 0lu;
        p_typeSize = 0lu;
        p_isArray = false;
        p_nbElement = NULL;
        p_varPtr = NULL;
        p_arrayPtr = NULL;
        p_isOffsetReady = false;
        p_offset = 0lu;
}

References p_arrayPtr, p_id, p_isArray, p_isOffsetReady, p_name, p_nbElement, p_offset, p_typeSize, and p_varPtr.

Referenced by AbtractField().

Here is the caller graph for this function:

◆ operator=()

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

Operator = of class AbtractField.

Parameters

other : AbtractField we want ot copy

Returns: copied class AbtractField

Definition at line 33 of file AbtractField.cpp.

                                                                  {
        copyAbtractField(other);
        return *this;
}

References AbtractField(), and copyAbtractField().

Here is the call graph for this function:

◆ setArrayPtr()

void AbtractField::setArrayPtr ( void ** arrayPtr )

Sets the arrayPtr of the AbtractField.

Parameters

arrayPtr : arrayPtr of the AbtractField

Definition at line 90 of file AbtractField.cpp.

                                              {
        p_arrayPtr = arrayPtr;
}

References p_arrayPtr.

Referenced by FieldParser::addParseFieldArray().

Here is the caller graph for this function:

◆ setId()

void AbtractField::setId ( size_t id )

Sets the id of the AbtractField.

Parameters

id	: id of the AbtractField

Definition at line 48 of file AbtractField.cpp.

                                 {
        p_id = id;
}

References p_id.

◆ setIsArray()

void AbtractField::setIsArray ( bool isArray )

Sets the isArray of the AbtractField.

Parameters

isArray : isArray of the AbtractField

Definition at line 69 of file AbtractField.cpp.

                                         {
        p_isArray = isArray;
}

References p_isArray.

Referenced by FieldParser::addParseFieldArray(), FieldParser::addParseFieldEnum(), and FieldParser::addParseFieldValue().

Here is the caller graph for this function:

◆ setIsOffsetReady()

void AbtractField::setIsOffsetReady ( bool isOffsetReady )

Sets the isOffsetReady of the AbtractField.

Parameters

isOffsetReady : isOffsetReady of the AbtractField

Definition at line 97 of file AbtractField.cpp.

                                                     {
        p_isOffsetReady = isOffsetReady;
}

References p_isOffsetReady.

Referenced by FieldParser::addParseFieldArray(), FieldParser::addParseFieldEnum(), and FieldParser::addParseFieldValue().

Here is the caller graph for this function:

◆ setName()

void AbtractField::setName ( const PString & name )

Sets the name of the AbtractField.

Parameters

name	: name of the AbtractField

Definition at line 41 of file AbtractField.cpp.

                                              {
        p_name = name;
}

References p_name.

◆ setNbElement()

void AbtractField::setNbElement ( size_t * nbElement )

Sets the nbElement of the AbtractField.

Parameters

nbElement : nbElement of the AbtractField

Definition at line 76 of file AbtractField.cpp.

                                                 {
        p_nbElement = nbElement;
}

References p_nbElement.

Referenced by FieldParser::addParseFieldArray(), FieldParser::addParseFieldEnum(), and FieldParser::addParseFieldValue().

Here is the caller graph for this function:

◆ setOffset()

void AbtractField::setOffset ( size_t offset )

Sets the offset of the AbtractField.

Parameters

offset : offset of the AbtractField

Definition at line 104 of file AbtractField.cpp.

                                         {
        p_offset = offset;
}

References p_offset.

Referenced by FieldParser::addParseFieldArray(), FieldParser::addParseFieldEnum(), and FieldParser::addParseFieldValue().

Here is the caller graph for this function:

◆ setType()

void AbtractField::setType ( const FieldType::FieldType & type )

Sets the type of the AbtractField.

Parameters

type	: type of the AbtractField

Definition at line 55 of file AbtractField.cpp.

                                                         {
        p_type = type;
}

References p_type.

Referenced by FieldParser::addParseFieldArray(), FieldParser::addParseFieldEnum(), FieldParser::addParseFieldValue(), and FieldParser::addSubMessage().

Here is the caller graph for this function:

◆ setTypeSize()

void AbtractField::setTypeSize ( size_t typeSize )

Sets the typeSize of the AbtractField.

Parameters

typeSize : typeSize of the AbtractField

Definition at line 62 of file AbtractField.cpp.

                                             {
        p_typeSize = typeSize;
}

References p_typeSize.

Referenced by FieldParser::addParseFieldArray(), FieldParser::addParseFieldEnum(), and FieldParser::addParseFieldValue().

Here is the caller graph for this function:

◆ setVarPtr()

void AbtractField::setVarPtr ( void * varPtr )

Sets the varPtr of the AbtractField.

Parameters

varPtr : varPtr of the AbtractField

Definition at line 83 of file AbtractField.cpp.

                                         {
        p_varPtr = varPtr;
}

References p_varPtr.

Referenced by FieldParser::addParseFieldEnum(), and FieldParser::addParseFieldValue().

Here is the caller graph for this function:

Member Data Documentation

◆ p_arrayPtr

void** AbtractField::p_arrayPtr

private

Pointer to the array to be updated.

Definition at line 71 of file AbtractField.h.

Referenced by copyAbtractField(), getArrayPtr(), getArrayPtr(), initialisationAbtractField(), and setArrayPtr().

◆ p_id

size_t AbtractField::p_id

private

Id of the field.

Definition at line 59 of file AbtractField.h.

Referenced by copyAbtractField(), getId(), getId(), initialisationAbtractField(), and setId().

◆ p_isArray

bool AbtractField::p_isArray

private

True if the Field contains an array of value, false if not.

Definition at line 65 of file AbtractField.h.

Referenced by copyAbtractField(), getIsArray(), getIsArray(), initialisationAbtractField(), and setIsArray().

◆ p_isOffsetReady

bool AbtractField::p_isOffsetReady

private

True if the offset is computed and can be used on the next read.

Definition at line 73 of file AbtractField.h.

Referenced by copyAbtractField(), getIsOffsetReady(), getIsOffsetReady(), initialisationAbtractField(), and setIsOffsetReady().

◆ p_name

PString AbtractField::p_name

private

Name of the Field.

Definition at line 57 of file AbtractField.h.

Referenced by copyAbtractField(), getName(), getName(), initialisationAbtractField(), and setName().

◆ p_nbElement

size_t* AbtractField::p_nbElement

private

Number of element of the field (NULL for scalar)

Definition at line 67 of file AbtractField.h.

Referenced by copyAbtractField(), getNbElement(), getNbElement(), initialisationAbtractField(), and setNbElement().

◆ p_offset

size_t AbtractField::p_offset

private

Offset to get the data on the next read.

Definition at line 75 of file AbtractField.h.

Referenced by copyAbtractField(), getOffset(), getOffset(), initialisationAbtractField(), and setOffset().

◆ p_type

FieldType::FieldType AbtractField::p_type

private

Type of the Field.

Definition at line 61 of file AbtractField.h.

Referenced by copyAbtractField(), getType(), getType(), and setType().

◆ p_typeSize

size_t AbtractField::p_typeSize

private

Expected size of the variable type.

Definition at line 63 of file AbtractField.h.

Referenced by copyAbtractField(), getTypeSize(), getTypeSize(), initialisationAbtractField(), and setTypeSize().

◆ p_varPtr

void* AbtractField::p_varPtr

private

Pointer to the variable to be updated.

Definition at line 69 of file AbtractField.h.

Referenced by copyAbtractField(), getVarPtr(), getVarPtr(), initialisationAbtractField(), and setVarPtr().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixProtocolBuffer/src/AbtractField.h
/builds/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixProtocolBuffer/src/AbtractField.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbtractField() [1/2]

◆ AbtractField() [2/2]

◆ ~AbtractField()

Member Function Documentation

◆ copyAbtractField()

◆ getArrayPtr() [1/2]

◆ getArrayPtr() [2/2]

◆ getId() [1/2]

◆ getId() [2/2]

◆ getIsArray() [1/2]

◆ getIsArray() [2/2]

◆ getIsOffsetReady() [1/2]

◆ getIsOffsetReady() [2/2]

◆ getName() [1/2]

◆ getName() [2/2]

◆ getNbElement() [1/2]

◆ getNbElement() [2/2]

◆ getOffset() [1/2]

◆ getOffset() [2/2]

◆ getType() [1/2]

◆ getType() [2/2]

◆ getTypeSize() [1/2]

◆ getTypeSize() [2/2]

◆ getVarPtr() [1/2]

◆ getVarPtr() [2/2]

◆ initialisationAbtractField()

◆ operator=()

◆ setArrayPtr()

◆ setId()

◆ setIsArray()

◆ setIsOffsetReady()

◆ setName()

◆ setNbElement()

◆ setOffset()

◆ setType()

◆ setTypeSize()

◆ setVarPtr()

Member Data Documentation

◆ p_arrayPtr

◆ p_id

◆ p_isArray

◆ p_isOffsetReady

◆ p_name

◆ p_nbElement

◆ p_offset

◆ p_type

◆ p_typeSize

◆ p_varPtr