Description of one type of activity. More...

#include <ActivityTemplate.h>

Inheritance diagram for eml2::ActivityTemplate:

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

virtual	~ActivityTemplate ()=default

virtual void	pushBackParameter (const std::string &title, bool isInput, bool isOutput, unsigned int minOccurs, int maxOccurs)=0

virtual void	pushBackParameter (const std::string &title, bool isInput, bool isOutput, unsigned int minOccurs, int maxOccurs, std::string resqmlObjectContentType)=0

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

virtual uint64_t	getParameterCount () const =0

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

virtual std::vector< gsoap_resqml2_0_1::resqml20__ParameterKind >	getParameterAllowedKinds (unsigned int index) const =0

virtual std::vector< gsoap_resqml2_0_1::resqml20__ParameterKind >	getParameterAllowedKinds (const std::string &paramTitle) const =0

virtual bool	getParameterIsInput (unsigned int index) const =0

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

virtual bool	getParameterIsOutput (unsigned int index) const =0

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

virtual uint64_t	getParameterMinOccurences (unsigned int index) const =0

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

virtual uint64_t	getParameterMaxOccurences (unsigned int index) const =0

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

std::vector< Activity * >	getActivityInstanceSet () const

virtual std::string	getXmlTag () const final

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

Detailed Description

Description of one type of activity.

Constructor & Destructor Documentation

◆ ActivityTemplate()

