Fesapi  0.13.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | Static Public Attributes | List of all members
RESQML2_0_1_NS::ActivityTemplate Class Reference
Inheritance diagram for RESQML2_0_1_NS::ActivityTemplate:
RESQML2_NS::ActivityTemplate COMMON_NS::AbstractObject

Public Member Functions

 ActivityTemplate (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 ActivityTemplate (soap *soapContext, const std::string &guid, const std::string &title)
 
 ActivityTemplate (gsoap_resqml2_0_1::_resqml2__ActivityTemplate *fromGsoap)
 
void pushBackParameter (const std::string title, const bool &isInput, const bool isOutput, const unsigned int &minOccurs, const int &maxOccurs)
 
void pushBackParameter (const std::string title, const gsoap_resqml2_0_1::resqml2__ParameterKind &kind, const bool &isInput, const bool isOutput, const unsigned int &minOccurs, const int &maxOccurs)
 
void pushBackParameter (const std::string title, const bool &isInput, const bool isOutput, const unsigned int &minOccurs, const int &maxOccurs, const std::string &resqmlObjectContentType)
 
bool isAnExistingParameter (const std::string &paramTitle) const
 
const unsigned int getParameterCount () const
 
const std::string & getParameterTitle (const unsigned int &index) const
 
const std::vector< gsoap_resqml2_0_1::resqml2__ParameterKind > & getParameterAllowedKinds (const unsigned int &index) const
 
const std::vector< gsoap_resqml2_0_1::resqml2__ParameterKind > & getParameterAllowedKinds (const std::string &paramTitle) const
 
const bool & getParameterIsInput (const unsigned int &index) const
 
const bool & getParameterIsInput (const std::string &paramTitle) const
 
const bool & getParameterIsOutput (const unsigned int &index) const
 
const bool & getParameterIsOutput (const std::string &paramTitle) const
 
const LONG64 getParameterMinOccurences (const unsigned int &index) const
 
const LONG64 getParameterMinOccurences (const std::string &paramTitle) const
 
const LONG64 getParameterMaxOccurences (const unsigned int &index) const
 
const LONG64 getParameterMaxOccurences (const std::string &paramTitle) const
 
const std::vector< Activity * > & getActivityInstanceSet () const
 
std::string getResqmlVersion () const
 
std::string getXmlTag () const
 
- Public Member Functions inherited from RESQML2_NS::ActivityTemplate
 ActivityTemplate (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
const std::vector< Activity * > & getActivityInstanceSet () const
 
- Public Member Functions inherited from COMMON_NS::AbstractObject
bool isPartial () 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 getVersionString () const
 
void setTitle (const std::string &title)
 
void setEditor (const std::string &editor)
 
void setCreation (const time_t &creation)
 
void setCreation (const tm &creation)
 
void setOriginator (const std::string &originator)
 
void setDescription (const std::string &description)
 
void setLastUpdate (const time_t &lastUpdate)
 
void setLastUpdate (const tm &lastUpdate)
 
void setFormat (const std::string &format)
 
void setDescriptiveKeywords (const std::string &descriptiveKeywords)
 
void setVersionString (const std::string &versionString)
 
void setMetadata (const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
 
void serializeIntoStream (std::ostream *stream)
 
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * getGsoapProxy () const
 
soap * getGsoapContext () const
 
int getGsoapType () const
 
gsoap_resqml2_0_1::eml20__DataObjectReference * newResqmlReference () const
 
gsoap_eml2_1::eml21__DataObjectReference * newEmlReference () const
 
gsoap_resqml2_0_1::resqml2__ContactElementReference * newResqmlContactElementReference () const
 
COMMON_NS::EpcDocumentgetEpcDocument () const
 
virtual std::string getXmlNamespace () const
 
virtual std::string getContentType () 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 (const unsigned int &index) const
 
std::string getAliasTitleAtIndex (const unsigned int &index) const
 
const std::vector< RESQML2_NS::Activity * > & getActivitySet () const
 
unsigned int getActivityCount () const
 
RESQML2_NS::ActivitygetActivity (const unsigned int &index) const
 
void pushBackExtraMetadata (const std::string &key, const std::string &value)
 
std::tr1::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 (const unsigned int &index) const
 
std::string getExtraMetadataStringValueAtIndex (const unsigned int &index) const
 

Static Public Attributes

static const char * XML_TAG = "ActivityTemplate"
 
- Static Public Attributes inherited from RESQML2_NS::ActivityTemplate
static const char * XML_TAG = "ActivityTemplate"
 

Additional Inherited Members

- Protected Types inherited from COMMON_NS::AbstractObject
enum  EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }
 
- Protected Member Functions inherited from RESQML2_NS::ActivityTemplate
 ActivityTemplate (gsoap_resqml2_0_1::_resqml2__ActivityTemplate *fromGsoap)
 
- Protected Member Functions inherited from COMMON_NS::AbstractObject
 AbstractObject ()
 Indicate whether methods update the XML (gSoap) or only the C++ classes of the API.
 
 AbstractObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 AbstractObject (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *proxy)
 
 AbstractObject (gsoap_eml2_1::eml21__AbstractObject *proxy)
 
void initMandatoryMetadata ()
 
void setMetadata (const std::string &guid, const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
 
void cannotBePartial () const
 
void changeToPartialObject ()
 
- Static Protected Member Functions inherited from COMMON_NS::AbstractObject
static void addActivityToResqmlObject (RESQML2_NS::Activity *activity, AbstractObject *resqmlObject)
 
- Protected Attributes inherited from COMMON_NS::AbstractObject
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * gsoapProxy2_0_1
 
gsoap_eml2_1::eml21__AbstractObject * gsoapProxy2_1
 
COMMON_NS::EpcDocumentepcDocument
 
std::vector< RESQML2_NS::Activity * > activitySet
 
bool updateXml
 

Constructor & Destructor Documentation

RESQML2_0_1_NS::ActivityTemplate::ActivityTemplate ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context

RESQML2_0_1_NS::ActivityTemplate::ActivityTemplate ( soap *  soapContext,
const std::string &  guid,
const std::string &  title 
)

Creates an instance of this class in a gsoap context.

Parameters
soapContextThe soap context where the underlying gsoap proxy is going to be created.
guidThe guid to set to the boundary horizon. If empty then a new guid will be generated.
titleA title for the instance to create.

Member Function Documentation

std::string ActivityTemplate::getResqmlVersion ( ) const
virtual

Get the XML tag for the XML serialization of this instance

Reimplemented from COMMON_NS::AbstractObject.

std::string RESQML2_0_1_NS::ActivityTemplate::getXmlTag ( ) const
inlinevirtual

Get the XML tag for the XML serialization of this instance

Reimplemented from RESQML2_NS::ActivityTemplate.

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

Check if the instance contains a parameter with a particular title

Parameters
paramTitleThe title of the parameter we are looking for into the instance

Implements RESQML2_NS::ActivityTemplate.

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

Push back a parameter in the activity template instance. This parameter has an unconstrained type.

Implements RESQML2_NS::ActivityTemplate.

void RESQML2_0_1_NS::ActivityTemplate::pushBackParameter ( const std::string  title,
const gsoap_resqml2_0_1::resqml2__ParameterKind &  kind,
const bool &  isInput,
const bool  isOutput,
const unsigned int &  minOccurs,
const int &  maxOccurs 
)

Push back a parameter in the activity template instance. This parameter must not be of a data object kind.

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

Push back a parameter in the activity template instance. This parameter must be of a data object kind.

Parameters
resqmlObjectContentTypeIf empty, there is no constraint on the content type of this parameter.

Implements RESQML2_NS::ActivityTemplate.


The documentation for this class was generated from the following files: