Basic Data exchanged in the swarm. More...

#include <Representation.h>

Public Member Functions
	Data ()
	Constructor of class Data.

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

PString &	getDescription ()
	Gets the description of the Data.

const PString &	getDescription () const
	Gets the description of the Data.

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

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

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

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

DataStreamMsg &	getValue ()
	Gets the value of the Data.

const DataStreamMsg &	getValue () const
	Gets the value of the Data.

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

template<typename Stream, DataStreamMode::DataStreamMode Mode>
bool	readWriteStream (Stream &ds)
	Load the current Data with a stream.

void	setDescription (const PString &description)
	Sets the description of the Data.

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

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

void	setValue (const DataStreamMsg &value)
	Sets the value of the Data.

virtual	~Data ()
	Destructor of class Data.

Protected Member Functions
void	copyData (const Data &other)
	Copy Function of class Data.

Private Member Functions
void	initialisationData ()
	Initialisation Function of class Data.

Private Attributes
PString	p_description
	Description of the Data.

PString	p_name
	Name of the Data.

PString	p_type
	Type of the Data.

DataStreamMsg	p_value
	Value of the Data.

Detailed Description

Basic Data exchanged in the swarm.

Definition at line 22 of file Representation.h.

Constructor & Destructor Documentation

◆ Data() [1/2]

Data::Data ( )

Constructor of class Data.

Definition at line 38 of file Representation.cpp.

          {
        initialisationData();
}

References initialisationData().

