#include <Activity.h>

Inheritance diagram for eml2_3::Activity:

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

	Activity (eml2 ::ActivityTemplate *activityTemplate, const std::string &guid, const std::string &title)
	Creates an instance of this class in a gsoap context.

	Activity (gsoap_eml2_3::_eml23__Activity *fromGsoap)

	~Activity ()=default

void	pushBackParameter (const std::string &title, double value, gsoap_resqml2_0_1::resqml20__ResqmlUom uom=gsoap_resqml2_0_1::resqml20__ResqmlUom::Euc)

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

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

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

uint64_t	getParameterCount () const

uint64_t	getParameterCount (const std::string &paramTitle) const

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

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

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

bool	isAFloatingPointQuantityParameter (unsigned int index) const

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

double	getFloatingPointQuantityParameterValue (unsigned int index) const

std::vector< gsoap_resqml2_0_1::resqml20__ResqmlUom >	getFloatingPointQuantityParameterUom (const std::string &paramTitle) const

gsoap_resqml2_0_1::resqml20__ResqmlUom	getFloatingPointQuantityParameterUom (unsigned int index) const

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

bool	isAnIntegerQuantityParameter (unsigned int index) const

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

int64_t	getIntegerQuantityParameterValue (unsigned int index) const

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

bool	isAStringParameter (unsigned int index) const

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

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

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

bool	isAResqmlObjectParameter (unsigned int index) const

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

AbstractObject *	getResqmlObjectParameterValue (unsigned int index) const

void	setActivityTemplate (eml2 ::ActivityTemplate *activityTemplate)

common::DataObjectReference	getActivityTemplateDor () const

std::string	getXmlNamespace () const final

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

Detailed Description

An activity.

Constructor & Destructor Documentation

◆ Activity() [1/3]