eml2::ActivityTemplate::ActivityTemplate ( 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.

◆ ~ActivityTemplate()

virtual eml2::ActivityTemplate::~ActivityTemplate ( )

virtualdefault

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

Member Function Documentation

◆ getActivityInstanceSet()

std::vector< Activity * > eml2::ActivityTemplate::getActivityInstanceSet ( ) const

Gets the set of activities which are based on this activity template within the repository.

Returns: A vector of pointers to all the activities based on this activity template.

◆ getParameterAllowedKinds() [1/2]

virtual std::vector< gsoap_resqml2_0_1::resqml20__ParameterKind > eml2::ActivityTemplate::getParameterAllowedKinds ( const std::string & paramTitle ) const

pure virtual

Gets parameter allowed kinds

Parameters

paramTitle The parameter title.

Returns: The parameter allowed kinds.

◆ getParameterAllowedKinds() [2/2]

virtual std::vector< gsoap_resqml2_0_1::resqml20__ParameterKind > eml2::ActivityTemplate::getParameterAllowedKinds ( unsigned int index ) const

pure virtual

Gets parameter allowed kinds

Parameters

index Zero-based index of the.

Returns: The parameter allowed kinds.

◆ getParameterCount()

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

pure virtual

Gets the parameter count.

Returns: The parameter count.

◆ getParameterIsInput() [1/2]

virtual bool eml2::ActivityTemplate::getParameterIsInput ( const std::string & paramTitle ) const

pure virtual

Queries if a particular parameter is an input parameter.

Exceptions

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

Parameters

paramTitle The title of the parameter we want to know if it is an input one.

Returns: True is the parameter paramTitle is an input parameter, false if not.

◆ getParameterIsInput() [2/2]

virtual bool eml2::ActivityTemplate::getParameterIsInput ( unsigned int index ) const

pure virtual

Queries if a particular parameter is an input 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 know if it is an input one.

Returns: True is the parameter at index is an input parameter, false if not.

◆ getParameterIsOutput() [1/2]

virtual bool eml2::ActivityTemplate::getParameterIsOutput ( const std::string & paramTitle ) const

pure virtual

Queries if a particular parameter is an output parameter.

Exceptions

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

Parameters

paramTitle The title of the parameter we want to know if it is an output one.

Returns: True is the parameter paramTitle is an output parameter, false if not.

◆ getParameterIsOutput() [2/2]

virtual bool eml2::ActivityTemplate::getParameterIsOutput ( unsigned int index ) const

pure virtual

Queries if a particular parameter is an output 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 know if it is an output one.

Returns: True is the parameter at index is an output parameter, false if not.

◆ getParameterMaxOccurences() [1/2]

virtual uint64_t eml2::ActivityTemplate::getParameterMaxOccurences ( const std::string & paramTitle ) const

pure virtual

Gets the maximum occurrences of a particular parameter.

Exceptions

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

Parameters

paramTitle The title of the parameter we want to know the maximum occurrences.

Returns: The parameter maximum occurrences.

◆ getParameterMaxOccurences() [2/2]

virtual uint64_t eml2::ActivityTemplate::getParameterMaxOccurences ( unsigned int index ) const

pure virtual

Gets the maximum occurrences of a particular 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 know the maximum occurrences.

Returns: The parameter maximum occurrences.

◆ getParameterMinOccurences() [1/2]

virtual uint64_t eml2::ActivityTemplate::getParameterMinOccurences ( const std::string & paramTitle ) const

pure virtual

Gets the minimum occurrences of a particular parameter.

Exceptions

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

Parameters

paramTitle The title of the parameter we want to know the minimum occurrences.

Returns: The parameter minimum occurrences.

◆ getParameterMinOccurences() [2/2]

virtual uint64_t eml2::ActivityTemplate::getParameterMinOccurences ( unsigned int index ) const

pure virtual

Gets the minimum occurrences of a particular 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 know the minimum occurrences.

Returns: The parameter minimum occurrences.

◆ getParameterTitle()

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

pure virtual

Gets the title of a particular parameter.

Exceptions

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

Parameters

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

Returns: The title of the parameter at position index.

◆ isAnExistingParameter()

virtual bool eml2::ActivityTemplate::isAnExistingParameter ( const std::string & paramTitle ) const

pure virtual

Checks if this instance contains a parameter with a particular title.

Parameters

paramTitle The title of the parameter we are looking for into this instance.

Returns: True if there exists a paramTitle parameter in this instance false if not.

◆ pushBackParameter() [1/2]

virtual void eml2::ActivityTemplate::pushBackParameter	(	const std::string &	title,
		bool	isInput,
		bool	isOutput,
		unsigned int	minOccurs,
		int	maxOccurs )

pure virtual

Pushes back a parameter in this activity template instance. This parameter has an unconstrained type.

Exceptions

std::invalid_argument If maxOccurs is strictly lesser than minOccurs.

Parameters

title	The title of the parameter to push back.
isInput	True if the parameter is an input parameter, false if not.
isOutput	True if the parameter is an output parameter, false if not.
minOccurs	The minimum number of occurrences of this parameter.
maxOccurs	The maximum number of occurrences of this parameter.

◆ pushBackParameter() [2/2]

virtual void eml2::ActivityTemplate::pushBackParameter	(	const std::string &	title,
		bool	isInput,
		bool	isOutput,
		unsigned int	minOccurs,
		int	maxOccurs,
		std::string	resqmlObjectContentType )

pure virtual

Pushes back a parameter in the activity template instance. This parameter must be of a RESQML object kind.

Exceptions

std::invalid_argument If maxOccurs is strictly lesser than minOccurs.

Parameters

title	The title of the parameter to push back.
isInput	True if the parameter is an input parameter, false if not.
isOutput	True if the parameter is an output parameter, false if not.
minOccurs	The minimum number of occurrences of this parameter.
maxOccurs	The maximum number of occurrences of this parameter.
resqmlObjectContentType	The content type of the RESQML object kind of the parameter. If empty, there is no constraint on the content type of this parameter.

Member Data Documentation

◆ XML_TAG

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

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/ActivityTemplate.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ActivityTemplate()

◆ ~ActivityTemplate()

Member Function Documentation

◆ getActivityInstanceSet()

◆ getParameterAllowedKinds() [1/2]

◆ getParameterAllowedKinds() [2/2]

◆ getParameterCount()

◆ getParameterIsInput() [1/2]

◆ getParameterIsInput() [2/2]

◆ getParameterIsOutput() [1/2]

◆ getParameterIsOutput() [2/2]

◆ getParameterMaxOccurences() [1/2]

◆ getParameterMaxOccurences() [2/2]

◆ getParameterMinOccurences() [1/2]

◆ getParameterMinOccurences() [2/2]

◆ getParameterTitle()

◆ isAnExistingParameter()

◆ pushBackParameter() [1/2]

◆ pushBackParameter() [2/2]

Member Data Documentation

◆ XML_TAG