witsml2_1::Channel Class Reference

#include <Channel.h>

Inheritance diagram for witsml2_1::Channel:

Public Member Functions
	Channel (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	Channel (eml2 ::PropertyKind *propertyKind, const std::string &guid, const std::string &title, const std::string &mnemonic, gsoap_eml2_3::eml23__UnitOfMeasure uom, gsoap_eml2_3::witsml21__ChannelDataKind dataKind, bool isActive)
	Creates an instance of this class in a gsoap context.
	Channel (gsoap_eml2_3::witsml21__Channel *fromGsoap)
	~Channel ()=default
void	pushBackChannelIndex (gsoap_eml2_3::eml23__DataIndexKind indexKind, gsoap_eml2_3::eml23__UnitOfMeasure uom, const std::string &mnemonic, bool isIncreasing=true) final
std::vector< class ChannelSet * >	getChannelSets () const
eml2::PropertyKind *	getPropertyKind () const
common::DataObjectReference	getPropertyKindDor () const
	Gets property kind dor.
void	setPropertyKind (eml2 ::PropertyKind *propKind)
virtual std::string	getXmlTag () const
void	loadTargetRelationships () final
std::string	getXmlNamespace () const final
Public Member Functions inherited from witsml2_1::ChannelIndexDataObject< gsoap_eml2_3::witsml21__Channel >
	ChannelIndexDataObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	ChannelIndexDataObject ()
	ChannelIndexDataObject (gsoap_eml2_3::eml23__AbstractObject *fromGsoap)
virtual	~ChannelIndexDataObject ()=default
unsigned int	getChannelIndexCount () const
gsoap_eml2_3::eml23__DataIndexKind	getChannelIndexKind (unsigned int index)
std::string	getChannelIndexUom (unsigned int index)
bool	getChannelIndexIsIncreasing (unsigned int index)
std::string	getChannelIndexMnemonic (unsigned int index)
Public Member Functions inherited from witsml2_1::ChannelMetaDataObject< T >
	ChannelMetaDataObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	ChannelMetaDataObject ()
	ChannelMetaDataObject (gsoap_eml2_3::eml23__AbstractObject *fromGsoap)
virtual	~ChannelMetaDataObject ()=default
common::DataObjectReference	getWellboreDor () const final
	Gets wellbore dor.
void	setWellbore (WITSML2_NS::Wellbore *witsmlWellbore) final
Public Member Functions inherited from WITSML2_NS::WellboreObject
virtual	~WellboreObject ()=default
Wellbore *	getWellbore () const

Static Public Attributes
static const char *	XML_TAG
static constexpr char const *	XML_NS = "witsml21"

Detailed Description

Channels are the fundamental unit of organization for WITSML logs.

Constructor & Destructor Documentation

Channel() [1/3]

witsml2_1::Channel::Channel ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

Parameters

[in,out]

partialObject

If non-null, the partial object.

Channel() [2/3]

witsml2_1::Channel::Channel	(	eml2 ::PropertyKind *	propertyKind,
		const std::string &	guid,
		const std::string &	title,
		const std::string &	mnemonic,
		gsoap_eml2_3::eml23__UnitOfMeasure	uom,
		gsoap_eml2_3::witsml21__ChannelDataKind	dataKind,
		bool	isActive )

Creates an instance of this class in a gsoap context.

Exceptions

std::invalid_argument

If propertyKind == nullptr.

Parameters

[in]	propertyKind	If non-null, the property kind.
	guid	The guid to set to this instance. If empty then a new guid will be generated.
	title	The title.
	mnemonic	The mnemonic.
	uom	The uom.
	dataKind	Kind of the data.
	isActive	True if is active, false if not.

Channel() [3/3]

witsml2_1::Channel::Channel ( gsoap_eml2_3::witsml21__Channel * fromGsoap )

inline

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

Parameters

[in,out]

fromGsoap

If non-null, from gsoap.

~Channel()

witsml2_1::Channel::~Channel ( )

default

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

Member Function Documentation

getChannelSets()

std::vector< class ChannelSet * > witsml2_1::Channel::getChannelSets

(

)

const

Gets channel sets

Returns

Null if it fails, else the channel sets.

getPropertyKind()

eml2::PropertyKind * witsml2_1::Channel::getPropertyKind

(

)

const

Gets property kind

Returns

Null if it fails, else the property kind.

getPropertyKindDor()

common::DataObjectReference witsml2_1::Channel::getPropertyKindDor

(

)

const

Gets property kind dor.

Returns

The property kind dor.

getXmlNamespace()

std::string witsml2_1::Channel::getXmlNamespace ( ) const

inlinefinal

Get the standard XML namespace for serializing this data object.

getXmlTag()

virtual std::string witsml2_1::Channel::getXmlTag ( ) const

inlinevirtual

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

Returns

The XML tag.

loadTargetRelationships()

void witsml2_1::Channel::loadTargetRelationships ( )

finalvirtual

Loads target relationships

Reimplemented from WITSML2_NS::WellboreObject.

pushBackChannelIndex()

void witsml2_1::Channel::pushBackChannelIndex ( gsoap_eml2_3::eml23__DataIndexKind indexKind, gsoap_eml2_3::eml23__UnitOfMeasure uom, const std::string & mnemonic, bool isIncreasing = true )

finalvirtual

Pushes a back channel index

Parameters

indexKind	Kind of the index.
uom	The uom.
mnemonic	The mnemonic.
isIncreasing	(Optional) True if is increasing, false if not.

Implements witsml2_1::ChannelIndexDataObject< gsoap_eml2_3::witsml21__Channel >.

setPropertyKind()

void witsml2_1::Channel::setPropertyKind

(

eml2 ::PropertyKind *

propKind

)

Set the PropertyKind linked with this data object.

Exceptions

std::invalid_argument

Thrown when an invalid argument error condition occurs.

Parameters

[in,out]

propKind

If non-null, the property kind.

Member Data Documentation

XML_NS

constexpr char const* witsml2_1::Channel::XML_NS = "witsml21"

staticconstexpr

The standard XML namespace for serializing this data object.

XML_TAG

const char* witsml2_1::Channel::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:

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/witsml2_1/Channel.h