#include <Channel.h>

Inheritance diagram for witsml2_0::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_1::eml21__UnitOfMeasure uom, gsoap_eml2_1::witsml20__EtpDataType dataType, gsoap_eml2_1::witsml20__ChannelStatus growingStatus, const std::string &timeDepth, const std::string &loggingCompanyName)
	Creates an instance of this class in a gsoap context. More...

	Channel (gsoap_eml2_1::witsml20__Channel *fromGsoap)

	~Channel ()=default

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="")

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

eml2::PropertyKind *	getPropertyKind () const

common::DataObjectReference	getPropertyKindDor () const
	Gets property kind dor. More...

virtual std::string	getXmlTag () const

void	loadTargetRelationships ()

Public Member Functions inherited from witsml2_0::ChannelIndexDataObject< gsoap_eml2_1::witsml20__Channel >
	ChannelIndexDataObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	ChannelIndexDataObject ()

	ChannelIndexDataObject (gsoap_eml2_1::eml21__AbstractObject *fromGsoap)

virtual	~ChannelIndexDataObject ()=default

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< gsoap_eml2_1::witsml20__Channel >
	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

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

Static Public Attributes
static const char *	XML_TAG

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

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)

Detailed Description

Channels are the fundamental unit of organization for WITSML logs.

Constructor & Destructor Documentation

◆ Channel() [1/3]

witsml2_0::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_0::Channel::Channel	(	eml2::PropertyKind *	propertyKind,
		const std::string &	guid,
		const std::string &	title,
		const std::string &	mnemonic,
		gsoap_eml2_1::eml21__UnitOfMeasure	uom,
		gsoap_eml2_1::witsml20__EtpDataType	dataType,
		gsoap_eml2_1::witsml20__ChannelStatus	growingStatus,
		const std::string &	timeDepth,
		const std::string &	loggingCompanyName
	)

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.
	dataType	Type of the data.
	growingStatus	The growing status.
	timeDepth	Depth of the time.
	loggingCompanyName	Name of the logging company.

◆ Channel() [3/3]

witsml2_0::Channel::Channel ( gsoap_eml2_1::witsml20__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_0::Channel::~Channel ( )

default

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

Member Function Documentation

◆ getChannelSets()

std::vector<class ChannelSet*> witsml2_0::Channel::getChannelSets ( ) const

Gets channel sets

Returns: Null if it fails, else the channel sets.

◆ getPropertyKind()

eml2::PropertyKind* witsml2_0::Channel::getPropertyKind ( ) const

Gets property kind

Returns: Null if it fails, else the property kind.

◆ getPropertyKindDor()

common::DataObjectReference witsml2_0::Channel::getPropertyKindDor ( ) const

Gets property kind dor.

Returns: The property kind dor.

◆ getXmlTag()

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

inlinevirtual

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

Returns: The XML tag.

Implements common::AbstractObject.

◆ loadTargetRelationships()

void witsml2_0::Channel::loadTargetRelationships ( )

virtual

Loads target relationships

Reimplemented from witsml2_0::WellboreObject.

◆ pushBackChannelIndex()

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

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.

Implements witsml2_0::ChannelIndexDataObject< gsoap_eml2_1::witsml20__Channel >.

Member Data Documentation

◆ XML_TAG

const char* witsml2_0::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.0.0.0/src/witsml2_0/Channel.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Channel() [1/3]

◆ Channel() [2/3]

◆ Channel() [3/3]

◆ ~Channel()

Member Function Documentation

◆ getChannelSets()

◆ getPropertyKind()

◆ getPropertyKindDor()

◆ getXmlTag()

◆ loadTargetRelationships()

◆ pushBackChannelIndex()

Member Data Documentation

◆ XML_TAG