eml2_3::Activity::Activity ( 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.

◆ Activity() [2/3]

eml2_3::Activity::Activity	(	eml2 ::ActivityTemplate *	activityTemplate,
		const std::string &	guid,
		const std::string &	title )

Creates an instance of this class in a gsoap context.

Exceptions

std::invalid_argument If activityTemplate == nullptr.

Parameters

[in]	activityTemplate	If non-null, the activity template.
	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.

◆ Activity() [3/3]

eml2_3::Activity::Activity ( gsoap_eml2_3::_eml23__Activity * fromGsoap )

inline

Constructor

Parameters

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

◆ ~Activity()

eml2_3::Activity::~Activity ( )

default

Destructor

Member Function Documentation

◆ getActivityTemplateDor()

common::DataObjectReference eml2_3::Activity::getActivityTemplateDor ( ) const

Gets activity template dor

Returns: Empty data object reference if it fails, else the activity template data object reference.

◆ getFloatingPointQuantityParameterUom() [1/2]

std::vector< gsoap_resqml2_0_1::resqml20__ResqmlUom > eml2_3::Activity::getFloatingPointQuantityParameterUom ( const std::string & paramTitle ) const

Gets floating point quantity parameter uom

Parameters

paramTitle The parameter title.

Returns: The floating point quantity parameter uom.

◆ getFloatingPointQuantityParameterUom() [2/2]

gsoap_resqml2_0_1::resqml20__ResqmlUom eml2_3::Activity::getFloatingPointQuantityParameterUom ( unsigned int index ) const

Gets floating point quantity parameter uom

Parameters

index Zero-based index of the.

Returns: The floating point quantity parameter uom.

◆ getFloatingPointQuantityParameterValue() [1/2]

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

Gets floating point quantity parameter value

Parameters

paramTitle The parameter title.

Returns: The floating point quantity parameter value.

◆ getFloatingPointQuantityParameterValue() [2/2]

double eml2_3::Activity::getFloatingPointQuantityParameterValue ( unsigned int index ) const

Gets floating point quantity parameter value

Parameters

index Zero-based index of the.

Returns: The floating point quantity parameter value.

◆ getIntegerQuantityParameterValue() [1/2]

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

Gets integer quantity parameter value

Parameters

paramTitle The parameter title.

Returns: The integer quantity parameter value.

◆ getIntegerQuantityParameterValue() [2/2]

int64_t eml2_3::Activity::getIntegerQuantityParameterValue ( unsigned int index ) const

Gets integer quantity parameter value

Parameters

index Zero-based index of the.

Returns: The integer quantity parameter value.

◆ getParameterCount() [1/2]

uint64_t eml2_3::Activity::getParameterCount ( ) const

Get the count of all the parameters

Returns: The parameter count.

◆ getParameterCount() [2/2]

uint64_t eml2_3::Activity::getParameterCount ( const std::string & paramTitle ) const

Get the count of all the parameters which have got the same title.

Parameters

paramTitle The parameter title.

Returns: The parameter count.

◆ getParameterIndexOfTitle()

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

Gets parameter index of title

Parameters

paramTitle The parameter title.

Returns: The parameter index of title.

◆ getParameterTitle()

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

Gets parameter title

Parameters

index Zero-based index of the.

Returns: The parameter title.

◆ getResqmlObjectParameterValue() [1/2]

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

Gets resqml object parameter value

Parameters

paramTitle The parameter title.

Returns: Null if it fails, else the resqml object parameter value.

◆ getResqmlObjectParameterValue() [2/2]

AbstractObject * eml2_3::Activity::getResqmlObjectParameterValue ( unsigned int index ) const

Gets resqml object parameter value

Parameters

index Zero-based index of the.

Returns: Null if it fails, else the resqml object parameter value.

◆ getStringParameterValue() [1/2]

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

Gets string parameter value

Parameters

paramTitle The parameter title.

Returns: The string parameter value.

◆ getStringParameterValue() [2/2]

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

Gets string parameter value

Parameters

index Zero-based index of the.

Returns: The string parameter value.

◆ getXmlNamespace()

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

inlinefinal

Get the standard XML namespace for serializing this data object.

◆ isAFloatingPointQuantityParameter() [1/2]

bool eml2_3::Activity::isAFloatingPointQuantityParameter ( const std::string & paramTitle ) const

Query if 'paramTitle' is a floating point quantity parameter

Parameters

paramTitle The parameter title.

Returns: True if a floating point quantity parameter, false if not.

◆ isAFloatingPointQuantityParameter() [2/2]

bool eml2_3::Activity::isAFloatingPointQuantityParameter ( unsigned int index ) const

Query if 'index' is a floating point quantity parameter

Parameters

index Zero-based index of the.

Returns: True if a floating point quantity parameter, false if not.

◆ isAnIntegerQuantityParameter() [1/2]

bool eml2_3::Activity::isAnIntegerQuantityParameter ( const std::string & paramTitle ) const

Query if 'paramTitle' is an integer quantity parameter

Parameters

paramTitle The parameter title.

Returns: True if an integer quantity parameter, false if not.

◆ isAnIntegerQuantityParameter() [2/2]

bool eml2_3::Activity::isAnIntegerQuantityParameter ( unsigned int index ) const

Query if 'index' is an integer quantity parameter

Parameters

index Zero-based index of the.

Returns: True if an integer quantity parameter, false if not.

◆ isAResqmlObjectParameter() [1/2]

bool eml2_3::Activity::isAResqmlObjectParameter ( const std::string & paramTitle ) const

Query if 'paramTitle' is a resqml object parameter

Parameters

paramTitle The parameter title.

Returns: True if a resqml object parameter, false if not.

◆ isAResqmlObjectParameter() [2/2]

bool eml2_3::Activity::isAResqmlObjectParameter ( unsigned int index ) const

Query if 'index' is a resqml object parameter

Parameters

index Zero-based index of the.

Returns: True if a resqml object parameter, false if not.

◆ isAStringParameter() [1/2]

bool eml2_3::Activity::isAStringParameter ( const std::string & paramTitle ) const

Query if 'paramTitle' is a string parameter

Parameters

paramTitle The parameter title.

Returns: True if a string parameter, false if not.

◆ isAStringParameter() [2/2]

bool eml2_3::Activity::isAStringParameter ( unsigned int index ) const

Query if 'index' is a string parameter

Parameters

index Zero-based index of the.

Returns: True if a string parameter, false if not.

◆ pushBackParameter() [1/4]

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

Push back a resqml object parameter in the instance. This parameter must exist in the associated activity template.

Parameters

	title	The title.
[in,out]	resqmlObject	If non-null, the resqml object.

◆ pushBackParameter() [2/4]

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

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

Parameters

title	The title.
value	The value.

◆ pushBackParameter() [3/4]

void eml2_3::Activity::pushBackParameter	(	const std::string &	title,
		double	value,
		gsoap_resqml2_0_1::resqml20__ResqmlUom	uom = gsoap_resqml2_0_1::resqml20__ResqmlUom::Euc )

Push back a double parameter in the instance. This parameter must exist in the associated activity template.

Parameters

title	The title.
value	The value.
uom	(Optional) The uom.

◆ pushBackParameter() [4/4]

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

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

Parameters

title	The title.
value	The value.

◆ setActivityTemplate()

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

Set the activity template of the activity

Parameters

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

Member Data Documentation

◆ XML_NS

constexpr char const* eml2_3::Activity::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.9.0.1/src/eml2_3/Activity.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Activity() [1/3]

◆ Activity() [2/3]

◆ Activity() [3/3]

◆ ~Activity()

Member Function Documentation

◆ getActivityTemplateDor()

◆ getFloatingPointQuantityParameterUom() [1/2]

◆ getFloatingPointQuantityParameterUom() [2/2]

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

◆ getStringParameterValue() [1/2]

◆ getStringParameterValue() [2/2]

◆ getXmlNamespace()

◆ 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/4]

◆ pushBackParameter() [2/4]

◆ pushBackParameter() [3/4]

◆ pushBackParameter() [4/4]

◆ setActivityTemplate()

Member Data Documentation

◆ XML_NS