witsml2_1::ChannelIndexDataObject< T > Class Template Reference

#include <ChannelIndexDataObject.h>

Inheritance diagram for witsml2_1::ChannelIndexDataObject< T >:

Public Member Functions
	ChannelIndexDataObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	ChannelIndexDataObject ()
	ChannelIndexDataObject (gsoap_eml2_3::eml23__AbstractObject *fromGsoap)
virtual	~ChannelIndexDataObject ()=default
virtual void	pushBackChannelIndex (gsoap_eml2_3::eml23__DataIndexKind indexKind, gsoap_eml2_3::eml23__UnitOfMeasure uom, const std::string &mnemonic, bool isIncreasing=true)=0
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
virtual void	loadTargetRelationships () override

Detailed Description

template<class T>
class witsml2_1::ChannelIndexDataObject< T >

Captures information about the configuration of the permanently installed components in a wellbore. It does not define the transient drilling strings (see the Tubular object) or the hanging production components (see the Completion object).

Template Parameters

T	Generic type parameter.

Constructor & Destructor Documentation

ChannelIndexDataObject() [1/3]

template<class T >

witsml2_1::ChannelIndexDataObject< T >::ChannelIndexDataObject ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Constructor for partial transfer

Parameters

[in,out]

partialObject

If non-null, the partial object.

ChannelIndexDataObject() [2/3]

template<class T >

witsml2_1::ChannelIndexDataObject< T >::ChannelIndexDataObject ( )

inline

Creates an instance of this class in a gsoap context.

ChannelIndexDataObject() [3/3]

template<class T >

witsml2_1::ChannelIndexDataObject< T >::ChannelIndexDataObject ( gsoap_eml2_3::eml23__AbstractObject * fromGsoap )

inline

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

Parameters

[in,out]

fromGsoap

If non-null, from gsoap.

~ChannelIndexDataObject()

template<class T >

virtual witsml2_1::ChannelIndexDataObject< T >::~ChannelIndexDataObject ( )

virtualdefault

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

Member Function Documentation

getChannelIndexCount()

template<class T >

unsigned int witsml2_1::ChannelIndexDataObject< T >::getChannelIndexCount ( ) const

inline

Gets channel index count

Returns

The channel index count.

getChannelIndexIsIncreasing()

template<class T >

bool witsml2_1::ChannelIndexDataObject< T >::getChannelIndexIsIncreasing ( unsigned int index )

inline

Gets channel index is increasing

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Parameters

index

Zero-based index of the.

Returns

True if it succeeds, false if it fails.

getChannelIndexKind()

template<class T >

gsoap_eml2_3::eml23__DataIndexKind witsml2_1::ChannelIndexDataObject< T >::getChannelIndexKind ( unsigned int index )

inline

Gets channel index type

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Parameters

index

Zero-based index of the.

Returns

The channel index type.

getChannelIndexMnemonic()

template<class T >

std::string witsml2_1::ChannelIndexDataObject< T >::getChannelIndexMnemonic ( unsigned int index )

inline

Gets channel index mnemonic

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Parameters

index

Zero-based index of the.

Returns

The channel index mnemonic.

getChannelIndexUom()

template<class T >

std::string witsml2_1::ChannelIndexDataObject< T >::getChannelIndexUom ( unsigned int index )

inline

Gets channel index uom

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Parameters

index

Zero-based index of the.

Returns

The channel index uom.

pushBackChannelIndex()

template<class T >

virtual void witsml2_1::ChannelIndexDataObject< T >::pushBackChannelIndex ( gsoap_eml2_3::eml23__DataIndexKind indexKind, gsoap_eml2_3::eml23__UnitOfMeasure uom, const std::string & mnemonic, bool isIncreasing = true )

pure virtual

Pushes a back channel index

Parameters

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

Implemented in witsml2_1::Channel, and witsml2_1::ChannelSet.

---

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

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