resqml2_0_1::PolylineSetRepresentation Class Reference

Inheritance diagram for resqml2_0_1::PolylineSetRepresentation:

Public Member Functions
	PolylineSetRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	PolylineSetRepresentation (resqml2::AbstractLocal3dCrs *crs, const std::string &guid, const std::string &title)
	PolylineSetRepresentation (resqml2::AbstractFeatureInterpretation *interp, resqml2::AbstractLocal3dCrs *crs, const std::string &guid, const std::string &title)
	PolylineSetRepresentation (resqml2::AbstractFeatureInterpretation *interp, resqml2::AbstractLocal3dCrs *crs, const std::string &guid, const std::string &title, const gsoap_resqml2_0_1::resqml2__LineRole &roleKind)
	PolylineSetRepresentation (gsoap_resqml2_0_1::_resqml2__PolylineSetRepresentation *fromGsoap)
	~PolylineSetRepresentation ()
std::string	getHdfProxyUuid () const
unsigned int	getPolylineCountOfPatch (const unsigned int &patchIndex) const
unsigned int	getPolylineCountOfAllPatches () const
virtual std::string	getXmlTag () const
void	getNodeCountPerPolylineInPatch (const unsigned int &patchIndex, unsigned int *NodeCountPerPolyline) const
void	getNodeCountPerPolylineOfAllPatches (unsigned int *NodeCountPerPolyline) const
ULONG64	getXyzPointCountOfPatch (const unsigned int &patchIndex) const
void	getXyzPointsOfPatch (const unsigned int &patchIndex, double *xyzPoints) const
unsigned int	getPatchCount () const
void	pushBackGeometryPatch (unsigned int *NodeCountPerPolyline, double *nodes, const unsigned int &polylineCount, const bool &allPolylinesClosedFlag, common::AbstractHdfProxy *proxy)
void	pushBackGeometryPatch (unsigned int *NodeCountPerPolyline, double *nodes, const unsigned int &polylineCount, bool *polylineClosedFlags, common::AbstractHdfProxy *proxy)
bool	areAllPolylinesClosedOfPatch (const unsigned int &patchIndex) const
bool	areAllPolylinesClosedOfAllPatches () const
bool	areAllPolylinesNonClosedOfPatch (const unsigned int &patchIndex) const
bool	areAllPolylinesNonClosedOfAllPatches () const
void	getClosedFlagPerPolylineOfPatch (const unsigned int &patchIndex, bool *closedFlagPerPolyline) const
void	getClosedFlagPerPolylineOfAllPatches (bool *closedFlagPerPolyline) const
bool	hasALineRole () const
gsoap_resqml2_0_1::resqml2__LineRole	getLineRole () const
void	setLineRole (const gsoap_resqml2_0_1::resqml2__LineRole &lineRole)
Public Member Functions inherited from resqml2::AbstractRepresentation
virtual	~AbstractRepresentation ()
class AbstractLocal3dCrs *	getLocalCrs () const
virtual gsoap_resqml2_0_1::eml20__DataObjectReference *	getLocalCrsDor () const
std::string	getLocalCrsUuid () const
common::AbstractHdfProxy *	getHdfProxy () const
const std::vector< class AbstractProperty * > &	getPropertySet () const
std::vector< class AbstractValuesProperty * >	getValuesPropertySet () const
unsigned int	getValuesPropertyCount () const
class AbstractValuesProperty *	getValuesProperty (const unsigned int &index) const
void	setInterpretation (class AbstractFeatureInterpretation *interp)
class AbstractFeatureInterpretation *	getInterpretation () const
gsoap_resqml2_0_1::eml20__DataObjectReference *	getInterpretationDor () const
std::string	getInterpretationUuid () const
std::string	getInterpretationContentType () const
void	pushBackSubRepresentation (class SubRepresentation *subRep)
std::vector< SubRepresentation * >	getSubRepresentationSet () const
unsigned int	getSubRepresentationCount () const
SubRepresentation *	getSubRepresentation (const unsigned int &index) const
std::vector< SubRepresentation * >	getFaultSubRepresentationSet () const
unsigned int	getFaultSubRepresentationCount () const
SubRepresentation *	getFaultSubRepresentation (const unsigned int &index) const
ULONG64	getXyzPointCountOfAllPatches () const
void	getXyzPointsOfPatchInGlobalCrs (const unsigned int &patchIndex, double *xyzPoints) const
void	getXyzPointsOfAllPatches (double *xyzPoints) const
void	getXyzPointsOfAllPatchesInGlobalCrs (double *xyzPoints) const
AbstractRepresentation *	getSeismicSupportOfPatch (const unsigned int &patchIndex)
void	pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet, bool xml=true)
ULONG64	getRepresentationSetRepresentationCount () const
RepresentationSetRepresentation *	getRepresentationSetRepresentation (const ULONG64 &index) const
void	setHdfProxy (common::AbstractHdfProxy *proxy)
void	addSeismic3dCoordinatesToPatch (const unsigned int patchIndex, double *inlines, double *crosslines, const unsigned int &pointCount, resqml2::AbstractRepresentation *seismicSupport, common::AbstractHdfProxy *proxy)
void	addSeismic3dCoordinatesToPatch (const unsigned int patchIndex, const double &startInline, const double &incrInline, const unsigned int &countInline, const double &startCrossline, const double &incrCrossline, const unsigned int &countCrossline, resqml2::AbstractRepresentation *seismicSupport)
void	addSeismic2dCoordinatesToPatch (const unsigned int patchIndex, double *lineAbscissa, const unsigned int &pointCount, resqml2::AbstractRepresentation *seismicSupport, common::AbstractHdfProxy *proxy)
void	getSeismicLineAbscissaOfPointsOfPatch (const unsigned int &patchIndex, double *values)
Public Member Functions inherited from common::AbstractObject
bool	isPartial () const
std::string	getUuid () const
std::string	getTitle () const
std::string	getEditor () const
time_t	getCreation () const
std::string	getOriginator () const
std::string	getDescription () const
time_t	getLastUpdate () const
std::string	getFormat () const
std::string	getDescriptiveKeywords () const
void	setTitle (const std::string &title)
void	setEditor (const std::string &editor)
void	setCreation (const time_t &creation)
void	setOriginator (const std::string &originator)
void	setDescription (const std::string &description)
void	setLastUpdate (const time_t &lastUpdate)
void	setFormat (const std::string &format)
void	setDescriptiveKeywords (const std::string &descriptiveKeywords)
void	setMetadata (const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
void	serializeIntoStream (std::ostream *stream)
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getGsoapProxy () const
soap *	getGsoapContext () const
int	getGsoapType () const
gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const
gsoap_eml2_1::eml21__DataObjectReference *	newEmlReference () const
gsoap_resqml2_0_1::resqml2__ContactElementReference *	newResqmlContactElementReference () const
common::EpcDocument *	getEpcDocument () const
virtual std::string	getXmlNamespace () const
virtual std::string	getResqmlVersion () const
virtual std::string	getContentType () const
virtual std::string	getPartNameInEpcDocument () const
std::string	serializeIntoString ()
void	addAlias (const std::string &authority, const std::string &title)
unsigned int	getAliasCount () const
std::string	getAliasAuthorityAtIndex (const unsigned int &index) const
std::string	getAliasTitleAtIndex (const unsigned int &index) const
const std::vector< resqml2::Activity * > &	getActivitySet () const
unsigned int	getActivityCount () const
resqml2::Activity *	getActivity (const unsigned int &index) const
void	pushBackExtraMetadata (const std::string &key, const std::string &value)
std::tr1::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 (const unsigned int &index) const
std::string	getExtraMetadataStringValueAtIndex (const unsigned int &index) const

Static Public Attributes
static const char *	XML_TAG = "PolylineSetRepresentation"
Static Public Attributes inherited from resqml2::AbstractRepresentation
static const char *	XML_TAG = "AbstractRepresentation"

Additional Inherited Members
Public Types inherited from resqml2::AbstractRepresentation
enum	indexableElement {   NODE = 0, EDGE = 1, FACE = 2, VOLUME = 3,   PILLAR = 4 }
Protected Types inherited from common::AbstractObject
enum	EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }
Protected Member Functions inherited from resqml2::AbstractRepresentation
	AbstractRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	AbstractRepresentation (class AbstractFeatureInterpretation *interp, class AbstractLocal3dCrs *crs)
	AbstractRepresentation (gsoap_resqml2_0_1::resqml2__AbstractRepresentation *fromGsoap)
