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, uint64_t minOccurs, int64_t maxOccurs)=0

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

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

virtual uint64_t	getParameterCount () const =0

virtual std::string	getParameterTitle (uint64_t index) const =0

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

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

virtual bool	getParameterIsInput (uint64_t index) const =0

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

virtual bool	getParameterIsOutput (uint64_t index) const =0

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

virtual int64_t	getParameterMinOccurences (uint64_t index) const =0

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

virtual int64_t	getParameterMaxOccurences (uint64_t index) const =0

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

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

virtual std::string	getXmlTag () const final

Public Member Functions inherited from common::AbstractObject
bool	isPartial () const

virtual bool	isTopLevelElement () const

std::string	getUuid () const

std::string	getTitle () const

std::string	getEditor () const

time_t	getCreation () const

tm	getCreationAsTimeStructure () const

std::string	getOriginator () const

std::string	getDescription () const

time_t	getLastUpdate () const

tm	getLastUpdateAsTimeStructure () const

std::string	getFormat () const

std::string	getDescriptiveKeywords () const

std::string	getVersion () const

void	setTitle (const std::string &title)

void	setEditor (const std::string &editor)

void	setCreation (time_t creation)

void	setCreation (const tm &creation)

void	setOriginator (const std::string &originator)

void	setDescription (const std::string &description)

void	setLastUpdate (time_t lastUpdate)

void	setLastUpdate (const tm &lastUpdate)

void	setDescriptiveKeywords (const std::string &descriptiveKeywords)

void	setVersion (const std::string &version)

void	setMetadata (const std::string &title, const std::string &editor, time_t creation, const std::string &originator, const std::string &description, time_t lastUpdate, const std::string &descriptiveKeywords)

void	serializeIntoStream (std::ostream *stream)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

gsoap_eml2_3::eml23__AbstractObject *	getEml23GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_3::eml23__AbstractObject *gsoapProxy)

soap *	getGsoapContext () const

int	getGsoapType () const

gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const

gsoap_eml2_3::eml23__DataObjectReference *	newEml23Reference () const

gsoap_resqml2_0_1::resqml20__ContactElementReference *	newContactElementReference2_0_1 () const

gsoap_eml2_3::resqml22__ContactElement *	newContactElementReference2_2 () const

common::DataObjectRepository *	getRepository () const

virtual std::string	getXmlNamespace () const =0

virtual std::string	getXmlNamespaceVersion () const

virtual std::string	getContentType () const

virtual std::string	getQualifiedType () const

virtual std::string	getPartNameInEpcDocument () const

std::string	serializeIntoString ()

void	addAlias (const std::string &authority, const std::string &title)

uint64_t	getAliasCount () const

std::string	getAliasAuthorityAtIndex (uint64_t index) const

std::string	getAliasTitleAtIndex (uint64_t index) const

std::vector< eml2::Activity * >	getActivitySet () const

uint64_t	getActivityCount () const

eml2::Activity *	getActivity (uint64_t index) const

void	pushBackExtraMetadata (const std::string &key, const std::string &value)

std::unordered_map< std::string, std::string >	getExtraMetadataSet () const

std::vector< std::string >	getExtraMetadata (const std::string &key) const

unsigned int	getExtraMetadataCount () const

std::string	getExtraMetadataKeyAtIndex (unsigned int index) const

std::string	getExtraMetadataStringValueAtIndex (unsigned int index) const

std::string	buildEtp12Uri () const

void	setUriSource (const std::string &uriSource)

const std::string &	getUriSource () const

std::string	getEpcSourceFolder () const

void	changeToPartialObject ()

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

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum class	numericalDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 , UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 , UINT16 = 8 , INT8 = 9 , UINT8 = 10 }

Static Public Member Functions inherited from common::AbstractObject
static void	setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)

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.

Reimplemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

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.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ getParameterAllowedKinds() [2/2]

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

pure virtual

Gets parameter allowed kinds

Parameters

index Zero-based index of the.

Returns: The parameter allowed kinds.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ getParameterCount()

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

pure virtual

Gets the parameter count.

Returns: The parameter count.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ 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.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ getParameterIsInput() [2/2]

virtual bool eml2::ActivityTemplate::getParameterIsInput ( uint64_t 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.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ 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.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ getParameterIsOutput() [2/2]

virtual bool eml2::ActivityTemplate::getParameterIsOutput ( uint64_t 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.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ getParameterMaxOccurences() [1/2]

virtual int64_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.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ getParameterMaxOccurences() [2/2]

virtual int64_t eml2::ActivityTemplate::getParameterMaxOccurences ( uint64_t 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.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ getParameterMinOccurences() [1/2]

virtual int64_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.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ getParameterMinOccurences() [2/2]

virtual int64_t eml2::ActivityTemplate::getParameterMinOccurences ( uint64_t 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.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ getParameterTitle()

virtual std::string eml2::ActivityTemplate::getParameterTitle ( uint64_t 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.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ getXmlTag()

virtual std::string eml2::ActivityTemplate::getXmlTag ( ) const

inlinefinalvirtual

Gets the standard XML tag without XML namespace for serializing this data object.

Returns: The XML tag.

Implements common::AbstractObject.

◆ 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.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ pushBackParameter() [1/2]

virtual void eml2::ActivityTemplate::pushBackParameter	(	const std::string &	title,
		bool	isInput,
		bool	isOutput,
		uint64_t	minOccurs,
		int64_t	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.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

◆ pushBackParameter() [2/2]

virtual void eml2::ActivityTemplate::pushBackParameter	(	const std::string &	title,
		bool	isInput,
		bool	isOutput,
		uint64_t	minOccurs,
		int64_t	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.

Implemented in eml2_3::ActivityTemplate, and resqml2_0_1::ActivityTemplate.

Member Data Documentation

◆ XML_TAG

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

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

◆ getXmlTag()

◆ isAnExistingParameter()

◆ pushBackParameter() [1/2]

◆ pushBackParameter() [2/2]

Member Data Documentation

◆ XML_TAG