Fesapi  2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | Static Public Attributes | List of all members
resqml2_2::PlaneSetRepresentation Class Referencefinal

#include <PlaneSetRepresentation.h>

Inheritance diagram for resqml2_2::PlaneSetRepresentation:
resqml2::PlaneSetRepresentation resqml2::AbstractSurfaceRepresentation resqml2::AbstractRepresentation common::AbstractObject

Public Member Functions

 PlaneSetRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 PlaneSetRepresentation (resqml2::AbstractFeatureInterpretation *interp, const std::string &guid, const std::string &title)
 Creates an instance of this class in a gsoap context. More...
 
 PlaneSetRepresentation (gsoap_eml2_3::_resqml22__PlaneSetRepresentation *fromGsoap)
 
 ~PlaneSetRepresentation ()=default
 
common::DataObjectReference getLocalCrsDor (unsigned int patchIndex) const final
 
uint64_t getXyzPointCountOfPatch (unsigned int patchIndex) const final
 
void getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const final
 
unsigned int getPatchCount () const final
 
void pushBackHorizontalPlaneGeometryPatch (double zCoordinate, resqml2::AbstractLocal3dCrs *localCrs=nullptr) final
 
void pushBackTiltedPlaneGeometryPatch (double x1, double y1, double z1, double x2, double y2, double z2, double x3, double y3, double z3, resqml2::AbstractLocal3dCrs *localCrs=nullptr) final
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from resqml2::PlaneSetRepresentation
common::DataObjectReference getHdfProxyDor () const
 Gets the data object reference of the HDF proxy which is used for storing the numerical values of this representation (i.e. its geometry). More...
 
virtual std::string getXmlTag () const final
 
- Public Member Functions inherited from resqml2::AbstractSurfaceRepresentation
virtual ~AbstractSurfaceRepresentation ()=default
 
unsigned int getBoundariesCount () const
 
common::DataObjectReference getOuterRingDor (unsigned int index) const
 
void pushBackOuterRing (PolylineRepresentation *outerRing)
 
void setSurfaceRole (gsoap_resqml2_0_1::resqml20__SurfaceRole surfaceRole)
 
gsoap_resqml2_0_1::resqml20__SurfaceRole getSurfaceRole () const
 
- Public Member Functions inherited from resqml2::AbstractRepresentation
virtual ~AbstractRepresentation ()=default
 
class AbstractLocal3dCrsgetLocalCrs (unsigned int patchIndex) const
 
std::vector< class AbstractProperty * > getPropertySet () const
 
void setInterpretation (class AbstractFeatureInterpretation *interp)
 
class AbstractFeatureInterpretationgetInterpretation () const
 
common::DataObjectReference getInterpretationDor () const
 
uint64_t getXyzPointCountOfAllPatches () const
 
void getXyzPointsOfPatchInGlobalCrs (unsigned int patchIndex, double *xyzPoints) const
 Gets all the xyz points of a particular patch of this representation. xyz points are given in the global CRS. More...
 
void getXyzPointsOfAllPatches (double *xyzPoints) const
 Gets all the xyz points of all patches of this representation. xyz points are given in the local CRS. More...
 
bool isInSingleLocalCrs () const
 
bool isInSingleGlobalCrs () const
 
void getXyzPointsOfAllPatchesInGlobalCrs (double *xyzPoints) const
 
AbstractRepresentationgetSeismicSupportOfPatch (const unsigned int &patchIndex) const
 
std::set< AbstractRepresentation * > getAllSeismicSupport () const
 
void pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet)
 
void addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double *inlines, double *crosslines, unsigned int pointCount, resqml2::AbstractRepresentation *seismicSupport, eml2::AbstractHdfProxy *proxy)
 
void addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double startInline, double incrInline, unsigned int countInline, double startCrossline, double incrCrossline, unsigned int countCrossline, resqml2::AbstractRepresentation *seismicSupport)
 
void addSeismic2dCoordinatesToPatch (unsigned int patchIndex, double *lineAbscissa, resqml2::AbstractRepresentation *seismicSupport, eml2::AbstractHdfProxy *proxy)
 
void getSeismicLineAbscissaOfPointsOfPatch (unsigned int patchIndex, double *values) const
 
void getInlinesOfPointsOfPatch (unsigned int patchIndex, double *values) const
 
void getCrosslinesOfPointsOfPatch (unsigned int patchIndex, double *values) const
 
