#include <ActivityTemplate.h>

Inheritance diagram for resqml2_0_1::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_resqml2_0_1::_resqml20__ActivityTemplate *fromGsoap)

	~ActivityTemplate ()=default

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

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

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

unsigned int	getParameterCount () const final

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

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

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

bool	getParameterIsInput (unsigned int index) const final

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

bool	getParameterIsOutput (unsigned int index) const final

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

int64_t	getParameterMinOccurences (unsigned int index) const final

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

int64_t	getParameterMaxOccurences (unsigned int index) const final

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

std::string	getXmlNamespaceVersion () const final

std::string	getXmlNamespace () const final

Public Member Functions inherited from eml2::ActivityTemplate
	ActivityTemplate (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

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)

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

gsoap_eml2_1::eml21__AbstractObject *	getEml21GsoapProxy () const

gsoap_eml2_2::eml22__AbstractObject *	getEml22GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *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_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_eml2_2::eml22__DataObjectReference *	newEml22Reference () 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	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)

unsigned int	getAliasCount () const

std::string	getAliasAuthorityAtIndex (unsigned int index) const

std::string	getAliasTitleAtIndex (unsigned int index) const

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

unsigned int	getActivityCount () const

eml2::Activity *	getActivity (unsigned int 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

Static Public Attributes
static const char *	XML_NS

Static Public Attributes inherited from eml2::ActivityTemplate
static const char *	XML_TAG

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum	hdfDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 , ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 , USHORT = 8 , CHAR = 9 , UCHAR = 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

An activity template.

Constructor & Destructor Documentation

◆ ActivityTemplate() [1/3]

resqml2_0_1::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]

resqml2_0_1::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]

resqml2_0_1::ActivityTemplate::ActivityTemplate ( gsoap_resqml2_0_1::_resqml20__ActivityTemplate * fromGsoap )

inline

Constructor

Parameters

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

◆ ~ActivityTemplate()

resqml2_0_1::ActivityTemplate::~ActivityTemplate ( )

virtualdefault

Destructor

Reimplemented from eml2::ActivityTemplate.

Member Function Documentation

◆ getParameterAllowedKinds() [1/2]

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

finalvirtual

Gets parameter allowed kinds

Parameters

paramTitle The parameter title.

Returns: The parameter allowed kinds.

Implements eml2::ActivityTemplate.

◆ getParameterAllowedKinds() [2/2]

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

finalvirtual

Gets parameter allowed kinds

Parameters

index Zero-based index of the.

Returns: The parameter allowed kinds.

Implements eml2::ActivityTemplate.

◆ getParameterCount()

unsigned int resqml2_0_1::ActivityTemplate::getParameterCount ( ) const

finalvirtual

Gets parameter count

Returns: The parameter count.

Implements eml2::ActivityTemplate.

◆ getParameterIsInput() [1/2]

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

finalvirtual

Gets parameter is input

Parameters

paramTitle The parameter title.

Returns: The parameter is input.

Implements eml2::ActivityTemplate.

◆ getParameterIsInput() [2/2]

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

finalvirtual

Gets parameter is input

Parameters

index Zero-based index of the.

Returns: The parameter is input.

Implements eml2::ActivityTemplate.

◆ getParameterIsOutput() [1/2]

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

finalvirtual

Gets parameter is output

Parameters

paramTitle The parameter title.

Returns: The parameter is output.

Implements eml2::ActivityTemplate.

◆ getParameterIsOutput() [2/2]

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

finalvirtual

Gets parameter is output

Parameters

index Zero-based index of the.

Returns: The parameter is output.

Implements eml2::ActivityTemplate.

◆ getParameterMaxOccurences() [1/2]

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

finalvirtual

Gets parameter maximum occurences

Parameters

paramTitle The parameter title.

Returns: The parameter maximum occurences.

Implements eml2::ActivityTemplate.

◆ getParameterMaxOccurences() [2/2]

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

finalvirtual

Gets parameter maximum occurences

Parameters

index Zero-based index of the.

Returns: The parameter maximum occurences.

Implements eml2::ActivityTemplate.

◆ getParameterMinOccurences() [1/2]

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

finalvirtual

Gets parameter minimum occurences

Parameters

paramTitle The parameter title.

Returns: The parameter minimum occurences.

Implements eml2::ActivityTemplate.

◆ getParameterMinOccurences() [2/2]

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

finalvirtual

Gets parameter minimum occurences

Parameters

index Zero-based index of the.

Returns: The parameter minimum occurences.

Implements eml2::ActivityTemplate.

◆ getParameterTitle()

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

finalvirtual

Gets parameter title

Parameters

index Zero-based index of the.

Returns: The parameter title.

Implements eml2::ActivityTemplate.

◆ getXmlNamespace()

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

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ getXmlNamespaceVersion()

std::string resqml2_0_1::ActivityTemplate::getXmlNamespaceVersion ( ) const

finalvirtual

******************** MANDATORY FOR GsoapWrapper ******************

Returns: The XML namespace version.

Reimplemented from common::AbstractObject.

◆ isAnExistingParameter()

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

finalvirtual

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.

Implements eml2::ActivityTemplate.

◆ pushBackParameter() [1/3]

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

finalvirtual

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.

Implements eml2::ActivityTemplate.

◆ pushBackParameter() [2/3]

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

finalvirtual

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.

Implements eml2::ActivityTemplate.

◆ pushBackParameter() [3/3]

void resqml2_0_1::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

const char* resqml2_0_1::ActivityTemplate::XML_NS

static

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

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

◆ getXmlNamespaceVersion()

◆ isAnExistingParameter()

◆ pushBackParameter() [1/3]

◆ pushBackParameter() [2/3]

◆ pushBackParameter() [3/3]

Member Data Documentation

◆ XML_NS