Fesapi 2.14.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
witsml2_1::ToolErrorModel Class Reference
Inheritance diagram for witsml2_1::ToolErrorModel:
common::AbstractObject

Public Member Functions

 ToolErrorModel (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 ToolErrorModel (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, gsoap_eml2_3::witsml21__MisalignmentMode misalignmentMode)
 ToolErrorModel (gsoap_eml2_3::witsml21__ToolErrorModel *fromGsoap)
 ~ToolErrorModel ()
bool isTopLevelElement () const
gsoap_eml2_3::eml23__DataObjectReference * getErrorTermDor (uint64_t index) const
std::string getErrorTermUuid (uint64_t index) const
std::vector< class ErrorTerm * > getErrorTermSet () const
void pushBackErrorTerm (class ErrorTerm *errorTerm, double magnitude, gsoap_eml2_3::eml23__UomEnum uom)
void setApplication (const std::string &application)
void setSource (const std::string &source)
void setToolKind (gsoap_eml2_3::witsml21__ToolKind toolKind)
void pushBackToolSubKind (gsoap_eml2_3::witsml21__ToolSubKind toolSubKind)
void pushBackOperatingCondition (gsoap_eml2_3::witsml21__OperatingCondition operatingCondition)
void setSurveyRunDateStart (time_t surveyRunDateStart)
void setSurveyRunDateEnd (time_t surveyRunDateEnd)
void pushBackCorrectionConsidered (gsoap_eml2_3::witsml21__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_3::witsml21__AuthorizationStatus *status)
void pushBackInclinationRange (double start, bool startInclusive, double end, bool endInclusive, gsoap_eml2_3::eml23__PlaneAngleUom uom, const std::string &comment=std::string())
void pushBackInclinationRange (double start, bool startInclusive, double end, bool endInclusive, gsoap_eml2_3::eml23__PlaneAngleUom uom, double horizontalEastWestMaxValue, gsoap_eml2_3::eml23__PlaneAngleUom horizontalEastWestMaxValueUom, const std::string &comment=std::string())
void setXyzAccelerometer ()
void setXyAccelerometer (double cantAngle, gsoap_eml2_3::eml23__PlaneAngleUom cantAngleUom, bool switching)
void setExternalReference (bool value)
void pushBackContinuousGyro (gsoap_eml2_3::witsml21__GyroAxisCombination axisCombination, double start, bool startInclusive, double end, bool endInclusive, double initialization, gsoap_eml2_3::eml23__PlaneAngleUom rangeUom, double noiseReductionFactor=std::numeric_limits< double >::quiet_NaN(), gsoap_eml2_3::eml23__LengthPerTimeUom speedUom=gsoap_eml2_3::eml23__LengthPerTimeUom::m_x002fs, double speed=std::numeric_limits< double >::quiet_NaN(), gsoap_eml2_3::eml23__LengthUom reinitializationDistanceUom=gsoap_eml2_3::eml23__LengthUom::m, double reinitializationDistance=std::numeric_limits< double >::quiet_NaN())
void pushBackStationaryGyro (gsoap_eml2_3::witsml21__GyroAxisCombination axisCombination, double start, bool startInclusive, double end, bool endInclusive, gsoap_eml2_3::eml23__PlaneAngleUom rangeUom)
void loadTargetRelationships ()
virtual std::string getXmlTag () const
std::string getXmlNamespace () const final
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)
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 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 = "ToolErrorModel"
static constexpr char const * XML_NS = "witsml21"

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)

Constructor & Destructor Documentation

◆ ToolErrorModel() [1/3]

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

Only to be used in partial transfer context

◆ ToolErrorModel() [2/3]

witsml2_1::ToolErrorModel::ToolErrorModel ( common::DataObjectRepository * repo,
const std::string & guid,
const std::string & title,
gsoap_eml2_3::witsml21__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::ToolErrorModel::ToolErrorModel ( gsoap_eml2_3::witsml21__ToolErrorModel * fromGsoap)
inline

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

◆ ~ToolErrorModel()

witsml2_1::ToolErrorModel::~ToolErrorModel ( )
inline

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

Member Function Documentation

◆ getXmlNamespace()

std::string witsml2_1::ToolErrorModel::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ getXmlTag()

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

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

Returns
The XML tag.

Implements common::AbstractObject.

◆ isTopLevelElement()

bool witsml2_1::ToolErrorModel::isTopLevelElement ( ) const
virtual

Indicates if this object is a top level one (i.e.) not contained in any other) or not.

Reimplemented from common::AbstractObject.

◆ loadTargetRelationships()

void witsml2_1::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::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_3::witsml21__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.

Member Data Documentation

◆ XML_NS

char const* witsml2_1::ToolErrorModel::XML_NS = "witsml21"
staticconstexpr

The standard XML namespace for serializing this data object.

The documentation for this class was generated from the following file:
Generated by doxygen 1.15.0