Fesapi  2.0.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
WITSML2_1_NS::ToolErrorModel Class Reference
Inheritance diagram for WITSML2_1_NS::ToolErrorModel:
WITSML2_1_NS::AbstractObject WITSML2_NS::AbstractObject common::AbstractObject

Public Member Functions

 ToolErrorModel (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 ToolErrorModel (COMMON_NS::DataObjectRepository *repo, const std::string &guid, const std::string &title, gsoap_eml2_2::witsml2__MisalignmentMode misalignmentMode)
 
 ToolErrorModel (gsoap_eml2_2::witsml2__ToolErrorModel *fromGsoap)
 
 ~ToolErrorModel ()
 
bool isTopLevelElement () const
 
gsoap_eml2_2::eml22__DataObjectReference * getErrorTermDor (unsigned long index) const
 
std::string getErrorTermUuid (unsigned long index) const
 
std::vector< class ErrorTerm * > getErrorTermSet () const
 
void pushBackErrorTerm (class ErrorTerm *errorTerm, double magnitude, gsoap_eml2_2::eml22__UomEnum uom)
 
void setApplication (const std::string &application)
 
void setSource (const std::string &source)
 
void setToolKind (gsoap_eml2_2::witsml2__ToolKind toolKind)
 
void pushBackToolSubKind (gsoap_eml2_2::witsml2__ToolSubKind toolSubKind)
 
void pushBackOperatingCondition (gsoap_eml2_2::witsml2__OperatingCondition operatingCondition)
 
void setSurveyRunDateStart (time_t surveyRunDateStart)
 
void setSurveyRunDateEnd (time_t surveyRunDateEnd)
 
void pushBackCorrectionConsidered (gsoap_eml2_2::witsml2__CorrectionConsidered correctionConsidered)
 
void setReplacedToolErrorModel (ToolErrorModel *replaces)
 
void setAuthorization (const std::string &approvalAuthority, const std::string &approvedBy, time_t approvedOn, const std::string &checkedBy, time_t checkedOn, const std::string &revisionComment, time_t revisionDate, gsoap_eml2_2::witsml2__AuthorizationStatus *status)
 
void pushBackInclinationRange (double start, bool startInclusive, double end, bool endInclusive, gsoap_eml2_2::eml22__PlaneAngleUom uom, const std::string &comment=std::string())
 
void pushBackInclinationRange (double start, bool startInclusive, double end, bool endInclusive, gsoap_eml2_2::eml22__PlaneAngleUom uom, double horizontalEastWestMaxValue, gsoap_eml2_2::eml22__PlaneAngleUom horizontalEastWestMaxValueUom, const std::string &comment=std::string())
 
void setXyzAccelerometer ()
 
void setXyAccelerometer (double cantAngle, gsoap_eml2_2::eml22__PlaneAngleUom cantAngleUom, bool switching)
 
void setExternalReference (bool value)
 
void pushBackContinuousGyro (gsoap_eml2_2::witsml2__GyroAxisCombination axisCombination, double start, bool startInclusive, double end, bool endInclusive, double initialization, gsoap_eml2_2::eml22__PlaneAngleUom rangeUom, double noiseReductionFactor=std::numeric_limits< double >::quiet_NaN(), gsoap_eml2_2::eml22__LengthPerTimeUom speedUom=gsoap_eml2_2::eml22__LengthPerTimeUom__m_x002fs, double speed=std::numeric_limits< double >::quiet_NaN(), gsoap_eml2_2::eml22__LengthUom reinitializationDistanceUom=gsoap_eml2_2::eml22__LengthUom__m, double reinitializationDistance=std::numeric_limits< double >::quiet_NaN())
 
void pushBackStationaryGyro (gsoap_eml2_2::witsml2__GyroAxisCombination axisCombination, double start, bool startInclusive, double end, bool endInclusive, gsoap_eml2_2::eml22__PlaneAngleUom rangeUom)
 
void loadTargetRelationships ()
 
virtual std::string getXmlTag () const
 
- Public Member Functions inherited from WITSML2_1_NS::AbstractObject
 ~AbstractObject ()
 
std::string getContentType () const
 
- Public Member Functions inherited from WITSML2_NS::AbstractObject
std::string getPartNameInEpcDocument () const
 
- Public Member Functions inherited from common::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 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::DataObjectRepositorygetRepository () const
 
virtual std::string getXmlNamespace () const =0
 
virtual std::string getXmlNamespaceVersion () const
 
virtual std::string getQualifiedType () 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::ActivitygetActivity (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_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)
 

Constructor & Destructor Documentation

◆ ToolErrorModel() [1/3]

WITSML2_1_NS::ToolErrorModel::ToolErrorModel ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context

◆ ToolErrorModel() [2/3]

WITSML2_1_NS::ToolErrorModel::ToolErrorModel ( COMMON_NS::DataObjectRepository *  repo,
const std::string &  guid,
const std::string &  title,
gsoap_eml2_2::witsml2__MisalignmentMode  misalignmentMode 
)

Creates an instance of this class in a gsoap context.

Parameters
guidThe guid to set to this instance. If empty then a new guid will be generated.

◆ ToolErrorModel() [3/3]

WITSML2_1_NS::ToolErrorModel::ToolErrorModel ( gsoap_eml2_2::witsml2__ToolErrorModel *  fromGsoap)
inline

Creates an instance of this class by wrapping a gsoap instance.

◆ ~ToolErrorModel()

WITSML2_1_NS::ToolErrorModel::~ToolErrorModel ( )
inline

Destructor does nothing since the memory is managed by the gsoap context.

Member Function Documentation

◆ getXmlTag()

virtual std::string WITSML2_1_NS::ToolErrorModel::getXmlTag ( ) const
inlinevirtual

Gets the standard XML tag without XML namespace for serializing this data object.

Returns
The XML tag.

Implements common::AbstractObject.

◆ loadTargetRelationships()

void WITSML2_1_NS::ToolErrorModel::loadTargetRelationships ( )
virtual

Reads the forward relationships of this data object and update the .rels of the associated data repository.

Implements common::AbstractObject.

◆ setAuthorization()

void WITSML2_1_NS::ToolErrorModel::setAuthorization ( const std::string &  approvalAuthority,
const std::string &  approvedBy,
time_t  approvedOn,
const std::string &  checkedBy,
time_t  checkedOn,
const std::string &  revisionComment,
time_t  revisionDate,
gsoap_eml2_2::witsml2__AuthorizationStatus *  status 
)

All parameters can be empty, negative or nullptr if non present. Documentation on each parameter can override this rule.

Parameters
approvalAuthorityMust no be empty.
statusCan be nullptr. If not null, a copy of the pointed object will be done into the WITSML Authorization History.

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