Basic function which can be called from an other Daemon. More...

#include <Representation.h>

Collaboration diagram for Swarm::Function:

Public Member Functions
	Function ()
	Constructor of class Function.

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

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

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

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

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

Swarm::Data &	getReturnValue ()
	Gets the returnValue of the Function.

const Swarm::Data &	getReturnValue () const
	Gets the returnValue of the Function.

std::vector< Swarm::Data > &	getVecParam ()
	Gets the vecParam of the Function.

const std::vector< Swarm::Data > &	getVecParam () const
	Gets the vecParam of the Function.

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

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

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

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

void	setReturnValue (const Swarm::Data &returnValue)
	Sets the returnValue of the Function.

void	setVecParam (const std::vector< Swarm::Data > &vecParam)
	Sets the vecParam of the Function.

virtual	~Function ()
	Destructor of class Function.

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

Private Member Functions
void	initialisationFunction ()
	Initialisation Function of class Function.

Private Attributes
PString	p_description
	Description of the Function.

PString	p_name
	Name of the Function.

Swarm::Data	p_returnValue
	Return value of the Function.

std::vector< Swarm::Data >	p_vecParam
	Vector of parameters of the Function.

Detailed Description

Basic function which can be called from an other Daemon.

Definition at line 95 of file Representation.h.

Constructor & Destructor Documentation

◆ Function() [1/2]

Function::Function ( )

Constructor of class Function.

Definition at line 190 of file Representation.cpp.

                  {
        initialisationFunction();
}

References initialisationFunction().

Referenced by copyFunction(), Function(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~Function()

Function::~Function ( )

virtual

Destructor of class Function.

Definition at line 195 of file Representation.cpp.

                   {
        
}

◆ Function() [2/2]

Function::Function ( const Function & other )

Copy Constructor of class Function.

Parameters

other : Function we want ot copy

Definition at line 202 of file Representation.cpp.

                                        {
        copyFunction(other);
}

References copyFunction(), and Function().

Here is the call graph for this function:

Member Function Documentation

◆ copyFunction()

void Function::copyFunction ( const Function & other )

protected

Copy Function of class Function.

Parameters

other : Function we want ot copy

Definition at line 302 of file Representation.cpp.

                                                 {
        p_name = other.p_name;
        p_description = other.p_description;
        p_vecParam = other.p_vecParam;
        p_returnValue = other.p_returnValue;
}

References Function(), p_description, p_name, p_returnValue, and p_vecParam.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDescription() [1/2]

PString & Function::getDescription ( )

Gets the description of the Function.

Returns: description of the Function

Definition at line 267 of file Representation.cpp.

                                  {
        return p_description;
}

References p_description.

◆ getDescription() [2/2]

const PString & Function::getDescription ( ) const

Gets the description of the Function.

Returns: description of the Function

Definition at line 260 of file Representation.cpp.

                                              {
        return p_description;
}

References p_description.

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

Here is the caller graph for this function:

◆ getName() [1/2]

PString & Function::getName ( )

Gets the name of the Function.

Returns: name of the Function

Definition at line 253 of file Representation.cpp.

                           {
        return p_name;
}

References p_name.

◆ getName() [2/2]

const PString & Function::getName ( ) const

Gets the name of the Function.

Returns: name of the Function

Definition at line 246 of file Representation.cpp.

                                       {
        return p_name;
}

References p_name.

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

Here is the caller graph for this function:

◆ getReturnValue() [1/2]

Swarm::Data & Function::getReturnValue ( )

Gets the returnValue of the Function.

Returns: returnValue of the Function

Definition at line 295 of file Representation.cpp.

                                    {
        return p_returnValue;
}

References p_returnValue.

◆ getReturnValue() [2/2]

const Swarm::Data & Function::getReturnValue ( ) const

Gets the returnValue of the Function.

Returns: returnValue of the Function

Definition at line 288 of file Representation.cpp.

                                                {
        return p_returnValue;
}

References p_returnValue.

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

Here is the caller graph for this function:

◆ getVecParam() [1/2]

std::vector< Swarm::Data > & Function::getVecParam ( )

Gets the vecParam of the Function.

Returns: vecParam of the Function

Definition at line 281 of file Representation.cpp.

                                            {
        return p_vecParam;
}

References p_vecParam.

◆ getVecParam() [2/2]

const std::vector< Swarm::Data > & Function::getVecParam ( ) const

Gets the vecParam of the Function.

Returns: vecParam of the Function

Definition at line 274 of file Representation.cpp.

                                                        {
        return p_vecParam;
}

References p_vecParam.

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

Here is the caller graph for this function:

◆ initialisationFunction()

void Function::initialisationFunction ( )

private

Initialisation Function of class Function.

Definition at line 310 of file Representation.cpp.

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

References p_description, and p_name.

Referenced by Function().

Here is the caller graph for this function:

◆ operator=()

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

Operator = of class Function.

Parameters

other : Function we want ot copy

Returns: copied class Function

Definition at line 210 of file Representation.cpp.

                                                      {
        copyFunction(other);
        return *this;
}

References copyFunction(), and Function().

Here is the call graph for this function:

◆ readWriteStream()

template<typename Stream, DataStreamMode::DataStreamMode Mode>

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

inline

Load the current Function with a stream.

Parameters

[out] ds : stream to be used

Returns: true on success, false otherwise

Definition at line 119 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, std::vector<Swarm::Data> >::data_stream(ds, p_vecParam);
                        b &= DataStream<Stream, Mode, Swarm::Data >::data_stream(ds, p_returnValue);
                        return b;
                }

References DataStream< Stream, Mode, Swarm::Data >::data_stream(), p_description, p_name, p_returnValue, and p_vecParam.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDescription()

void Function::setDescription ( const PString & description )

Sets the description of the Function.

Parameters

description : description of the Function

Definition at line 225 of file Representation.cpp.

                                                        {
        p_description = description;
}

References p_description.

◆ setName()

void Function::setName ( const PString & name )

Sets the name of the Function.

Parameters

name	: name of the Function

Definition at line 218 of file Representation.cpp.

                                          {
        p_name = name;
}

References p_name.

◆ setReturnValue()

void Function::setReturnValue ( const Swarm::Data & returnValue )

Sets the returnValue of the Function.

Parameters

returnValue : returnValue of the Function

Definition at line 239 of file Representation.cpp.

                                                          {
        p_returnValue = returnValue;
}

References p_returnValue.

◆ setVecParam()

void Function::setVecParam ( const std::vector< Swarm::Data > & vecParam )

Sets the vecParam of the Function.

Parameters

vecParam : vecParam of the Function

Definition at line 232 of file Representation.cpp.

                                                               {
        p_vecParam = vecParam;
}

References p_vecParam.

Member Data Documentation

◆ p_description

PString Swarm::Function::p_description

private

Description of the Function.

Definition at line 135 of file Representation.h.

Referenced by copyFunction(), getDescription(), getDescription(), initialisationFunction(), readWriteStream(), and setDescription().

◆ p_name

PString Swarm::Function::p_name

private

Name of the Function.

Definition at line 133 of file Representation.h.

Referenced by copyFunction(), getName(), getName(), initialisationFunction(), readWriteStream(), and setName().

◆ p_returnValue

Swarm::Data Swarm::Function::p_returnValue

private

Return value of the Function.

Definition at line 139 of file Representation.h.

Referenced by copyFunction(), getReturnValue(), getReturnValue(), readWriteStream(), and setReturnValue().

◆ p_vecParam

std::vector<Swarm::Data> Swarm::Function::p_vecParam

private

Vector of parameters of the Function.

Definition at line 137 of file Representation.h.

Referenced by copyFunction(), getVecParam(), getVecParam(), readWriteStream(), and setVecParam().

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

◆ Function() [1/2]

◆ ~Function()

◆ Function() [2/2]

Member Function Documentation

◆ copyFunction()

◆ getDescription() [1/2]

◆ getDescription() [2/2]

◆ getName() [1/2]

◆ getName() [2/2]

◆ getReturnValue() [1/2]

◆ getReturnValue() [2/2]

◆ getVecParam() [1/2]

◆ getVecParam() [2/2]

◆ initialisationFunction()

◆ operator=()

◆ readWriteStream()

◆ setDescription()

◆ setName()

◆ setReturnValue()

◆ setVecParam()

Member Data Documentation

◆ p_description

◆ p_name

◆ p_returnValue

◆ p_vecParam