resqml2_0_1::Activity Class Reference

#include <Activity.h>

Inheritance diagram for resqml2_0_1::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. More...
	Activity (gsoap_resqml2_0_1::_resqml20__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) final
void	pushBackParameter (const std::string title, int64_t value) final
void	pushBackParameter (const std::string title, AbstractObject *resqmlObject) final
unsigned int	getParameterCount () const final
unsigned int	getParameterCount (const std::string &paramTitle) const final
const std::string &	getParameterTitle (unsigned int index) const final
std::vector< unsigned int >	getParameterIndexOfTitle (const std::string &paramTitle) const final
bool	isAFloatingPointQuantityParameter (const std::string &paramTitle) const final
bool	isAFloatingPointQuantityParameter (unsigned int index) const final
std::vector< double >	getFloatingPointQuantityParameterValue (const std::string &paramTitle) const final
double	getFloatingPointQuantityParameterValue (unsigned int index) const final
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 final
bool	isAnIntegerQuantityParameter (unsigned int index) const final
std::vector< int64_t >	getIntegerQuantityParameterValue (const std::string &paramTitle) const final
int64_t	getIntegerQuantityParameterValue (unsigned int index) const final
bool	isAStringParameter (const std::string &paramTitle) const final
bool	isAStringParameter (unsigned int index) const final
std::vector< std::string >	getStringParameterValue (const std::string &paramTitle) const final
const std::string &	getStringParameterValue (unsigned int index) const final
bool	isAResqmlObjectParameter (const std::string &paramTitle) const final
bool	isAResqmlObjectParameter (unsigned int index) const final
std::vector< AbstractObject * >	getResqmlObjectParameterValue (const std::string &paramTitle) const final
AbstractObject *	getResqmlObjectParameterValue (unsigned int index) const final
void	setActivityTemplate (eml2::ActivityTemplate *activityTemplate) final
common::DataObjectReference	getActivityTemplateDor () const final
std::string	getXmlNamespaceVersion () const final
std::string	getXmlNamespace () const final
void	loadTargetRelationships ()
Public Member Functions inherited from eml2::Activity
	Activity (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
ActivityTemplate *	getActivityTemplate () const
std::vector< AbstractObject * >	getResqmlObjectSet () 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::Activity
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.

Constructor & Destructor Documentation

Activity() [1/3]

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

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

resqml2_0_1::Activity::Activity ( gsoap_resqml2_0_1::_resqml20__Activity *  fromGsoap )

inline

Constructor

Parameters

[in,out]

fromGsoap

If non-null, from gsoap.

~Activity()

resqml2_0_1::Activity::~Activity ( )

virtualdefault

Destructor

Reimplemented from eml2::Activity.

Member Function Documentation

getActivityTemplateDor()

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

finalvirtual

Gets activity template dor

Returns

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

Implements eml2::Activity.

getFloatingPointQuantityParameterUom() [1/2]

std::vector<gsoap_resqml2_0_1::resqml20__ResqmlUom> resqml2_0_1::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 resqml2_0_1::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> resqml2_0_1::Activity::getFloatingPointQuantityParameterValue ( const std::string &  paramTitle ) const

finalvirtual

Gets floating point quantity parameter value

Parameters

paramTitle

The parameter title.

Returns

The floating point quantity parameter value.

Implements eml2::Activity.

getFloatingPointQuantityParameterValue() [2/2]

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

finalvirtual

Gets floating point quantity parameter value

Parameters

index

Zero-based index of the.

Returns

The floating point quantity parameter value.

Implements eml2::Activity.

getIntegerQuantityParameterValue() [1/2]

std::vector<int64_t> resqml2_0_1::Activity::getIntegerQuantityParameterValue ( const std::string &  paramTitle ) const

finalvirtual

Gets integer quantity parameter value

Parameters

paramTitle

The parameter title.

Returns

The integer quantity parameter value.

Implements eml2::Activity.

getIntegerQuantityParameterValue() [2/2]

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

finalvirtual

Gets integer quantity parameter value

Parameters

index

Zero-based index of the.

Returns

The integer quantity parameter value.

Implements eml2::Activity.

getParameterCount() [1/2]

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

finalvirtual

Get the count of all the parameters

Returns

The parameter count.

Implements eml2::Activity.

getParameterCount() [2/2]

unsigned int resqml2_0_1::Activity::getParameterCount ( const std::string &  paramTitle ) const

finalvirtual

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

Parameters

paramTitle

The parameter title.

Returns

The parameter count.

Implements eml2::Activity.

getParameterIndexOfTitle()

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

finalvirtual

Gets parameter index of title

Parameters

paramTitle

The parameter title.

Returns

The parameter index of title.

Implements eml2::Activity.

getParameterTitle()

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

finalvirtual

Gets parameter title

Parameters

index

Zero-based index of the.

Returns

The parameter title.

Implements eml2::Activity.

getResqmlObjectParameterValue() [1/2]

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

finalvirtual

Gets resqml object parameter value

Parameters

paramTitle

The parameter title.

Returns

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

Implements eml2::Activity.

getResqmlObjectParameterValue() [2/2]

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

finalvirtual

Gets resqml object parameter value

Parameters

index

Zero-based index of the.

Returns

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

Implements eml2::Activity.

getStringParameterValue() [1/2]

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

finalvirtual

Gets string parameter value

Parameters

paramTitle

The parameter title.

Returns

The string parameter value.

Implements eml2::Activity.

getStringParameterValue() [2/2]

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

finalvirtual

Gets string parameter value

Parameters

index

Zero-based index of the.

Returns

The string parameter value.

Implements eml2::Activity.

getXmlNamespace()

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

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

getXmlNamespaceVersion()

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

finalvirtual

Gets XML namespace version

Returns

The XML namespace version.

Reimplemented from common::AbstractObject.

isAFloatingPointQuantityParameter() [1/2]

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

finalvirtual

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.

Implements eml2::Activity.

isAFloatingPointQuantityParameter() [2/2]

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

finalvirtual

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.

Implements eml2::Activity.

isAnIntegerQuantityParameter() [1/2]

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

finalvirtual

Query if 'paramTitle' is an integer quantity parameter

Parameters

paramTitle

The parameter title.

Returns

True if an integer quantity parameter, false if not.

Implements eml2::Activity.

isAnIntegerQuantityParameter() [2/2]

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

finalvirtual

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.

Implements eml2::Activity.

isAResqmlObjectParameter() [1/2]

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

finalvirtual

Query if 'paramTitle' is a resqml object parameter

Parameters

paramTitle

The parameter title.

Returns

True if a resqml object parameter, false if not.

Implements eml2::Activity.

isAResqmlObjectParameter() [2/2]

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

finalvirtual

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.

Implements eml2::Activity.

isAStringParameter() [1/2]

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

finalvirtual

Query if 'paramTitle' is a string parameter

Parameters

paramTitle

The parameter title.

Returns

True if a string parameter, false if not.

Implements eml2::Activity.

isAStringParameter() [2/2]

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

finalvirtual

Query if 'index' is a string parameter

Parameters

index

Zero-based index of the.

Returns

True if a string parameter, false if not.

Implements eml2::Activity.

loadTargetRelationships()

void resqml2_0_1::Activity::loadTargetRelationships ( )

virtual

Loads target relationships

Reimplemented from eml2::Activity.

pushBackParameter() [1/4]

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

finalvirtual

Pushes back a RESQML object parameter in this instance. This parameter must exist in the associated activity template.

Exceptions

std::invalid_argument	If resqmlObject is null.
std::invalid_argument	If the parameter title does not exist in the associated activity template.
std::invalid_argument	If the maximum number of occurrences has already been reached for parameter title.
std::invalid_argument	If The parameter template title does not allow a a data object datatype.

Parameters

	title	The title of the parameter to push back.
[in]	resqmlObject	The RESQML object, value of the parameter to push back.

Implements eml2::Activity.

pushBackParameter() [2/4]

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

finalvirtual

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

Exceptions

std::invalid_argument	If the parameter title does not exist in the associated activity template.
std::invalid_argument	If the maximum number of occurrences has already been reached for parameter title.
std::invalid_argument	If The parameter template title does not allow a string datatype.

Parameters

title	The title of the parameter to push back.
value	The value of the parameter to push back.

Implements eml2::Activity.

pushBackParameter() [3/4]

void resqml2_0_1::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 resqml2_0_1::Activity::pushBackParameter ( const std::string  title, int64_t  value  )

finalvirtual

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

Exceptions

std::invalid_argument	If the parameter title does not exist in the associated activity template.
std::invalid_argument	If the maximum number of occurrences has already been reached for parameter title.
std::invalid_argument	If The parameter template title does not allow a an integer datatype.

Parameters

title	The title of the parameter to push back.
value	The value of the parameter to push back.

Implements eml2::Activity.

setActivityTemplate()

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

finalvirtual

Set the activity template of the activity

Parameters

[in,out]

activityTemplate

If non-null, the activity template.

Implements eml2::Activity.

Member Data Documentation

XML_NS

const char* resqml2_0_1::Activity::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/Activity.h