void	pushBackSeismicSupport (AbstractRepresentation *seismicSupport)
void	setXmlInterpretation (class AbstractFeatureInterpretation *interp)
gsoap_resqml2_0_1::resqml2__PointGeometry *	createPointGeometryPatch2_0_1 (const unsigned int &patchIndex, double *points, unsigned long long *numPoints, const unsigned int &numDimensionsInArray, common::AbstractHdfProxy *proxy)
std::string	getHdfProxyUuidFromPointGeometryPatch (gsoap_resqml2_0_1::resqml2__PointGeometry *patch) const
gsoap_resqml2_0_1::resqml2__Seismic2dCoordinates *	getSeismic2dCoordinates (const unsigned int &patchIndex) const
gsoap_resqml2_0_1::resqml2__Seismic3dCoordinates *	getSeismic3dCoordinates (const unsigned int &patchIndex) const
virtual std::vector< epc::Relationship >	getAllEpcRelationships () const
virtual void	importRelationshipSetFromEpc (common::EpcDocument *epcDoc)
Protected Member Functions inherited from common::AbstractObject
	AbstractObject ()
	Indicate whether methods update the XML (gSoap) or only the C++ classes of the API.
	AbstractObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	AbstractObject (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *proxy)
	AbstractObject (gsoap_eml2_1::eml21__AbstractObject *proxy)
