Configuration to be used to create a field from a yml file. More...

#include <AbtractField.h>

Public Member Functions
	FieldConfig ()
	Constructor of class FieldConfig.

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

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

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

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

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

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

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

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

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

std::map< PString, FieldConfig > &	getVecChildren ()
	Gets the vecChildren of the FieldConfig.

const std::map< PString, FieldConfig > &	getVecChildren () const
	Gets the vecChildren of the FieldConfig.

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

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

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

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

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

void	setVecChildren (const std::map< PString, FieldConfig > &vecChildren)
	Sets the vecChildren of the FieldConfig.

virtual	~FieldConfig ()
	Destructor of class FieldConfig.

Protected Member Functions
void	copyFieldConfig (const FieldConfig &other)
	Copy Function of class FieldConfig.

Private Member Functions
void	initialisationFieldConfig ()
	Initialisation Function of class FieldConfig.

Private Attributes
size_t	p_id
	Id of the field.

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

PString	p_name
	Name of the Field.

FieldType::FieldType	p_type
	Type of the Field.

std::map< PString, FieldConfig >	p_vecChildren
	Vector of children of the FieldConfig.

Detailed Description

Configuration to be used to create a field from a yml file.

Definition at line 79 of file AbtractField.h.

Constructor & Destructor Documentation

◆ FieldConfig() [1/2]

FieldConfig::FieldConfig ( )

Constructor of class FieldConfig.

Definition at line 278 of file AbtractField.cpp.

                        {
        initialisationFieldConfig();
}

References initialisationFieldConfig().

