Fesapi 2.9.0.1
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::Log Class Reference

#include <Log.h>

Inheritance diagram for witsml2_1::Log:
witsml2_1::ChannelMetaDataObject< gsoap_eml2_3::witsml21__Log > WITSML2_NS::WellboreObject

Public Member Functions

 Log (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 Log (WITSML2_NS::Wellbore *witsmlWellbore, const std::string &guid, const std::string &title, bool isActive)
 Constructor.
 
 Log (gsoap_eml2_3::witsml21__Log *fromGsoap)
 
 ~Log ()=default
 
void pushBackChannelSet (class ChannelSet *channelSet)
 
std::vector< class ChannelSet * > getChannelSets () const
 
virtual std::string getXmlTag () const
 
void loadTargetRelationships () final
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from WITSML2_NS::WellboreObject
virtual ~WellboreObject ()=default
 
WellboregetWellbore () const
 

Static Public Attributes

static const char * XML_TAG
 
static constexpr char const * XML_NS = "witsml21"
 

Detailed Description

Primarily a container for one or more channel sets (ChannelSet).

Constructor & Destructor Documentation

◆ Log() [1/3]

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

Constructor for partial transfer

Parameters
[in,out]partialObjectIf non-null, the partial object.

◆ Log() [2/3]

witsml2_1::Log::Log ( WITSML2_NS::Wellbore * witsmlWellbore,
const std::string & guid,
const std::string & title,
bool isActive )

Constructor.

Exceptions
std::invalid_argumentIf witsmlWellbore == nullptr.
Parameters
[in]witsmlWellboreIf non-null, the witsml wellbore.
guidUnique identifier.
titleThe title.
isActiveTrue if is active, false if not.

◆ Log() [3/3]

witsml2_1::Log::Log ( gsoap_eml2_3::witsml21__Log * fromGsoap)
inline

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

Parameters
[in,out]fromGsoapIf non-null, from gsoap.

◆ ~Log()

witsml2_1::Log::~Log ( )
default

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

Member Function Documentation

◆ getChannelSets()

std::vector< class ChannelSet * > witsml2_1::Log::getChannelSets ( ) const

Gets channel sets

Returns
Null if it fails, else the channel sets.

◆ getXmlNamespace()

std::string witsml2_1::Log::getXmlNamespace ( ) const
inlinefinal

Get the standard XML namespace for serializing this data object.

◆ getXmlTag()

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

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

Returns
The XML tag.

◆ loadTargetRelationships()

void witsml2_1::Log::loadTargetRelationships ( )
finalvirtual

Loads target relationships

Reimplemented from WITSML2_NS::WellboreObject.

◆ pushBackChannelSet()

void witsml2_1::Log::pushBackChannelSet ( class ChannelSet * channelSet)

Pushes a back channel set

Parameters
[in,out]channelSetIf non-null, set the channel belongs to.

Member Data Documentation

◆ XML_NS

constexpr char const* witsml2_1::Log::XML_NS = "witsml21"
staticconstexpr

The standard XML namespace for serializing this data object.

◆ XML_TAG

const char* witsml2_1::Log::XML_TAG
static

The standard XML tag without XML namespace for serializing this data object.

Returns
The XML tag.

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