void	initMandatoryMetadata ()
void	setMetadata (const std::string &guid, const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
void	cannotBePartial () const
void	changeToPartialObject ()
Static Protected Member Functions inherited from common::AbstractObject
static void	addActivityToResqmlObject (resqml2::Activity *activity, AbstractObject *resqmlObject)
Protected Attributes inherited from resqml2::AbstractRepresentation
class AbstractFeatureInterpretation *	interpretation
common::AbstractHdfProxy *	hdfProxy
class AbstractLocal3dCrs *	localCrs
std::vector< AbstractRepresentation * >	seismicSupportSet
std::vector< SubRepresentation * >	subRepresentationSet
std::vector< AbstractProperty * >	propertySet
std::vector< AbstractRepresentation * >	seismicSupportedRepSet
std::vector< class RepresentationSetRepresentation * >	representationSetRepresentationSet
Protected Attributes inherited from common::AbstractObject
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	gsoapProxy2_0_1
gsoap_eml2_1::eml21__AbstractObject *	gsoapProxy2_1
common::EpcDocument *	epcDocument
std::vector< resqml2::Activity * >	activitySet
bool	updateXml

Constructor & Destructor Documentation

resqml2_0_1::PolylineSetRepresentation::PolylineSetRepresentation ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject )

inline

Only to be used in partial transfer context

resqml2_0_1::PolylineSetRepresentation::PolylineSetRepresentation	(	resqml2::AbstractLocal3dCrs *	crs,
		const std::string &	guid,
		const std::string &	title
	)

Creates an instance of this class in a gsoap context.

Parameters

crs	The local CRS where the geometry of this representation is given.
guid	The guid to set to the new instance. If empty then a new guid will be generated.
title	A title for the instance to create.

PolylineSetRepresentation::PolylineSetRepresentation	(	resqml2::AbstractFeatureInterpretation *	interp,
		resqml2::AbstractLocal3dCrs *	crs,
		const std::string &	guid,
		const std::string &	title
	)

Creates an instance of this class in a gsoap context.

Parameters

interp	The interpretation this representation represents.
crs	The local CRS where the geometry of this representation is given.
guid	The guid to set to the new instance. If empty then a new guid will be generated.
title	A title for the instance to create.

resqml2_0_1::PolylineSetRepresentation::PolylineSetRepresentation	(	resqml2::AbstractFeatureInterpretation *	interp,
		resqml2::AbstractLocal3dCrs *	crs,
		const std::string &	guid,
		const std::string &	title,
		const gsoap_resqml2_0_1::resqml2__LineRole &	roleKind
	)

Creates an instance of this class in a gsoap context.

Parameters

interp	The interpretation this representation represents.
crs	The local CRS where the geometry of this representation is given.
guid	The guid to set to the new instance. If empty then a new guid will be generated.
title	A title for the instance to create.
roleKind	Indicates the role of this representation.

resqml2_0_1::PolylineSetRepresentation::PolylineSetRepresentation ( gsoap_resqml2_0_1::_resqml2__PolylineSetRepresentation *  fromGsoap )

inline

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

resqml2_0_1::PolylineSetRepresentation::~PolylineSetRepresentation ( )

inline

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

Member Function Documentation

bool PolylineSetRepresentation::areAllPolylinesClosedOfPatch

(

const unsigned int &

patchIndex

)

const

Check if all polylines contained in a single patch are closed or not. Notice that a returned "false" does not mean they are all not closed. Indeed they can be mixed i.e. some closed and some not.

Parameters

