|
Fesapi 2.14.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
|
Instance of a given activity. More...
#include <Activity.h>
Public Member Functions | |
| Activity (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject) | |
| virtual | ~Activity ()=default |
| virtual void | pushBackParameter (const std::string &title, const std::string &value)=0 |
| virtual void | pushBackParameter (const std::string &title, int64_t value)=0 |
| virtual void | pushBackParameter (const std::string &title, AbstractObject *resqmlObject)=0 |
| virtual uint64_t | getParameterCount () const =0 |
| virtual uint64_t | getParameterCount (const std::string ¶mTitle) const =0 |
| virtual std::string | getParameterTitle (uint64_t index) const =0 |
| virtual std::vector< uint64_t > | getParameterIndexOfTitle (const std::string ¶mTitle) const =0 |
| virtual bool | isAFloatingPointQuantityParameter (const std::string ¶mTitle) const =0 |
| virtual bool | isAFloatingPointQuantityParameter (uint64_t index) const =0 |
| virtual std::vector< double > | getFloatingPointQuantityParameterValue (const std::string ¶mTitle) const =0 |
| virtual double | getFloatingPointQuantityParameterValue (uint64_t index) const =0 |
| virtual bool | isAnIntegerQuantityParameter (const std::string ¶mTitle) const =0 |
| virtual bool | isAnIntegerQuantityParameter (uint64_t index) const =0 |
| virtual std::vector< int64_t > | getIntegerQuantityParameterValue (const std::string ¶mTitle) const =0 |
| virtual int64_t | getIntegerQuantityParameterValue (uint64_t index) const =0 |
| virtual bool | isAStringParameter (const std::string ¶mTitle) const =0 |
| Queries if all of the parameters sharing a given title are string parameters. | |
| virtual bool | isAStringParameter (uint64_t index) const =0 |
| virtual std::vector< std::string > | getStringParameterValue (const std::string ¶mTitle) const =0 |
| virtual std::string | getStringParameterValue (uint64_t index) const =0 |
| virtual bool | isAResqmlObjectParameter (const std::string ¶mTitle) const =0 |
| virtual bool | isAResqmlObjectParameter (uint64_t index) const =0 |
| virtual std::vector< AbstractObject * > | getResqmlObjectParameterValue (const std::string ¶mTitle) const =0 |
| virtual AbstractObject * | getResqmlObjectParameterValue (uint64_t index) const =0 |
| virtual void | setActivityTemplate (ActivityTemplate *activityTemplate)=0 |
| virtual common::DataObjectReference | getActivityTemplateDor () const =0 |
| 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) |
| 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 |
| uint64_t | getExtraMetadataCount () const |
| std::string | getExtraMetadataKeyAtIndex (uint64_t index) const |
| std::string | getExtraMetadataStringValueAtIndex (uint64_t index) const |
| std::string | buildEtp12Uri () const |
| void | setUriSource (const std::string &uriSource) |
| const std::string & | getUriSource () const |
| std::string | getEpcSourceFolder () const |
| void | changeToPartialObject () |
| template<> | |
| int8_t | readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, int8_t *arrayOutput) const |
| template<> | |
| uint8_t | readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, uint8_t *arrayOutput) const |
| template<> | |
| int16_t | readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, int16_t *arrayOutput) const |
| template<> | |
| uint16_t | readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, uint16_t *arrayOutput) const |
| template<> | |
| int32_t | readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, int32_t *arrayOutput) const |
| template<> | |
| uint32_t | readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, uint32_t *arrayOutput) const |
| template<> | |
| int64_t | readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, int64_t *arrayOutput) const |
| template<> | |
| uint64_t | readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const *arrayInput, uint64_t *arrayOutput) const |
| template<> | |
| int8_t | readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, int8_t *arrayOutput) const |
| template<> | |
| uint8_t | readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, uint8_t *arrayOutput) const |
| template<> | |
| int16_t | readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, int16_t *arrayOutput) const |
| template<> | |
| uint16_t | readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, uint16_t *arrayOutput) const |
| template<> | |
| int32_t | readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, int32_t *arrayOutput) const |
| template<> | |
| uint32_t | readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, uint32_t *arrayOutput) const |
| template<> | |
| int64_t | readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, int64_t *arrayOutput) const |
| template<> | |
| uint64_t | readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const *arrayInput, uint64_t *arrayOutput) const |
Static Public Attributes | |
| static constexpr char const * | XML_TAG = "Activity" |
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) |
Instance of a given activity.
|
inline |
Only to be used in partial transfer context
| [in] | partialObject | If non-null, the partial object. |
|
virtualdefault |
Destructor does nothing since the memory is managed by the gSOAP context.
Reimplemented in eml2_3::Activity, and resqml2_0_1::Activity.
| ActivityTemplate * eml2::Activity::getActivityTemplate | ( | ) | const |
Gets the activity template of this activity.
|
pure virtual |
Gets the data object reference of the activity template of this activity.
Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Gets the values of all the floating point quantity parameters sharing a given title.
| std::invalid_argument | If there exists no paramTitle parameter in this activity. |
| std::invalid_argument | If one paramTitle parameter contains some non double values. |
| paramTitle | The title of the floating point parameters we look for the value. |
paramTitle floating point quantity parameters. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Gets the floating point quantity value of a given parameter.
| std::out_of_range | If index is not in the parameter range. |
| std::invalid_argument | If the parameter at index is not a floating point quantity parameter. |
| index | Zero-based index of the parameter we look for the value. This index is taken in the set of all parameters of this activity. |
index. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Gets the values of all the integer quantity parameters sharing a given title.
| std::invalid_argument | If there exists no paramTitle parameter in this activity. |
| std::invalid_argument | If one paramTitle parameter contains some non integer values. |
| paramTitle | The title of the integer parameters we look for the value. |
paramTitle integer quantity parameters. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Gets the integer quantity value of a given parameter.
| std::out_of_range | If index is not in the parameter range. |
| std::invalid_argument | If the parameter at index is not an integer quantity parameter. |
| index | Zero-based index of the parameter we look for the value. This index is taken in the set of all parameters of this activity. |
index. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Get the count of all the parameters
Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Gets the count of all the parameters which have the same title.
| paramTitle | The title of the parameters we look for. |
Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Gets the indices of all the parameters sharing a given title.
| paramTitle | The title of the parameters we look for. |
Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Gets the title of a given parameter
| std::out_of_range | If index is not in the parameter range. |
| index | Zero-based index of the parameter for which we look for the title. |
Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Gets the values of all the RESQML object parameters sharing a given title.
| std::invalid_argument | If there exists no paramTitle parameter in this activity. |
| std::invalid_argument | If one paramTitle parameter contains some non RESQML object values. |
| paramTitle | The title of the RESQML object parameters we look for the value. |
paramTitle RESQML object parameters. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Gets the RESQML object value of a given parameter.
| std::out_of_range | If index is not in the parameter range. |
| std::invalid_argument | If the parameter at index is not an RESQML object parameter. |
| index | Zero-based index of the parameter we look for the value. This index is taken in the set of all parameters of this activity. |
index. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
| std::vector< AbstractObject * > eml2::Activity::getResqmlObjectSet | ( | ) | const |
Gets all the RESQML objects which are either input or output of this activity. That is to say all of the values of the RESQML object parameters of this activity.
|
pure virtual |
Gets the values of all the string parameters sharing a given title.
| std::invalid_argument | If there exists no paramTitle parameter in this activity. |
| std::invalid_argument | If one paramTitle parameter contains some non string values. |
| paramTitle | The title of the string parameters we look for the value. |
paramTitle string parameters. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Gets the string value of a given parameter.
| std::out_of_range | If index is not in the parameter range. |
| std::invalid_argument | If the parameter at index is not an string parameter. |
| index | Zero-based index of the parameter we look for the value. This index is taken in the set of all parameters of this activity. |
index. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
inlinefinalvirtual |
Gets the standard XML tag without XML namespace for serializing this data object.
Implements common::AbstractObject.
|
pure virtual |
Queries if all of the parameters sharing a given title are floating point quantity parameters.
| std::invalid_argument | If there exists no paramTitle parameter in this activity. |
| paramTitle | The title of the parameters we want to test the datatype. |
paramTitle parameters are floating point quantity parameters, false if not. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Queries if a given parameter is a floating point quantity parameter.
| std::out_of_range | If index is not in the parameter range. |
| index | Zero-based index of the parameter we want to test the datatype. |
index is a floating point quantity parameter, false if not. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Queries if all of the parameters sharing a given title are integer quantity parameters.
| std::invalid_argument | If there exists no paramTitle parameter in this activity. |
| paramTitle | The title of the parameters we want to test the datatype. |
paramTitle parameters are integer quantity parameters, false if not. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Queries if a given parameter is an integer quantity parameter.
| std::out_of_range | If index is not in the parameter range. |
| index | Zero-based index of the parameter we want to test the datatype. |
index is an integer quantity parameter, false if not. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Queries if all of the parameters sharing a given title are RESQML object parameters.
| std::invalid_argument | If there exists no paramTitle parameter in this activity. |
| paramTitle | The title of the parameters we want to test the datatype. |
paramTitle parameters are RESQML object parameters, false if not. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Queries if a given parameter is a RESQML object parameter.
| std::out_of_range | If index is not in the parameter range. |
| index | Zero-based index of the parameter we want to test the datatype. |
index is a RESQML object parameter, false if not. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Queries if all of the parameters sharing a given title are string parameters.
| std::invalid_argument | If there exists no paramTitle parameter in this activity. |
| paramTitle | The title of the parameters we want to test the datatype. |
paramTitle parameters are string parameters, false if not. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Queries if a given parameter is a string parameter.
| std::out_of_range | If index is not in the parameter range. |
| index | Zero-based index of the parameter we want to test the datatype. |
index is a string parameter, false if not. Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Pushes back a RESQML object parameter in this instance. This parameter must exist in the associated activity template.
| 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. |
| title | The title of the parameter to push back. | |
| [in] | resqmlObject | The RESQML object, value of the parameter to push back. |
Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Pushes back a string parameter in this instance. This parameter must exist in the associated activity template.
| 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. |
| title | The title of the parameter to push back. |
| value | The value of the parameter to push back. |
Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Pushes back an integer parameter in this instance. This parameter must exist in the associated activity template.
| 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. |
| title | The title of the parameter to push back. |
| value | The value of the parameter to push back. |
Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
pure virtual |
Sets the activity template of this activity.
| [in] | activityTemplate | If non-null, the activity template. |
Implemented in eml2_3::Activity, and resqml2_0_1::Activity.
|
staticconstexpr |
The standard XML tag without XML namespace for serializing this data object