Referenced by copyFieldConfig(), FieldConfig(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FieldConfig() [2/2]

FieldConfig::FieldConfig ( const FieldConfig & other )

Copy Constructor of class FieldConfig.

Parameters

other : FieldConfig we want ot copy

Definition at line 285 of file AbtractField.cpp.

                                                 {
        copyFieldConfig(other);
}

References copyFieldConfig(), and FieldConfig().

Here is the call graph for this function:

◆ ~FieldConfig()

FieldConfig::~FieldConfig ( )

virtual

Destructor of class FieldConfig.

Definition at line 290 of file AbtractField.cpp.

                         {
        
}

Member Function Documentation

◆ copyFieldConfig()

void FieldConfig::copyFieldConfig ( const FieldConfig & other )

protected

Copy Function of class FieldConfig.

Parameters

other : FieldConfig we want ot copy

Definition at line 411 of file AbtractField.cpp.

                                                          {
        p_name = other.p_name;
        p_id = other.p_id;
        p_type = other.p_type;
        p_isArray = other.p_isArray;
        p_vecChildren = other.p_vecChildren;
}

References FieldConfig(), p_id, p_isArray, p_name, p_type, and p_vecChildren.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId() [1/2]

size_t & FieldConfig::getId ( )

Gets the id of the FieldConfig.

Returns: id of the FieldConfig

Definition at line 362 of file AbtractField.cpp.

                           {
        return p_id;
}

References p_id.

◆ getId() [2/2]

size_t FieldConfig::getId ( ) const

Gets the id of the FieldConfig.

Returns: id of the FieldConfig

Definition at line 355 of file AbtractField.cpp.

                               {
        return p_id;
}

References p_id.

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

Here is the caller graph for this function:

◆ getIsArray() [1/2]

bool & FieldConfig::getIsArray ( )

Gets the isArray of the FieldConfig.

Returns: isArray of the FieldConfig

Definition at line 390 of file AbtractField.cpp.

                              {
        return p_isArray;
}

References p_isArray.

◆ getIsArray() [2/2]

bool FieldConfig::getIsArray ( ) const

Gets the isArray of the FieldConfig.

Returns: isArray of the FieldConfig

Definition at line 383 of file AbtractField.cpp.

                                  {
        return p_isArray;
}

References p_isArray.

Referenced by FieldParser::addParseFieldArray().

Here is the caller graph for this function:

◆ getName() [1/2]

PString & FieldConfig::getName ( )

Gets the name of the FieldConfig.

Returns: name of the FieldConfig

Definition at line 348 of file AbtractField.cpp.

                              {
        return p_name;
}

References p_name.

◆ getName() [2/2]

const PString & FieldConfig::getName ( ) const

Gets the name of the FieldConfig.

Returns: name of the FieldConfig

Definition at line 341 of file AbtractField.cpp.

                                          {
        return p_name;
}

References p_name.

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

Here is the caller graph for this function:

◆ getType() [1/2]

FieldType::FieldType & FieldConfig::getType ( )

Gets the type of the FieldConfig.

Returns: type of the FieldConfig

Definition at line 376 of file AbtractField.cpp.

                                         {
        return p_type;
}

References p_type.

◆ getType() [2/2]

const FieldType::FieldType & FieldConfig::getType ( ) const

Gets the type of the FieldConfig.

Returns: type of the FieldConfig

Definition at line 369 of file AbtractField.cpp.

                                                     {
        return p_type;
}

References p_type.

Referenced by FieldParser::checkInputType().

Here is the caller graph for this function:

◆ getVecChildren() [1/2]

std::map< PString, FieldConfig > & FieldConfig::getVecChildren ( )

Gets the vecChildren of the FieldConfig.

Returns: vecChildren of the FieldConfig

Definition at line 404 of file AbtractField.cpp.

                                                          {
        return p_vecChildren;
}

References p_vecChildren.

◆ getVecChildren() [2/2]

const std::map< PString, FieldConfig > & FieldConfig::getVecChildren ( ) const

Gets the vecChildren of the FieldConfig.

Returns: vecChildren of the FieldConfig

Definition at line 397 of file AbtractField.cpp.

                                                                      {
        return p_vecChildren;
}

References p_vecChildren.

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

Here is the caller graph for this function:

◆ initialisationFieldConfig()

void FieldConfig::initialisationFieldConfig ( )

private

Initialisation Function of class FieldConfig.

Definition at line 420 of file AbtractField.cpp.

                                           {
        p_name = "";
        p_id = 0lu;
        p_isArray = false;
}

References p_id, p_isArray, and p_name.

Referenced by FieldConfig().

Here is the caller graph for this function:

◆ operator=()

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

Operator = of class FieldConfig.

Parameters

other : FieldConfig we want ot copy

Returns: copied class FieldConfig

Definition at line 298 of file AbtractField.cpp.

                                                               {
        copyFieldConfig(other);
        return *this;
}

References copyFieldConfig(), and FieldConfig().

Here is the call graph for this function:

◆ setId()

void FieldConfig::setId ( size_t id )

Sets the id of the FieldConfig.

Parameters

id	: id of the FieldConfig

Definition at line 313 of file AbtractField.cpp.

                                {
        p_id = id;
}

References p_id.

Referenced by phoenix_createField().

Here is the caller graph for this function:

◆ setIsArray()

void FieldConfig::setIsArray ( bool isArray )

Sets the isArray of the FieldConfig.

Parameters

isArray : isArray of the FieldConfig

Definition at line 327 of file AbtractField.cpp.

                                        {
        p_isArray = isArray;
}

References p_isArray.

Referenced by phoenix_createField().

Here is the caller graph for this function:

◆ setName()

void FieldConfig::setName ( const PString & name )

Sets the name of the FieldConfig.

Parameters

name	: name of the FieldConfig

Definition at line 306 of file AbtractField.cpp.

                                             {
        p_name = name;
}

References p_name.

Referenced by phoenix_createField().

Here is the caller graph for this function:

◆ setType()

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

Sets the type of the FieldConfig.

Parameters

type	: type of the FieldConfig

Definition at line 320 of file AbtractField.cpp.

                                                        {
        p_type = type;
}

References p_type.

Referenced by phoenix_createField().

Here is the caller graph for this function:

◆ setVecChildren()

void FieldConfig::setVecChildren ( const std::map< PString, FieldConfig > & vecChildren )

Sets the vecChildren of the FieldConfig.

Parameters

vecChildren : vecChildren of the FieldConfig

Definition at line 334 of file AbtractField.cpp.

                                                                                {
        p_vecChildren = vecChildren;
}

References p_vecChildren.

Member Data Documentation

◆ p_id

size_t FieldConfig::p_id

private

Id of the field.

Definition at line 107 of file AbtractField.h.

Referenced by copyFieldConfig(), getId(), getId(), initialisationFieldConfig(), and setId().

◆ p_isArray

bool FieldConfig::p_isArray

private

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

Definition at line 111 of file AbtractField.h.

Referenced by copyFieldConfig(), getIsArray(), getIsArray(), initialisationFieldConfig(), and setIsArray().

◆ p_name

PString FieldConfig::p_name

private

Name of the Field.

Definition at line 105 of file AbtractField.h.

Referenced by copyFieldConfig(), getName(), getName(), initialisationFieldConfig(), and setName().

◆ p_type

FieldType::FieldType FieldConfig::p_type

private

Type of the Field.

Definition at line 109 of file AbtractField.h.

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

◆ p_vecChildren

std::map<PString, FieldConfig> FieldConfig::p_vecChildren

private

Vector of children of the FieldConfig.

Definition at line 113 of file AbtractField.h.

Referenced by copyFieldConfig(), getVecChildren(), getVecChildren(), and setVecChildren().

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

◆ FieldConfig() [1/2]

◆ FieldConfig() [2/2]

◆ ~FieldConfig()

Member Function Documentation

◆ copyFieldConfig()

◆ getId() [1/2]

◆ getId() [2/2]

◆ getIsArray() [1/2]

◆ getIsArray() [2/2]

◆ getName() [1/2]

◆ getName() [2/2]

◆ getType() [1/2]

◆ getType() [2/2]

◆ getVecChildren() [1/2]

◆ getVecChildren() [2/2]

◆ initialisationFieldConfig()

◆ operator=()

◆ setId()

◆ setIsArray()

◆ setName()

◆ setType()

◆ setVecChildren()

Member Data Documentation

◆ p_id

◆ p_isArray

◆ p_name

◆ p_type

◆ p_vecChildren