patchIndex

The index of the patch to check.

Returns

True if all polylines of the studied patch are closed.

bool PolylineSetRepresentation::areAllPolylinesNonClosedOfPatch

(

const unsigned int &

patchIndex

)

const

Check if all polylines contained in a single patch are closed or not. Notice that a returned "false" does not mean they are all closed. Indeed they can be mixed i.e. some closed and some not.

Parameters

patchIndex

The index of the patch to check.

Returns

True if all polylines of the studied patch are not closed.

void PolylineSetRepresentation::getClosedFlagPerPolylineOfPatch	(	const unsigned int &	patchIndex,
		bool *	closedFlagPerPolyline
	)		const

Get all the node count par polyline for all teh aptches of the representation.

Parameters

NodeCountPerPolyline

It must be pre-allocated.

gsoap_resqml2_0_1::resqml2__LineRole PolylineSetRepresentation::getLineRole

(

)

const

Get the role of this polylineSet. Throw an exception if the polylineSet has no role (see method hasALineRole).

void PolylineSetRepresentation::getNodeCountPerPolylineOfAllPatches

(

unsigned int *

NodeCountPerPolyline

)

const

Get all the node count par polyline for all teh aptches of the representation.

Parameters

NodeCountPerPolyline

It must be pre-allocated.

unsigned int PolylineSetRepresentation::getPatchCount ( ) const

virtual

Get the number of triangle patch

Implements resqml2::AbstractRepresentation.

unsigned int PolylineSetRepresentation::getPolylineCountOfPatch

(

const unsigned int &

patchIndex

)

const

Get the number of polylines in a given patch

virtual std::string resqml2_0_1::PolylineSetRepresentation::getXmlTag ( ) const

inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements common::AbstractObject.

ULONG64 PolylineSetRepresentation::getXyzPointCountOfPatch ( const unsigned int &  patchIndex ) const

virtual

Get the xyz point count in a given patch.

Implements resqml2::AbstractRepresentation.

void PolylineSetRepresentation::getXyzPointsOfPatch ( const unsigned int &  patchIndex, double *  xyzPoints  ) const

virtual

Get all the XYZ points of a particular patch of this representation. XYZ points are given in the local CRS.

Parameters

xyzPoints

A linearized 2d array where the first (quickest) dimension is coordinate dimension (XYZ) and second dimension is vertex dimension. It must be pre allocated.

Implements resqml2::AbstractRepresentation.

bool PolylineSetRepresentation::hasALineRole

(

)

const

Indicates if the polylineSet is associated to a particular LineRole.

void PolylineSetRepresentation::pushBackGeometryPatch	(	unsigned int *	NodeCountPerPolyline,
		double *	nodes,
		const unsigned int &	polylineCount,
		const bool &	allPolylinesClosedFlag,
		common::AbstractHdfProxy *	proxy
	)

Push back a new patch of polylines

Parameters

NodeCountPerPolyline	The node count per polyline in this patch. There must be polylineCount values in this array.
nodes	The XYZ values of the nodes. Ordered by XYZ and then by NodeCount. It must be three times NodeCount.
polylineCount	The polyline count in this patch.
allPolylinesClosedFlag	Indicates the closed flags of all the polylines.
proxy	The HDF proxy which defines where the nodes and triangle indices will be stored.

void PolylineSetRepresentation::pushBackGeometryPatch	(	unsigned int *	NodeCountPerPolyline,
		double *	nodes,
		const unsigned int &	polylineCount,
		bool *	polylineClosedFlags,
		common::AbstractHdfProxy *	proxy
	)

Push back a new patch of polylines

Parameters

NodeCountPerPolyline	The node count per polyline in this patch. There must be polylineCount values in this array.
nodes	The XYZ values of the nodes. Ordered by XYZ and then by NodeCount. It must be three times NodeCount.
polylineCount	The polyline count in this patch.
polylineClosedFlags	Indicates the closed flags for each of the polyline. The count of this array must be polylineCount.
proxy	The HDF proxy which defines where the nodes and triangle indices will be stored.

void PolylineSetRepresentation::setLineRole

(

const gsoap_resqml2_0_1::resqml2__LineRole &

lineRole

)

Set the line role of this instance

---

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

• C:/Users/Philippe/dev/fesapiEnv/fesapi/src/resqml2_0_1/PolylineSetRepresentation.h
• C:/Users/Philippe/dev/fesapiEnv/fesapi/src/resqml2_0_1/PolylineSetRepresentation.cpp