- 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::DataObjectRepositorygetRepository () const
 
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)
 
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::ActivitygetActivity (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_NS
 
- Static Public Attributes inherited from resqml2::PlaneSetRepresentation
static const char * XML_TAG
 
- Static Public Attributes inherited from resqml2::AbstractRepresentation
static const char * XML_TAG
 

Additional Inherited Members

- Public Types inherited from resqml2::AbstractRepresentation
enum  indexableElement {
  NODE = 0 , EDGE = 1 , FACE = 2 , VOLUME = 3 ,
  PILLAR = 4
}
 
- 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

A plane set representation.

Constructor & Destructor Documentation

◆ PlaneSetRepresentation() [1/3]

resqml2_2::PlaneSetRepresentation::PlaneSetRepresentation ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context

Parameters
[in,out]partialObjectIf non-null, the partial object.

◆ PlaneSetRepresentation() [2/3]

resqml2_2::PlaneSetRepresentation::PlaneSetRepresentation ( resqml2::AbstractFeatureInterpretation interp,
const std::string &  guid,
const std::string &  title 
)

Creates an instance of this class in a gsoap context.

Exceptions
std::invalid_argumentIf interp == nullptr.
Parameters
[in]interpThe interpretation this representation represents.
guidThe guid to set to the new instance. If empty then a new guid will be generated.
titleA title for the instance to create.

◆ PlaneSetRepresentation() [3/3]

resqml2_2::PlaneSetRepresentation::PlaneSetRepresentation ( gsoap_eml2_3::_resqml22__PlaneSetRepresentation *  fromGsoap)
inline

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

Parameters
[in,out]fromGsoapIf non-null, from gsoap.

◆ ~PlaneSetRepresentation()

resqml2_2::PlaneSetRepresentation::~PlaneSetRepresentation ( )
virtualdefault

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

Reimplemented from resqml2::PlaneSetRepresentation.

Member Function Documentation

◆ getLocalCrsDor()

common::DataObjectReference resqml2_2::PlaneSetRepresentation::getLocalCrsDor ( unsigned int  patchIndex) const
finalvirtual

Gets the data object reference of the local 3d CRS associated to a given patch of this representation. This local CRS is where the point ordinals are given.

Exceptions
std::out_of_rangeIf patchIndex is out of range.
Parameters
patchIndexZero-based index of the patch for which we look for the local CRS.
Returns
Empty data object reference if it fails, else the data object reference of the local CRS associated to the patchIndex patch.

Reimplemented from resqml2::AbstractRepresentation.

◆ getPatchCount()

unsigned int resqml2_2::PlaneSetRepresentation::getPatchCount ( ) const
finalvirtual

Get the number of triangle patch

Returns
The patch count.

Implements resqml2::AbstractRepresentation.

◆ getXmlNamespace()

std::string resqml2_2::PlaneSetRepresentation::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ getXyzPointCountOfPatch()

uint64_t resqml2_2::PlaneSetRepresentation::getXyzPointCountOfPatch ( unsigned int  patchIndex) const
finalvirtual

Get the xyz point count in a given patch of this representation.

Exceptions
std::out_of_rangeIf patchIndex is out of range.
std::logic_errorIf this representation is partial.
Parameters
patchIndexZero-based index of the patch from which we look for the xyz points.
Returns
The xyz point count of the patch at position patchIndex.

Implements resqml2::AbstractRepresentation.

◆ getXyzPointsOfPatch()

void resqml2_2::PlaneSetRepresentation::getXyzPointsOfPatch ( unsigned int  patchIndex,
double *  xyzPoints 
) const
finalvirtual

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

Parameters
patchIndexZero-based index of the patch.
[in,out]xyzPointsA 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.

◆ pushBackHorizontalPlaneGeometryPatch()

void resqml2_2::PlaneSetRepresentation::pushBackHorizontalPlaneGeometryPatch ( double  zCoordinate,
resqml2::AbstractLocal3dCrs localCrs = nullptr 
)
finalvirtual

Pushes back a new patch which is an horizontal plane.

Exceptions
std::invalid_argumentIf localCrs == nullptr and no default CRS is defined in the repository.
Parameters
zCoordinateThe z coordinate of the horizontal plane.
[in]localCrs(Optional) If non-null, the local CRS. If nullptr (default), the repository default local CRS will be used.

Implements resqml2::PlaneSetRepresentation.

◆ pushBackTiltedPlaneGeometryPatch()

void resqml2_2::PlaneSetRepresentation::pushBackTiltedPlaneGeometryPatch ( double  x1,
double  y1,
double  z1,
double  x2,
double  y2,
double  z2,
double  x3,
double  y3,
double  z3,
resqml2::AbstractLocal3dCrs localCrs = nullptr 
)
finalvirtual

Pushs back a new patch which is not a horizontal plane. Its geometry is given by means of 3 xyz points.

Exceptions
std::invalid_argumentIf localCrs == nullptr and no default CRS is defined in the repository.
Parameters
x1The x value of the first point.
y1The y value of the first point.
z1The z value of the first point.
x2The x value of the second point.
y2The y value of the second point.
z2The z value of the second point.
x3The x value of the third point.
y3The y value of the third point.
z3The z value of the third point.
[in]localCrs(Optional) If non-null, the local CRS. If nullptr (default), the repository default local CRS will be used.

Implements resqml2::PlaneSetRepresentation.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::PlaneSetRepresentation::XML_NS
static

The standard XML namespace for serializing this data object.


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