#include <ActivityTemplate.h>

Inheritance diagram for eml2_3::ActivityTemplate:

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

	ActivityTemplate (common ::DataObjectRepository *repo, const std::string &guid, const std::string &title)

	ActivityTemplate (gsoap_eml2_3::_eml23__ActivityTemplate *fromGsoap)

	~ActivityTemplate ()=default

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

void	pushBackParameter (const std::string &title, gsoap_resqml2_0_1::resqml20__ParameterKind kind, bool isInput, bool isOutput, unsigned int minOccurs, int maxOccurs)

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

bool	isAnExistingParameter (const std::string &paramTitle) const

uint64_t	getParameterCount () const

const std::string &	getParameterTitle (unsigned int index) const

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

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

bool	getParameterIsInput (unsigned int index) const

bool	getParameterIsInput (const std::string &paramTitle) const

bool	getParameterIsOutput (unsigned int index) const

bool	getParameterIsOutput (const std::string &paramTitle) const

int64_t	getParameterMinOccurences (unsigned int index) const

int64_t	getParameterMinOccurences (const std::string &paramTitle) const

int64_t	getParameterMaxOccurences (unsigned int index) const

int64_t	getParameterMaxOccurences (const std::string &paramTitle) const

std::string	getXmlNamespace () const final

Static Public Attributes
static constexpr char const *	XML_NS = "eml23"

Detailed Description

An activity template.

Constructor & Destructor Documentation

◆ ActivityTemplate() [1/3]

eml2_3::ActivityTemplate::ActivityTemplate ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

Parameters

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

◆ ActivityTemplate() [2/3]

eml2_3::ActivityTemplate::ActivityTemplate	(	common ::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title
	)

Creates an instance of this class in a gsoap context.

Parameters

[in,out]	repo	The repository where the underlying gsoap proxy is going to be created.
	guid	The guid to set to the boundary horizon. If empty then a new guid will be generated.
	title	A title for the instance to create.

◆ ActivityTemplate() [3/3]

eml2_3::ActivityTemplate::ActivityTemplate ( gsoap_eml2_3::_eml23__ActivityTemplate * fromGsoap )

inline

Constructor

Parameters

[in,out] fromGsoap If non-null, from gsoap.

◆ ~ActivityTemplate()

eml2_3::ActivityTemplate::~ActivityTemplate ( )

default

Destructor

Member Function Documentation

◆ getParameterAllowedKinds() [1/2]

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

Gets parameter allowed kinds

Parameters

paramTitle The parameter title.

Returns: The parameter allowed kinds.

◆ getParameterAllowedKinds() [2/2]

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

Gets parameter allowed kinds

Parameters

index Zero-based index of the.

Returns: The parameter allowed kinds.

◆ getParameterCount()

uint64_t eml2_3::ActivityTemplate::getParameterCount ( ) const

Gets parameter count

Returns: The parameter count.

◆ getParameterIsInput() [1/2]

bool eml2_3::ActivityTemplate::getParameterIsInput ( const std::string & paramTitle ) const

Gets parameter is input

Parameters

paramTitle The parameter title.

Returns: The parameter is input.

◆ getParameterIsInput() [2/2]

bool eml2_3::ActivityTemplate::getParameterIsInput ( unsigned int index ) const

Gets parameter is input

Parameters

index Zero-based index of the.

Returns: The parameter is input.

◆ getParameterIsOutput() [1/2]

bool eml2_3::ActivityTemplate::getParameterIsOutput ( const std::string & paramTitle ) const

Gets parameter is output

Parameters

paramTitle The parameter title.

Returns: The parameter is output.

◆ getParameterIsOutput() [2/2]

bool eml2_3::ActivityTemplate::getParameterIsOutput ( unsigned int index ) const

Gets parameter is output

Parameters

index Zero-based index of the.

Returns: The parameter is output.

◆ getParameterMaxOccurences() [1/2]

int64_t eml2_3::ActivityTemplate::getParameterMaxOccurences ( const std::string & paramTitle ) const

Gets parameter maximum occurences

Parameters

paramTitle The parameter title.

Returns: The parameter maximum occurences.

◆ getParameterMaxOccurences() [2/2]

int64_t eml2_3::ActivityTemplate::getParameterMaxOccurences ( unsigned int index ) const

Gets parameter maximum occurences

Parameters

index Zero-based index of the.

Returns: The parameter maximum occurences.

◆ getParameterMinOccurences() [1/2]

int64_t eml2_3::ActivityTemplate::getParameterMinOccurences ( const std::string & paramTitle ) const

Gets parameter minimum occurences

Parameters

paramTitle The parameter title.

Returns: The parameter minimum occurences.

◆ getParameterMinOccurences() [2/2]

int64_t eml2_3::ActivityTemplate::getParameterMinOccurences ( unsigned int index ) const

Gets parameter minimum occurences

Parameters

index Zero-based index of the.

Returns: The parameter minimum occurences.

◆ getParameterTitle()

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

Gets parameter title

Parameters

index Zero-based index of the.

Returns: The parameter title.

◆ getXmlNamespace()

std::string eml2_3::ActivityTemplate::getXmlNamespace ( ) const

inlinefinal

Get the standard XML namespace for serializing this data object.

◆ isAnExistingParameter()

bool eml2_3::ActivityTemplate::isAnExistingParameter ( const std::string & paramTitle ) const

Check if the instance contains a parameter with a particular title

Parameters

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

Returns: True if an existing parameter, false if not.

◆ pushBackParameter() [1/3]

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

Push back a parameter in the activity template instance. This parameter has an unconstrained type.

Parameters

title	The title.
isInput	True if is input, false if not.
isOutput	True if is output, false if not.
minOccurs	The minimum occurs.
maxOccurs	The maximum occurs.

◆ pushBackParameter() [2/3]

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

Push back a parameter in the activity template instance. This parameter must be of a data object kind.

Parameters

title	The title.
isInput	True if is input, false if not.
isOutput	True if is output, false if not.
minOccurs	The minimum occurs.
maxOccurs	The maximum occurs.
resqmlObjectContentType	If empty, there is no constraint on the content type of this parameter.

◆ pushBackParameter() [3/3]

void eml2_3::ActivityTemplate::pushBackParameter	(	const std::string &	title,
		gsoap_resqml2_0_1::resqml20__ParameterKind	kind,
		bool	isInput,
		bool	isOutput,
		unsigned int	minOccurs,
		int	maxOccurs
	)

Push back a parameter in the activity template instance. This parameter must not be of a data object kind.

Parameters

title	The title.
kind	The kind.
isInput	True if is input, false if not.
isOutput	True if is output, false if not.
minOccurs	The minimum occurs.
maxOccurs	The maximum occurs.

Member Data Documentation

◆ XML_NS

constexpr char const* eml2_3::ActivityTemplate::XML_NS = "eml23"

staticconstexpr

The standard 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.7.0.0/src/eml2_3/ActivityTemplate.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ActivityTemplate() [1/3]

◆ ActivityTemplate() [2/3]

◆ ActivityTemplate() [3/3]

◆ ~ActivityTemplate()

Member Function Documentation

◆ 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()

◆ getXmlNamespace()

◆ isAnExistingParameter()

◆ pushBackParameter() [1/3]

◆ pushBackParameter() [2/3]

◆ pushBackParameter() [3/3]

Member Data Documentation

◆ XML_NS