Referenced by copyData(), Data(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~Data()

Data::~Data ( )

virtual

Destructor of class Data.

Definition at line 43 of file Representation.cpp.

           {
        
}

◆ Data() [2/2]

Data::Data ( const Data & other )

Copy Constructor of class Data.

Parameters

other : Data we want ot copy

Definition at line 50 of file Representation.cpp.

                            {
        copyData(other);
}

References copyData(), and Data().

Here is the call graph for this function:

Member Function Documentation

◆ copyData()

void Data::copyData ( const Data & other )

protected

Copy Function of class Data.

Parameters

other : Data we want ot copy

Definition at line 150 of file Representation.cpp.

                                     {
        p_name = other.p_name;
        p_description = other.p_description;
        p_type = other.p_type;
        p_value = other.p_value;
}

References Data(), p_description, p_name, p_type, and p_value.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDescription() [1/2]

PString & Data::getDescription ( )

Gets the description of the Data.

Returns: description of the Data

Definition at line 115 of file Representation.cpp.

                              {
        return p_description;
}

References p_description.

◆ getDescription() [2/2]

const PString & Data::getDescription ( ) const

Gets the description of the Data.

Returns: description of the Data

Definition at line 108 of file Representation.cpp.

                                          {
        return p_description;
}

References p_description.

Referenced by CheckStream< Swarm::Data >::check_stream().

Here is the caller graph for this function:

◆ getName() [1/2]

PString & Data::getName ( )

Gets the name of the Data.

Returns: name of the Data

Definition at line 101 of file Representation.cpp.

                       {
        return p_name;
}

References p_name.

◆ getName() [2/2]

const PString & Data::getName ( ) const

Gets the name of the Data.

Returns: name of the Data

Definition at line 94 of file Representation.cpp.

                                   {
        return p_name;
}

References p_name.

Referenced by CheckStream< Swarm::Data >::check_stream().

Here is the caller graph for this function:

◆ getType() [1/2]

PString & Data::getType ( )

Gets the type of the Data.

Returns: type of the Data

Definition at line 129 of file Representation.cpp.

                       {
        return p_type;
}

References p_type.

◆ getType() [2/2]

const PString & Data::getType ( ) const

Gets the type of the Data.

Returns: type of the Data

Definition at line 122 of file Representation.cpp.

                                   {
        return p_type;
}

References p_type.

Referenced by CheckStream< Swarm::Data >::check_stream(), Swarm::BaseDaemon::getDataFunction(), phoenix_getValueFromData(), Swarm::BaseDaemon::processConfirmedMessage(), Swarm::BaseDaemon::processData(), and Swarm::Daemon< _TBackend >::processInputMessage().

Here is the caller graph for this function:

◆ getValue() [1/2]

DataStreamMsg & Data::getValue ( )

Gets the value of the Data.

Returns: value of the Data

Definition at line 143 of file Representation.cpp.

                              {
        return p_value;
}

References p_value.

◆ getValue() [2/2]

const DataStreamMsg & Data::getValue ( ) const

Gets the value of the Data.

Returns: value of the Data

Definition at line 136 of file Representation.cpp.

                                          {
        return p_value;
}

References p_value.

Referenced by Swarm::FunctionCall< _Callable >::call(), CheckStream< Swarm::Data >::check_stream(), phoenix_createData(), and phoenix_getValueFromData().

Here is the caller graph for this function:

◆ initialisationData()

void Data::initialisationData ( )

private

Initialisation Function of class Data.

Definition at line 158 of file Representation.cpp.

                             {
        p_name = "";
        p_description = "";
        p_type = "";
}

References p_description, p_name, and p_type.

Referenced by Data().

Here is the caller graph for this function:

◆ operator=()

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

Operator = of class Data.

Parameters

other : Data we want ot copy

Returns: copied class Data

Definition at line 58 of file Representation.cpp.

                                          {
        copyData(other);
        return *this;
}

References copyData(), and Data().

Here is the call graph for this function:

◆ readWriteStream()

template<typename Stream, DataStreamMode::DataStreamMode Mode>

bool Swarm::Data::readWriteStream ( Stream & ds )

inline

Load the current Data with a stream.

Parameters

[out] ds : stream to be used

Returns: true on success, false otherwise

Definition at line 46 of file Representation.h.

                                                 {
                        bool b(true);
                        b &= DataStream<Stream, Mode, PString >::data_stream(ds, p_name);
                        b &= DataStream<Stream, Mode, PString >::data_stream(ds, p_description);
                        b &= DataStream<Stream, Mode, PString >::data_stream(ds, p_type);
                        b &= DataStream<Stream, Mode, DataStreamMsg >::data_stream(ds, p_value);
                        return b;
                }

References p_description, p_name, p_type, and p_value.

Referenced by DataStream< Stream, Mode, Swarm::Data >::data_stream().

Here is the caller graph for this function:

◆ setDescription()

void Data::setDescription ( const PString & description )

Sets the description of the Data.

Parameters

description : description of the Data

Definition at line 73 of file Representation.cpp.

                                                    {
        p_description = description;
}

References p_description.

◆ setName()

void Data::setName ( const PString & name )

Sets the name of the Data.

Parameters

name	: name of the Data

Definition at line 66 of file Representation.cpp.

                                      {
        p_name = name;
}

References p_name.

◆ setType()

void Data::setType ( const PString & type )

Sets the type of the Data.

Parameters

type	: type of the Data

Definition at line 80 of file Representation.cpp.

                                      {
        p_type = type;
}

References p_type.

Referenced by phoenix_createData(), and phoenix_function_call().

Here is the caller graph for this function:

◆ setValue()

void Data::setValue ( const DataStreamMsg & value )

Sets the value of the Data.

Parameters

value : value of the Data

Definition at line 87 of file Representation.cpp.

                                              {
        p_value = value;
}

References p_value.

Member Data Documentation

◆ p_description

PString Swarm::Data::p_description

private

Description of the Data.

Definition at line 62 of file Representation.h.

Referenced by copyData(), getDescription(), getDescription(), initialisationData(), readWriteStream(), and setDescription().

◆ p_name

PString Swarm::Data::p_name

private

Name of the Data.

Definition at line 60 of file Representation.h.

Referenced by copyData(), getName(), getName(), initialisationData(), readWriteStream(), and setName().

◆ p_type

PString Swarm::Data::p_type

private

Type of the Data.

Definition at line 64 of file Representation.h.

Referenced by copyData(), getType(), getType(), initialisationData(), readWriteStream(), and setType().

◆ p_value

DataStreamMsg Swarm::Data::p_value

private

Value of the Data.

Definition at line 66 of file Representation.h.

Referenced by copyData(), getValue(), getValue(), readWriteStream(), and setValue().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixSwarm/src/Representation/Representation.h
/builds/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixSwarm/src/Representation/Representation.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Data() [1/2]

◆ ~Data()

◆ Data() [2/2]

Member Function Documentation

◆ copyData()

◆ getDescription() [1/2]

◆ getDescription() [2/2]

◆ getName() [1/2]

◆ getName() [2/2]

◆ getType() [1/2]

◆ getType() [2/2]

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ initialisationData()

◆ operator=()

◆ readWriteStream()

◆ setDescription()

◆ setName()

◆ setType()

◆ setValue()

Member Data Documentation

◆ p_description

◆ p_name

◆ p_type

◆ p_value