#include <ChannelIndexDataObject.h>

Inheritance diagram for witsml2_0::ChannelIndexDataObject< T >:

Public Member Functions
	ChannelIndexDataObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	ChannelIndexDataObject ()

	ChannelIndexDataObject (gsoap_eml2_1::eml21__AbstractObject *fromGsoap)

virtual	~ChannelIndexDataObject ()=default

virtual void	pushBackChannelIndex (gsoap_eml2_1::witsml20__ChannelIndexType indexType, gsoap_eml2_1::eml21__UnitOfMeasure uom, const std::string &mnemonic, bool isIncreasing=true, const std::string &datum="")=0

unsigned int	getChannelIndexCount () const

gsoap_eml2_1::witsml20__ChannelIndexType	getChannelIndexType (unsigned int index)

std::string	getChannelIndexUom (unsigned int index)

bool	getChannelIndexIsIncreasing (unsigned int index)

std::string	getChannelIndexMnemonic (unsigned int index)

std::string	getChannelIndexDatum (unsigned int index)

Public Member Functions inherited from witsml2_0::ChannelMetaDataObject< T >
	ChannelMetaDataObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	ChannelMetaDataObject ()

	ChannelMetaDataObject (gsoap_eml2_1::eml21__AbstractObject *fromGsoap)

virtual	~ChannelMetaDataObject ()=default

common::DataObjectReference	getWellboreDor () const
	Gets wellbore dor. More...

void	setWellbore (Wellbore *witsmlWellbore)

common::DataObjectReference	getPropertyKindDor () const

eml2::PropertyKind *	getPropertyKind () const

void	setPropertyKind (eml2::PropertyKind *propKind)

Public Member Functions inherited from witsml2_0::WellboreObject
virtual	~WellboreObject ()=default

Wellbore *	getWellbore () const

virtual void	loadTargetRelationships ()

Public Member Functions inherited from witsml2_0::AbstractObject
virtual	~AbstractObject ()=default

std::string	getContentType () const

std::string	getPartNameInEpcDocument () const

std::string	getXmlNamespace () const final

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)

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

gsoap_eml2_1::eml21__AbstractObject *	getEml21GsoapProxy () const

gsoap_eml2_2::eml22__AbstractObject *	getEml22GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *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_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_eml2_2::eml22__DataObjectReference *	newEml22Reference () 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	getXmlTag () const =0

virtual std::string	getXmlNamespaceVersion () const

virtual std::string	getQualifiedType () const

std::string	serializeIntoString ()

void	addAlias (const std::string &authority, const std::string &title)

unsigned int	getAliasCount () const

std::string	getAliasAuthorityAtIndex (unsigned int index) const

std::string	getAliasTitleAtIndex (unsigned int index) const

std::vector< eml2::Activity * >	getActivitySet () const

unsigned int	getActivityCount () const

eml2::Activity *	getActivity (unsigned int 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

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum	hdfDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 , ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 , USHORT = 8 , CHAR = 9 , UCHAR = 10 }

Static Public Member Functions inherited from common::AbstractObject
static void	setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)

Static Public Attributes inherited from witsml2_0::AbstractObject
static const char *	XML_NS

Detailed Description

template<class T>
class witsml2_0::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_0::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_0::ChannelIndexDataObject< T >::ChannelIndexDataObject ( )

inline

Creates an instance of this class in a gsoap context.

◆ ChannelIndexDataObject() [3/3]

template<class T >

witsml2_0::ChannelIndexDataObject< T >::ChannelIndexDataObject ( gsoap_eml2_1::eml21__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_0::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_0::ChannelIndexDataObject< T >::getChannelIndexCount ( ) const

inline

Gets channel index count

Returns: The channel index count.

◆ getChannelIndexDatum()

template<class T >

std::string witsml2_0::ChannelIndexDataObject< T >::getChannelIndexDatum ( unsigned int index )

inline

Gets channel index datum

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 datum.

◆ getChannelIndexIsIncreasing()

template<class T >

bool witsml2_0::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.

◆ getChannelIndexMnemonic()

template<class T >

std::string witsml2_0::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.

◆ getChannelIndexType()

template<class T >

gsoap_eml2_1::witsml20__ChannelIndexType witsml2_0::ChannelIndexDataObject< T >::getChannelIndexType ( 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.

◆ getChannelIndexUom()

template<class T >

std::string witsml2_0::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_0::ChannelIndexDataObject< T >::pushBackChannelIndex	(	gsoap_eml2_1::witsml20__ChannelIndexType	indexType,
		gsoap_eml2_1::eml21__UnitOfMeasure	uom,
		const std::string &	mnemonic,
		bool	isIncreasing = `true`,
		const std::string &	datum = `""`
	)

pure virtual

Pushes a back channel index

Parameters

indexType	Type of the index.
uom	The uom.
mnemonic	The mnemonic.
isIncreasing	(Optional) True if is increasing, false if not.
datum	(Optional) The datum.

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

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.0.0.0/src/witsml2_0/ChannelIndexDataObject.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<class T> class witsml2_0::ChannelIndexDataObject< T >

Constructor & Destructor Documentation

◆ ChannelIndexDataObject() [1/3]

◆ ChannelIndexDataObject() [2/3]

◆ ChannelIndexDataObject() [3/3]

◆ ~ChannelIndexDataObject()

Member Function Documentation

◆ getChannelIndexCount()

◆ getChannelIndexDatum()

◆ getChannelIndexIsIncreasing()

◆ getChannelIndexMnemonic()

◆ getChannelIndexType()

◆ getChannelIndexUom()

◆ pushBackChannelIndex()

template<class T>
class witsml2_0::ChannelIndexDataObject< T >