Fesapi  0.13.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 | Protected Member Functions | Friends | List of all members
RESQML2_0_1_NS::PolylineRepresentation Class Reference
Inheritance diagram for RESQML2_0_1_NS::PolylineRepresentation:
RESQML2_NS::AbstractRepresentation COMMON_NS::AbstractObject

Public Member Functions

 PolylineRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 PolylineRepresentation (RESQML2_NS::AbstractFeatureInterpretation *interp, RESQML2_NS::AbstractLocal3dCrs *crs, const std::string &guid, const std::string &title, const gsoap_resqml2_0_1::resqml2__LineRole &roleKind, bool isClosed=false)
 
 PolylineRepresentation (RESQML2_NS::AbstractLocal3dCrs *crs, const std::string &guid, const std::string &title, bool isClosed=false)
 
 PolylineRepresentation (RESQML2_NS::AbstractFeatureInterpretation *interp, RESQML2_NS::AbstractLocal3dCrs *crs, const std::string &guid, const std::string &title, bool isClosed=false)
 
 PolylineRepresentation (gsoap_resqml2_0_1::_resqml2__PolylineRepresentation *fromGsoap)
 
 ~PolylineRepresentation ()
 
std::string getHdfProxyUuid () const
 
ULONG64 getXyzPointCountOfPatch (const unsigned int &patchIndex) const
 
void getXyzPointsOfPatch (const unsigned int &patchIndex, double *xyzPoints) const
 
void setGeometry (double *points, const unsigned int &pointCount, COMMON_NS::AbstractHdfProxy *proxy)
 
virtual std::string getXmlTag () const
 
bool isClosed () const
 
bool hasALineRole () const
 
bool isASeismicLine () const
 
bool isAFaciesLine () const
 
gsoap_resqml2_0_1::resqml2__LineRole getLineRole () const
 
void setLineRole (const gsoap_resqml2_0_1::resqml2__LineRole &lineRole)
 
unsigned int getPatchCount () const
 
- Public Member Functions inherited from RESQML2_NS::AbstractRepresentation
virtual ~AbstractRepresentation ()
 
class AbstractLocal3dCrsgetLocalCrs () const
 
virtual gsoap_resqml2_0_1::eml20__DataObjectReference * getLocalCrsDor () const
 
std::string getLocalCrsUuid () const
 
COMMON_NS::AbstractHdfProxygetHdfProxy () const
 
const std::vector< class AbstractProperty * > & getPropertySet () const
 
std::vector< class AbstractValuesProperty * > getValuesPropertySet () const
 
unsigned int getValuesPropertyCount () const
 
class AbstractValuesPropertygetValuesProperty (const unsigned int &index) const
 
void setInterpretation (class AbstractFeatureInterpretation *interp)
 
class AbstractFeatureInterpretationgetInterpretation () 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
 
SubRepresentationgetSubRepresentation (const unsigned int &index) const
 
std::vector< SubRepresentation * > getFaultSubRepresentationSet () const
 
unsigned int getFaultSubRepresentationCount () const
 
SubRepresentationgetFaultSubRepresentation (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
 
AbstractRepresentationgetSeismicSupportOfPatch (const unsigned int &patchIndex) const
 
std::set< AbstractRepresentation * > getAllSeismicSupport () const
 
void pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet, bool xml=true)
 
ULONG64 getRepresentationSetRepresentationCount () const
 
RepresentationSetRepresentationgetRepresentationSetRepresentation (const ULONG64 &index) const
 
void setHdfProxy (COMMON_NS::AbstractHdfProxy *proxy)
 
void addSeismic3dCoordinatesToPatch (const unsigned int patchIndex, double *inlines, double *crosslines, const unsigned int &pointCount, RESQML2_NS::AbstractRepresentation *seismicSupport, COMMON_NS::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_NS::AbstractRepresentation *seismicSupport)
 
void addSeismic2dCoordinatesToPatch (const unsigned int patchIndex, double *lineAbscissa, RESQML2_NS::AbstractRepresentation *seismicSupport, COMMON_NS::AbstractHdfProxy *proxy)
 
void getSeismicLineAbscissaOfPointsOfPatch (const unsigned int &patchIndex, double *values)
 
void getInlinesOfPointsOfPatch (const unsigned int &patchIndex, double *values)
 
void getCrosslinesOfPointsOfPatch (const unsigned int &patchIndex, double *values)
 
- Public Member Functions inherited from COMMON_NS::AbstractObject
bool isPartial () 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 getVersionString () const
 
void setTitle (const std::string &title)
 
void setEditor (const std::string &editor)
 
void setCreation (const time_t &creation)
 
void setCreation (const tm &creation)
 
void setOriginator (const std::string &originator)
 
void setDescription (const std::string &description)
 
void setLastUpdate (const time_t &lastUpdate)
 
void setLastUpdate (const tm &lastUpdate)
 
void setFormat (const std::string &format)
 
void setDescriptiveKeywords (const std::string &descriptiveKeywords)
 
void setVersionString (const std::string &versionString)
 
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_NS::EpcDocumentgetEpcDocument () 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_NS::Activity * > & getActivitySet () const
 
unsigned int getActivityCount () const
 
