Instance of a given activity. More...

#include <Activity.h>

Inheritance diagram for eml2::Activity:

Public Member Functions
	Activity (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

virtual	~Activity ()=default

virtual void	pushBackParameter (const std::string &title, const std::string &value)=0

virtual void	pushBackParameter (const std::string &title, int64_t value)=0

virtual void	pushBackParameter (const std::string &title, AbstractObject *resqmlObject)=0

virtual uint64_t	getParameterCount () const =0

virtual uint64_t	getParameterCount (const std::string &paramTitle) const =0

virtual const std::string &	getParameterTitle (unsigned int index) const =0

virtual std::vector< unsigned int >	getParameterIndexOfTitle (const std::string &paramTitle) const =0

virtual bool	isAFloatingPointQuantityParameter (const std::string &paramTitle) const =0

virtual bool	isAFloatingPointQuantityParameter (unsigned int index) const =0

virtual std::vector< double >	getFloatingPointQuantityParameterValue (const std::string &paramTitle) const =0

virtual double	getFloatingPointQuantityParameterValue (unsigned int index) const =0

virtual bool	isAnIntegerQuantityParameter (const std::string &paramTitle) const =0

virtual bool	isAnIntegerQuantityParameter (unsigned int index) const =0

virtual std::vector< int32_t >	getIntegerQuantityParameterValue (const std::string &paramTitle) const =0

virtual int64_t	getIntegerQuantityParameterValue (unsigned int index) const =0

virtual bool	isAStringParameter (const std::string &paramTitle) const =0
	Queries if all of the parameters sharing a given title are string parameters.

virtual bool	isAStringParameter (unsigned int index) const =0

virtual std::vector< std::string >	getStringParameterValue (const std::string &paramTitle) const =0

virtual const std::string &	getStringParameterValue (unsigned int index) const =0

virtual bool	isAResqmlObjectParameter (const std::string &paramTitle) const =0

virtual bool	isAResqmlObjectParameter (unsigned int index) const =0

virtual std::vector< AbstractObject * >	getResqmlObjectParameterValue (const std::string &paramTitle) const =0

virtual AbstractObject *	getResqmlObjectParameterValue (unsigned int index) const =0

virtual void	setActivityTemplate (ActivityTemplate *activityTemplate)=0

virtual common::DataObjectReference	getActivityTemplateDor () const =0

ActivityTemplate *	getActivityTemplate () const

std::vector< AbstractObject * >	getResqmlObjectSet () const

virtual std::string	getXmlTag () const final

Static Public Attributes
static constexpr char const *	XML_TAG = "Activity"

Detailed Description

Instance of a given activity.

Constructor & Destructor Documentation

◆ Activity()

eml2::Activity::Activity ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

Parameters

[in] partialObject If non-null, the partial object.

◆ ~Activity()

virtual eml2::Activity::~Activity ( )

virtualdefault

Destructor does nothing since the memory is managed by the gSOAP context.

Member Function Documentation

◆ getActivityTemplate()

ActivityTemplate * eml2::Activity::getActivityTemplate ( ) const

Gets the activity template of this activity.

Returns: The activity template of this activity.

◆ getActivityTemplateDor()

virtual common::DataObjectReference eml2::Activity::getActivityTemplateDor ( ) const

pure virtual

Gets the data object reference of the activity template of this activity.

Returns: The data object reference of the activity template.

◆ getFloatingPointQuantityParameterValue() [1/2]

virtual std::vector< double > eml2::Activity::getFloatingPointQuantityParameterValue ( const std::string & paramTitle ) const

pure virtual

Gets the values of all the floating point quantity parameters sharing a given title.

Exceptions

std::invalid_argument	If there exists no `paramTitle` parameter in this activity.
std::invalid_argument	If one `paramTitle` parameter contains some non double values.

Parameters

paramTitle The title of the floating point parameters we look for the value.

Returns: A vector of the value of all the paramTitle floating point quantity parameters.

◆ getFloatingPointQuantityParameterValue() [2/2]

virtual double eml2::Activity::getFloatingPointQuantityParameterValue ( unsigned int index ) const

pure virtual

Gets the floating point quantity value of a given parameter.

Exceptions

std::out_of_range	If `index` is not in the parameter range.
std::invalid_argument	If the parameter at `index` is not a floating point quantity parameter.

Parameters

index Zero-based index of the parameter we look for the value. This index is taken in the set of all parameters of this activity.

Returns: The floating point quantity value of the parameter at position index.

◆ getIntegerQuantityParameterValue() [1/2]

virtual std::vector< int32_t > eml2::Activity::getIntegerQuantityParameterValue ( const std::string & paramTitle ) const

pure virtual

Gets the values of all the integer quantity parameters sharing a given title.

Exceptions

std::invalid_argument	If there exists no `paramTitle` parameter in this activity.
std::invalid_argument	If one `paramTitle` parameter contains some non integer values.

Parameters

paramTitle The title of the integer parameters we look for the value.

Returns: A vector of the value of all the paramTitle integer quantity parameters.

◆ getIntegerQuantityParameterValue() [2/2]

virtual int64_t eml2::Activity::getIntegerQuantityParameterValue ( unsigned int index ) const

pure virtual

Gets the integer quantity value of a given parameter.

Exceptions

std::out_of_range	If `index` is not in the parameter range.
std::invalid_argument	If the parameter at `index` is not an integer quantity parameter.

Parameters

index Zero-based index of the parameter we look for the value. This index is taken in the set of all parameters of this activity.

Returns: The integer quantity value of the parameter at position index.

◆ getParameterCount() [1/2]

virtual uint64_t eml2::Activity::getParameterCount ( ) const

pure virtual

Get the count of all the parameters

Returns: The parameter count.

◆ getParameterCount() [2/2]

virtual uint64_t eml2::Activity::getParameterCount ( const std::string & paramTitle ) const

pure virtual

Gets the count of all the parameters which have the same title.

Parameters

paramTitle The title of the parameters we look for.

Returns: The parameter count.

◆ getParameterIndexOfTitle()

virtual std::vector< unsigned int > eml2::Activity::getParameterIndexOfTitle ( const std::string & paramTitle ) const

pure virtual

Gets the indices of all the parameters sharing a given title.

Parameters

paramTitle The title of the parameters we look for.

Returns: A vector of parameter indices.

◆ getParameterTitle()

virtual const std::string & eml2::Activity::getParameterTitle ( unsigned int index ) const

pure virtual

Gets the title of a given parameter

Exceptions

std::out_of_range If index is not in the parameter range.

Parameters

index Zero-based index of the parameter for which we look for the title.

Returns: The parameter title.

◆ getResqmlObjectParameterValue() [1/2]

virtual std::vector< AbstractObject * > eml2::Activity::getResqmlObjectParameterValue ( const std::string & paramTitle ) const

pure virtual

Gets the values of all the RESQML object parameters sharing a given title.

Exceptions

std::invalid_argument	If there exists no `paramTitle` parameter in this activity.
std::invalid_argument	If one `paramTitle` parameter contains some non RESQML object values.

Parameters

paramTitle The title of the RESQML object parameters we look for the value.

Returns: A vector of the value of all the paramTitle RESQML object parameters.

◆ getResqmlObjectParameterValue() [2/2]

virtual AbstractObject * eml2::Activity::getResqmlObjectParameterValue ( unsigned int index ) const

pure virtual

Gets the RESQML object value of a given parameter.

Exceptions

std::out_of_range	If `index` is not in the parameter range.
std::invalid_argument	If the parameter at `index` is not an RESQML object parameter.

Parameters

index Zero-based index of the parameter we look for the value. This index is taken in the set of all parameters of this activity.

Returns: The RESQML object value of the parameter at position index.

◆ getResqmlObjectSet()

std::vector< AbstractObject * > eml2::Activity::getResqmlObjectSet ( ) const

Gets all the RESQML objects which are either input or output of this activity. That is to say all of the values of the RESQML object parameters of this activity.

Returns: A vector of pointers to the RESQML objects which are either input or output of this activity.

◆ getStringParameterValue() [1/2]

virtual std::vector< std::string > eml2::Activity::getStringParameterValue ( const std::string & paramTitle ) const

pure virtual

Gets the values of all the string parameters sharing a given title.

Exceptions

std::invalid_argument	If there exists no `paramTitle` parameter in this activity.
std::invalid_argument	If one `paramTitle` parameter contains some non string values.

Parameters

paramTitle The title of the string parameters we look for the value.

Returns: A vector of the value of all the paramTitle string parameters.

◆ getStringParameterValue() [2/2]

virtual const std::string & eml2::Activity::getStringParameterValue ( unsigned int index ) const

pure virtual

Gets the string value of a given parameter.

Exceptions

std::out_of_range	If `index` is not in the parameter range.
std::invalid_argument	If the parameter at `index` is not an string parameter.

Parameters

index Zero-based index of the parameter we look for the value. This index is taken in the set of all parameters of this activity.

Returns: The string value of the parameter at position index.

◆ isAFloatingPointQuantityParameter() [1/2]

virtual bool eml2::Activity::isAFloatingPointQuantityParameter ( const std::string & paramTitle ) const

pure virtual

Queries if all of the parameters sharing a given title are floating point quantity parameters.

Exceptions

std::invalid_argument If there exists no paramTitle parameter in this activity.

Parameters

paramTitle The title of the parameters we want to test the datatype.

Returns: True if all of the paramTitle parameters are floating point quantity parameters, false if not.

◆ isAFloatingPointQuantityParameter() [2/2]

virtual bool eml2::Activity::isAFloatingPointQuantityParameter ( unsigned int index ) const

pure virtual

Queries if a given parameter is a floating point quantity parameter.

Exceptions

std::out_of_range If index is not in the parameter range.

Parameters

index Zero-based index of the parameter we want to test the datatype.

Returns: True if the parameter at position index is a floating point quantity parameter, false if not.

◆ isAnIntegerQuantityParameter() [1/2]

virtual bool eml2::Activity::isAnIntegerQuantityParameter ( const std::string & paramTitle ) const

pure virtual

Queries if all of the parameters sharing a given title are integer quantity parameters.

Exceptions

std::invalid_argument If there exists no paramTitle parameter in this activity.

Parameters

paramTitle The title of the parameters we want to test the datatype.

Returns: True if all of the paramTitle parameters are integer quantity parameters, false if not.

◆ isAnIntegerQuantityParameter() [2/2]

virtual bool eml2::Activity::isAnIntegerQuantityParameter ( unsigned int index ) const

pure virtual

Queries if a given parameter is an integer quantity parameter.

Exceptions

std::out_of_range If index is not in the parameter range.

Parameters

index Zero-based index of the parameter we want to test the datatype.

Returns: True if the parameter at position index is an integer quantity parameter, false if not.

◆ isAResqmlObjectParameter() [1/2]

virtual bool eml2::Activity::isAResqmlObjectParameter ( const std::string & paramTitle ) const

pure virtual

Queries if all of the parameters sharing a given title are RESQML object parameters.

Exceptions

std::invalid_argument If there exists no paramTitle parameter in this activity.

Parameters

paramTitle The title of the parameters we want to test the datatype.

Returns: True if all of the paramTitle parameters are RESQML object parameters, false if not.

◆ isAResqmlObjectParameter() [2/2]

virtual bool eml2::Activity::isAResqmlObjectParameter ( unsigned int index ) const

pure virtual

Queries if a given parameter is a RESQML object parameter.

Exceptions

std::out_of_range If index is not in the parameter range.

Parameters

index Zero-based index of the parameter we want to test the datatype.

Returns: True if the parameter at position index is a RESQML object parameter, false if not.

◆ isAStringParameter() [1/2]

virtual bool eml2::Activity::isAStringParameter ( const std::string & paramTitle ) const

pure virtual

Queries if all of the parameters sharing a given title are string parameters.

Exceptions

std::invalid_argument If there exists no paramTitle parameter in this activity.

Parameters

paramTitle The title of the parameters we want to test the datatype.

Returns: True if all of the paramTitle parameters are string parameters, false if not.

◆ isAStringParameter() [2/2]

virtual bool eml2::Activity::isAStringParameter ( unsigned int index ) const

pure virtual

Queries if a given parameter is a string parameter.

Exceptions

std::out_of_range If index is not in the parameter range.

Parameters

index Zero-based index of the parameter we want to test the datatype.

Returns: True if the parameter at position index is a string parameter, false if not.

◆ pushBackParameter() [1/3]

virtual void eml2::Activity::pushBackParameter	(	const std::string &	title,
		AbstractObject *	resqmlObject )

pure virtual

Pushes back a RESQML object parameter in this instance. This parameter must exist in the associated activity template.

Exceptions

std::invalid_argument	If `resqmlObject` is null.
std::invalid_argument	If the parameter `title` does not exist in the associated activity template.
std::invalid_argument	If the maximum number of occurrences has already been reached for parameter `title`.
std::invalid_argument	If The parameter template `title` does not allow a a data object datatype.

Parameters

	title	The title of the parameter to push back.
[in]	resqmlObject	The RESQML object, value of the parameter to push back.

◆ pushBackParameter() [2/3]

virtual void eml2::Activity::pushBackParameter	(	const std::string &	title,
		const std::string &	value )

pure virtual

Pushes back a string parameter in this instance. This parameter must exist in the associated activity template.

Exceptions

std::invalid_argument	If the parameter `title` does not exist in the associated activity template.
std::invalid_argument	If the maximum number of occurrences has already been reached for parameter `title`.
std::invalid_argument	If The parameter template `title` does not allow a string datatype.

Parameters

title	The title of the parameter to push back.
value	The value of the parameter to push back.

◆ pushBackParameter() [3/3]

virtual void eml2::Activity::pushBackParameter	(	const std::string &	title,
		int64_t	value )

pure virtual

Pushes back an integer parameter in this instance. This parameter must exist in the associated activity template.

Exceptions

std::invalid_argument	If the parameter `title` does not exist in the associated activity template.
std::invalid_argument	If the maximum number of occurrences has already been reached for parameter `title`.
std::invalid_argument	If The parameter template `title` does not allow a an integer datatype.

Parameters

title	The title of the parameter to push back.
value	The value of the parameter to push back.

◆ setActivityTemplate()

virtual void eml2::Activity::setActivityTemplate ( ActivityTemplate * activityTemplate )

pure virtual

Sets the activity template of this activity.

Parameters

[in] activityTemplate If non-null, the activity template.

Member Data Documentation

◆ XML_TAG

constexpr char const* eml2::Activity::XML_TAG = "Activity"

staticconstexpr

The standard XML tag without XML namespace for serializing this data object

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/eml2/Activity.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Activity()

◆ ~Activity()

Member Function Documentation

◆ getActivityTemplate()

◆ getActivityTemplateDor()

◆ getFloatingPointQuantityParameterValue() [1/2]

◆ getFloatingPointQuantityParameterValue() [2/2]

◆ getIntegerQuantityParameterValue() [1/2]

◆ getIntegerQuantityParameterValue() [2/2]

◆ getParameterCount() [1/2]

◆ getParameterCount() [2/2]

◆ getParameterIndexOfTitle()

◆ getParameterTitle()

◆ getResqmlObjectParameterValue() [1/2]

◆ getResqmlObjectParameterValue() [2/2]

◆ getResqmlObjectSet()

◆ getStringParameterValue() [1/2]

◆ getStringParameterValue() [2/2]

◆ isAFloatingPointQuantityParameter() [1/2]

◆ isAFloatingPointQuantityParameter() [2/2]

◆ isAnIntegerQuantityParameter() [1/2]

◆ isAnIntegerQuantityParameter() [2/2]

◆ isAResqmlObjectParameter() [1/2]

◆ isAResqmlObjectParameter() [2/2]

◆ isAStringParameter() [1/2]

◆ isAStringParameter() [2/2]

◆ pushBackParameter() [1/3]

◆ pushBackParameter() [2/3]

◆ pushBackParameter() [3/3]

◆ setActivityTemplate()

Member Data Documentation

◆ XML_TAG