#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

Public Member Functions inherited from common::AbstractObject
bool	isPartial () const

virtual bool	isTopLevelElement () 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	getXmlNamespace () const =0

virtual std::string	getXmlTag () const =0

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

unsigned int	getExtraMetadataCount () const

std::string	getExtraMetadataKeyAtIndex (unsigned int index) const

std::string	getExtraMetadataStringValueAtIndex (unsigned int index) const

std::string	buildEtp12Uri () const

void	setUriSource (const std::string &uriSource)

const std::string &	getUriSource () const

std::string	getEpcSourceFolder () const

void	changeToPartialObject ()

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)

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.10.1.0/src/witsml2_1/ChannelIndexDataObject.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ChannelIndexDataObject() [1/3]

◆ ChannelIndexDataObject() [2/3]

◆ ChannelIndexDataObject() [3/3]

◆ ~ChannelIndexDataObject()

Member Function Documentation

◆ getChannelIndexCount()

◆ getChannelIndexIsIncreasing()

◆ getChannelIndexKind()

◆ getChannelIndexMnemonic()

◆ getChannelIndexUom()

◆ pushBackChannelIndex()