RESQML2_NS::ActivitygetActivity (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 = "PolylineRepresentation"
 
- Static Public Attributes inherited from RESQML2_NS::AbstractRepresentation
static const char * XML_TAG = "AbstractRepresentation"
 

Protected Member Functions

std::vector< epc::RelationshipgetAllEpcRelationships () const
 
- Protected Member Functions inherited from RESQML2_NS::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_NS::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 void importRelationshipSetFromEpc (COMMON_NS::EpcDocument *epcDoc)
 
- Protected Member Functions inherited from COMMON_NS::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 ()
 

Friends

void AbstractSurfaceRepresentation::pushBackOuterRing (PolylineRepresentation *outerRing)
 

Additional Inherited Members

- Public Types inherited from RESQML2_NS::AbstractRepresentation
enum  indexableElement {
  NODE = 0, EDGE = 1, FACE = 2, VOLUME = 3,
  PILLAR = 4
}
 
- Protected Types inherited from COMMON_NS::AbstractObject
enum  EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }
 
- Static Protected Member Functions inherited from COMMON_NS::AbstractObject
static void addActivityToResqmlObject (RESQML2_NS::Activity *activity, AbstractObject *resqmlObject)
 
- Protected Attributes inherited from RESQML2_NS::AbstractRepresentation
class AbstractFeatureInterpretationinterpretation
 
COMMON_NS::AbstractHdfProxyhdfProxy
 
class AbstractLocal3dCrslocalCrs
 
std::vector< SubRepresentation * > subRepresentationSet
 
std::vector< AbstractProperty * > propertySet
 
std::vector< AbstractRepresentation * > seismicSupportedRepSet
 
std::vector< class RepresentationSetRepresentation * > representationSetRepresentationSet
 
- Protected Attributes inherited from COMMON_NS::AbstractObject
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * gsoapProxy2_0_1
 
gsoap_eml2_1::eml21__AbstractObject * gsoapProxy2_1
 
COMMON_NS::EpcDocumentepcDocument
 
std::vector< RESQML2_NS::Activity * > activitySet
 
bool updateXml
 

Constructor & Destructor Documentation

RESQML2_0_1_NS::PolylineRepresentation::PolylineRepresentation ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context

RESQML2_0_1_NS::PolylineRepresentation::PolylineRepresentation ( RESQML2_NS::AbstractFeatureInterpretation interp,
RESQML2_NS::AbstractLocal3dCrs crs,
const std::string &  guid,
const std::string &  title,
const gsoap_resqml2_0_1::resqml2__LineRole &  roleKind,
bool  isClosed = false 
)

Creates an instance of this class in a gsoap context.

Parameters
interpThe interpretation which this representation represents.
crsThe local 3d crs where this representation is given.
guidThe guid to set to the new instance. If empty then a new guid will be generated.
titleA title for the instance to create.
roleKindIndicates the role of this representation.
isClosedIndicates wether this line representaiton is closed or not.
PolylineRepresentation::PolylineRepresentation ( RESQML2_NS::AbstractLocal3dCrs crs,
const std::string &  guid,
const std::string &  title,
bool  isClosed = false 
)

Creates an instance of this class in a gsoap context.

Parameters
crsThe local 3d crs where this representation is given.
guidThe guid to set to the new instance. If empty then a new guid will be generated.
titleA title for the instance to create.
isClosedIndicates wether this line representaiton is closed or not.
PolylineRepresentation::PolylineRepresentation ( RESQML2_NS::AbstractFeatureInterpretation interp,
RESQML2_NS::AbstractLocal3dCrs crs,
const std::string &  guid,
const std::string &  title,
bool  isClosed = false 
)

Creates an instance of this class in a gsoap context.

Parameters
interpThe interpretation which this representation represents.
crsThe local 3d crs where this representation is given.
guidThe guid to set to the new instance. If empty then a new guid will be generated.
titleA title for the instance to create.
isClosedIndicates wether this line representaiton is closed or not.
RESQML2_0_1_NS::PolylineRepresentation::PolylineRepresentation ( gsoap_resqml2_0_1::_resqml2__PolylineRepresentation *  fromGsoap)
inline

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

RESQML2_0_1_NS::PolylineRepresentation::~PolylineRepresentation ( )
inline

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

Member Function Documentation

vector< Relationship > PolylineRepresentation::getAllEpcRelationships ( ) const
protectedvirtual

Return all relationships (backward and forward ones) of the instance using EPC format.

Reimplemented from RESQML2_NS::AbstractRepresentation.

gsoap_resqml2_0_1::resqml2__LineRole PolylineRepresentation::getLineRole ( ) const

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

virtual std::string RESQML2_0_1_NS::PolylineRepresentation::getXmlTag ( ) const
inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements COMMON_NS::AbstractObject.

ULONG64 PolylineRepresentation::getXyzPointCountOfPatch ( const unsigned int &  patchIndex) const
virtual

Get the xyz point count in a given patch.

Implements RESQML2_NS::AbstractRepresentation.

void PolylineRepresentation::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
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_NS::AbstractRepresentation.

bool PolylineRepresentation::hasALineRole ( ) const

Indicates if the polyline is associated to a particular LineRole.

bool PolylineRepresentation::isAFaciesLine ( ) const

Indicates wether the instance corresponds to a facies 2d line or not.

bool PolylineRepresentation::isASeismicLine ( ) const

Indicates wether the instance corresponds to a seismic 2D line or not.

bool PolylineRepresentation::isClosed ( ) const

Indicates if the representaiton is a closed polyline or a non closed polyline.

void PolylineRepresentation::setGeometry ( double *  points,
const unsigned int &  pointCount,
COMMON_NS::AbstractHdfProxy proxy 
)
Parameters
pointsThe points which constitute the polyline. Ordered by XYZ and then points.
pointCountThe count of points in the polyline. Must be three times the count of the array of doubles "points".
proxyThe HDf proxy defining the HDF file where the double array will be stored.
void PolylineRepresentation::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: