Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 12]

►Ncommon	The common namespace. This namespace contains classes that are common to different Energistics data models and classes that handle the EPC document (EpcDocument) and the data object repository (DataObjectRepository) as well. These two last classes are starting points to write or read an EPC document contaning some data objects
CAbstractObject	An abstract data object
CDataObjectReference	This class wraps an Energistics Data Object Reference whatever its version is
CDataObjectRepository	A DataObjectRepository stores in memory all dataObjects. This is the in-memory container which holds deserialized (EPC) files and fetched ETP dataobjects. On the other direction, it is also used to store dataobjets which you want either to serialize in (EPC) files or pushed to an ETP store. It is not a database (it is much more a simple container). For instance, in most cases, you are not supposed to delete anything neither update relationships. It also controls the creation and the deletion of all contained dataobjects meaning that when you delete it, it also deletes all contained dataobjects. It does not store numerical values of the dataobjects but only their XML definitions
CEnumStringMapper	A class for mapping enum values with strings
CEpcDocument	EPC is an implementation of the Open Packaging Conventions (OPC), a widely used container-file technology that allows multiple types of files to be bundled together into a single package. Built on the widely used ZIP file structure and originally created by Microsoft, OPC is now an open standard supported by these standards organizations:
CHdfProxyFactory	An HDF5 file proxy factory
CHdfProxyMPIFactory	A proxy factory for an HDF5 file accessed through HDF5 parallel library (OpenMPI)
CHdfProxyROS3Factory	A proxy factory for an HDF5 file located on an Amazon S3 cloud. Here, HDF5 file access is read only
►NCOMMON_NS
CDataFeeder
►Neml2	The eml2 namespace. This namespaces contains classes to handle data objects that exist in various EML v2.*. The classes of this namespace should be favored, when possible, instead of the classes of the namespace eml2_0, , and eml2_3
CAbstractHdfProxy	An abstract proxy for reading and writing values into an HDF5 file. It is possible to derive this class in a custom class in order for the FESAPI user to get change the FESAPI reads from and writes to HDF5 file. However, please note that the RESQML standard mandates so far a HDF5 1.8 backward compatibility. In ordre to achieve this backward compatibility please use hid_t access_props = H5Pcreate (H5P_FILE_ACCESS); H5Pset_libver_bounds (access_props, H5F_LIBVER_V18, H5F_LIBVER_V18); when you create an HDF5 file before to write into it. See https://confluence.hdfgroup.org/display/HDF5/H5P_SET_LIBVER_BOUNDS for more details
CAbstractLocal3dCrs	Proxy class for an abstract local 3D coordinate reference system (CRS)
CActivity	Instance of a given activity
CActivityTemplate	Description of one type of activity
CEpcExternalPartReference	Proxy class for handling external parts of an EPC package. It must be used at least for external HDF5 parts
CGraphicalInformationSet	Proxy class for handling the graphical information of data objects
CHdfProxy	A proxy for reading and writing values into an HDF5 file
CPropertyKind	Property kinds carry the semantics of property values. They are used to identify if the values are, for example, representing porosity, length, stress tensor, etc. Energistics provides a list of standard property kind that represent the basis for the commonly used properties in the E&P subsurface workflow
CTimeSeries	Proxy class for time series. Stores an ordered list of times, for example, for time- dependent properties, geometries, or representations. It is used in conjunction with the time index to specify times for RESQML
►Neml2_0	The eml2_0 namespace
CHdfProxy
CHdfProxyMPI
CHdfProxyROS3
►Neml2_3	The eml2_3 namespace
CActivity
CActivityTemplate
CGraphicalInformationSet	Proxy class for handling the graphical information of data objects
CHdfProxy
CLocalEngineering2dCrs
CLocalEngineeringCompoundCrs
CPropertyKind
CTimeSeries
CVerticalCrs
►Nepc	The epc namespace
CContentType
CCoreProperty
CFileContentType
CFileCoreProperties
CFilePart
CFileRelationship
CPackage
CRelationship
►Nprodml2_2
CCompositionalSpecification
CCompositionalViscositySpecification
CCorrelationViscosityBubblePointSpecification
CCorrelationViscositySpecification
CFluidCharacterization
CFluidSystem
CFrictionTheorySpecification
CPvtSpecification
CTimeSeriesData
►Nresqml2	The resqml2 namespace. This namespaces contains classes to handle data objects that exist in both RESQML v2.0.1 and RESQML v2.2. The classes of this namespace should be favored, when possible, instead of the classes of the namespace resqml2_0_1 and resqml2_2
CAbstractColorMap	Map of abstract colors
CAbstractColumnLayerGridRepresentation	Proxy class for an abstract column layer grid representation
CAbstractFeature	Proxy class for an abstract feature
CAbstractFeatureInterpretation	Proxy class for an abstract feature interpretation
CAbstractGridRepresentation	Proxy class for an abstract grid representation
CAbstractIjkGridRepresentation	Proxy class for an abstract IJK grid representation. This class is semantically abstract. Technically speaking, it is not an abstract because it can be used in case of partial transfer where we don't know the geometry of the IJK grid
CAbstractOrganizationInterpretation	This class defines the behaviour of all RESQML2 organizations
CAbstractProperty	Proxy class for an abstract property
CAbstractRepresentation	Proxy class for an abstract representation
CAbstractSeismicLineFeature	Proxy class for an abstract seismic line feature. Defined by one lateral dimension: trace (lateral). Seismic trace of the 3D seismic survey. To specify its location, the seismic feature can be associated with the seismic coordinates of the points of a representation
CAbstractStratigraphicOrganizationInterpretation	An abstract stratigraphic organization interpretation is the main class that defines the relationships between the stratigraphic units and provides the stratigraphic hierarchy of the earth
CAbstractSurfaceFrameworkRepresentation	Parent class for a sealed or non-sealed surface framework representation. Each one instantiates a representation set representation. The difference between the sealed and non- sealed frameworks is that, in the non-sealed case, we do not have all of the contacts, or we have all of the contacts but they are not all sealed
CAbstractSurfaceRepresentation	An abstract surface representation. It is the parent class of structural surface representations, which can be bounded by an outer ring and has inner rings. These surfaces may consist of one or more patches
CAbstractTechnicalFeature	An abstract technical feature. These are objects that exist by the action of humans
CAbstractValuesProperty	Proxy class for an abstract values property
CBlockedWellboreRepresentation	A blocked wellbore representation. This is the information that allows you to locate, on one or several grids (existing or planned), the intersection of volume (cells) and surface (faces) elements with a wellbore trajectory (existing or planned)
CBoundaryFeature	A boundary feature. This is an interface between two geological objects, such as horizons and faults. It is a surface object
CBoundaryFeatureInterpretation	A boundary feature interpretation. This is the main class for data describing an opinion of a surface feature between two volumes
CCategoricalProperty	Proxy class for a categorical property. It contains discrete integers. This type of property is associated either: as an internally stored index to a string through a lookup mapping, or as an internally stored double to another double value through an explicitly provided table
CCmpLineFeature
CCommentProperty	Proxy class for a comment property. It is used to capture comments or annotations associated with a given element type in a data-object, for example, associating comments on the specific location of a well path
CContinuousColorMap	Map of continuous colors. This class cannot be inherited
CContinuousProperty	Proxy class for a continuous property. Most common type of property used for storing rock or fluid attributes; all are represented as floating point values. So that the value range can be known before accessing all values, the min and max values of the range are also optionally stored
CCulturalFeature	A cultural feature. It identifies a frontier or boundary in the earth model that is not a geological feature but an arbitrary geographic/geometric surface used to delineate the boundary of the model
CDiscreteColorMap	Map of discrete colors. This class cannot be inherited
CDiscreteProperty	Proxy class for a discrete property. Such property contains discrete integer values; typically used to store any type of index. So that the value range can be known before accessing all values, it also optionally stores the minimum and maximum value in the range
CDoubleTableLookup	Defines a function for table lookups. For example, used for linear interpolation, such as PVT
CEarthModelInterpretation	This class is a container for stratigraphic, structural and rock fluid organization interpretations that are consistent to each others
CFaultInterpretation	A fault interpretation. This type of boundary feature contains the data describing an opinion about the characterization of the fault
CFluidBoundaryInterpretation
CGenericFeatureInterpretation	An interpretation of a feature that is not specialized. For example, use it when the specialized type of the associated feature is not known
CGeobodyBoundaryInterpretation	A type of boundary feature, this class identifies if the boundary is a geobody and the type of the boundary
CGeobodyInterpretation	A type of rock feature, this class identifies if a rock feature is a geobody with any qualifications on the interpretation of the geobody
CGrid2dRepresentation	A 2d grid representation
CGridConnectionSetRepresentation	Proxy class for a grid connection set representation. This representation consists of a list of connections between grid cells, potentially on different grids
CHorizonInterpretation	An interpretation of a horizon, which optionally provides stratigraphic information
CIjkGridExplicitRepresentation	An IJK Grid explicit representation defines each cell corner position by means of XYZ coordinates. Adjacent cell corner are supposed to be located the same so they are not repeated unless you define split lines or split nodes
CIjkGridLatticeRepresentation	The main use case for this class is the representation of a seismic cubes. I is the fastest axis and K is the slowest axis. Notice that seismic domain will more likely use a vertical axis as the fastest one where a reservori domain will more likely use a vertical axis as the fastest one
CIjkGridNoGeometryRepresentation	This class is dedicated to IJK grids with undefined IjkGridGeometry. There are two main use cases. A first one is block-centered grid, where no geometry is attached to nodes but a property should spatialize cells centers. A second one is LGRs (local refinement grids), where the refined geometry is given thanks to refinement parameters
CIjkGridParametricRepresentation	An IJK Grid parametric representation define the cell corner positions by means of parameters along the pillars of the grid. Adjacent cell corner are supposed to be located the same so they are not repeated unless you define split lines or split nodes
CMdDatum	Proxy class for a MD datum. An MD datum specifies the location of the measured depth = 0 reference point. The location of this reference point is defined with respect to a CRS, which need not be the same as the CRS of a wellbore trajectory representation, which may reference this location
CModel	The explicit description of the relationships between geologic features, such as rock features (e.g. stratigraphic units, geobodies, phase unit) and boundary features (e.g., genetic, tectonic, and fluid boundaries). In general, this concept is usually called an "earth model", but it is not called that in RESQML
CNonSealedSurfaceFrameworkRepresentation	A non sealed surface framework representation is collection of contact representations parts, which are a list of contact patches with no identity. This collection of contact representations is completed by a set of representations gathered at the representation set representation level
CPlaneSetRepresentation	Defines a plane representation, which can be made up of multiple patches. Commonly represented features are fluid contacts or frontiers. Common geometries of this representation are titled or horizontal planes
CPointSetRepresentation	A representation that consists of one or more node patches. Each node patch is an array of xyz coordinates for the 3D points. There is no implied linkage between the multiple patches
CPointsProperty	Proxy class for an points property
CPolylineRepresentation	A representation made up of a single polyline or "polygonal chain", which may be closed or not. See definition here: http://en.wikipedia.org/wiki/Piecewise_linear_curve
CPolylineSetRepresentation	A representation made up of a set of polylines or a set of polygonal chains (for more information, see PolylineRepresentation)
CRepresentationSetRepresentation	Proxy class for a representation set representation. This is the parent class of the framework representations. It is used to group together individual representations to represent a "bag" of representations
CRockFluidOrganizationInterpretation	This class describes the organization of geological reservoir, i.e., of an interconnected network of porous and permeable rock units, containing an accumulation of economic fluids, such as oil and gas. A reservoir is normally enveloped by rock and fluid barriers and contains a single natural pressure system
CRockFluidUnitInterpretation	A type of rock fluid feature-interpretation , this class identifies a rock fluid feature by its phase
CRockVolumeFeature	A continuous portion of rock material bounded by definite rock boundaries. It is a volume object
CSealedSurfaceFrameworkRepresentation	A collection of contact, which are a list of contact patches and their identities. This collection of contact is completed by a set of representations gathered at the representation set representation level
CSealedVolumeFrameworkRepresentation	A strict boundary representation (BREP), which represents the volume region by assembling together shells
CSeismicLatticeFeature	Defined by two lateral ordered dimensions: inline (lateral), crossline (lateral and orthogonal to the inline dimension), which are fixed
CSeismicLineSetFeature	Frox class for a seismic line set feature. It is an unordered set of several seismic lines. Generally, it has no direct interpretation or representation
CSeismicWellboreFrameRepresentation	A seismic wellbore frame representation. This class cannot be inherited
CShotPointLineFeature
CStratigraphicColumn	A global interpretation of the stratigraphy, which can be made up of several ranks of stratigraphic unit interpretations
CStratigraphicColumnRankInterpretation	A stratigraphic column rank interpretation is a global hierarchy containing an ordered list of stratigraphic unit interpretations
CStratigraphicOccurrenceInterpretation	This class is a container for stratigraphic organizations described along a wellbore
CStratigraphicUnitInterpretation	The interpretation of a stratigraphic unit
CStreamlinesFeature	Specification of the vector field upon which the streamlines are based
CStreamlinesRepresentation	Representation of streamlines associated with a streamline feature and interpretation. Use the StreamlinesFeature to specify the vector field that supports the streamlines, i.e., describes what flux is being traced. Use the Generic Feature Interpretation to distinguish between shared and differing interpretations
CStringTableLookup	Defines an integer (key) to string (value) lookup table, for example, stores facies properties, where a facies index is associated with a facies name
CStructuralOrganizationInterpretation	One of the main types of RESQML organizations, this class gathers boundary interpretations (e.g., horizons and faults) plus frontier features and their relationships (contacts interpretations), which when taken together define the structure of a part of the earth
CSubRepresentation	Proxy class for a sub-representation. A sub representation is an ordered list of indexable elements and/or indexable element pairs of an existing representation
CTriangulatedSetRepresentation	A triangulated representation is a representation (most of time a surface) which is constituted by triangles. Usually all triangles are connected to each others by means of their nodes and edges
CUnstructuredGridRepresentation	Unstructured grid representation characterized by a cell count, and potentially nothing else. Both the oldest and newest simulation formats are based on this format
CWellboreFeature	May refer to one of these: wellbore, borehole or sidetrack
CWellboreFrameRepresentation	Proxy class for a wellbore frame representation. A wellbore frame representation is a representation of a wellbore that is organized along a wellbore trajectory by its MD values
CWellboreInterpretation	Contains the data describing an opinion of a borehole.This interpretation is relative to one particular well trajectory
CWellboreMarker	Representation of a wellbore marker that is located along a wellbore trajectory, one for each MD value in the wellbore frame
CWellboreMarkerFrameRepresentation	A well log frame where each entry represents a well marker
CWellboreTrajectoryRepresentation	Representation of a wellbore trajectory
►Nresqml2_0_1	The resqml2_0_1 namespace
CActivity
CActivityTemplate
CBlockedWellboreRepresentation
CBoundaryFeature
CBoundaryFeatureInterpretation
CCategoricalProperty
CCommentProperty
CContinuousProperty
CDeviationSurveyRepresentation	A deviation survey representation. It Specifies the station data from a deviation survey
CDiscreteProperty
CDoubleTableLookup
CEarthModelInterpretation
CFaultInterpretation
CFluidBoundaryFeature
CFrontierFeature
CGenericFeatureInterpretation
CGeneticBoundaryFeature
CGeobodyBoundaryInterpretation
CGeobodyFeature
CGeobodyInterpretation
CGeologicUnitFeature
CGrid2dRepresentation
CGridConnectionSetRepresentation
CHorizon
CHorizonInterpretation
CIjkGridExplicitRepresentation
CIjkGridLatticeRepresentation	An ijk grid lattice representation. This class cannot be inherited
CIjkGridNoGeometryRepresentation	An ijk grid no geometry representation. This class cannot be inherited
CIjkGridParametricRepresentation
CLocalDepth3dCrs	Defines a local depth coordinate system. The geometrical origin and location are defined by the elements of the base class AbstractLocal3dCrs. This CRS uses the units of measure of its projected and vertical CRS
CLocalTime3dCrs
CMdDatum
CNonSealedSurfaceFrameworkRepresentation
COrganizationFeature
CPlaneSetRepresentation
CPointSetRepresentation
CPointsProperty	Proxy class for an points property
CPolylineRepresentation
CPolylineSetRepresentation
CPropertyKind
CPropertyKindMapper
CPropertySet	Proxy class for a property set. A property set is a set of properties collected together for a specific purpose
CRepresentationSetRepresentation
CRockFluidOrganizationInterpretation
CRockFluidUnitFeature
CRockFluidUnitInterpretation	A rock fluid unit interpretation. This class cannot be inherited
CSealedSurfaceFrameworkRepresentation
CSealedVolumeFrameworkRepresentation
CSeismicLatticeFeature
CSeismicLineFeature
CSeismicLineSetFeature
CStratigraphicColumn
CStratigraphicColumnRankInterpretation
CStratigraphicOccurrenceInterpretation
CStratigraphicUnitFeature
CStratigraphicUnitInterpretation
CStreamlinesFeature	Specification of the vector field upon which the streamlines are based
CStreamlinesRepresentation	Specification of the vector field upon which the streamlines are based
CStringTableLookup
CStructuralOrganizationInterpretation	A structural organization interpretation. This class cannot be inherited
CSubRepresentation
CTectonicBoundaryFeature
CTimeSeries
CTriangulatedSetRepresentation
CUnstructuredGridRepresentation	An unstructured grid representation. This class cannot be inherited
CWellboreFeature
CWellboreFrameRepresentation
CWellboreInterpretation
CWellboreMarker
CWellboreMarkerFrameRepresentation
CWellboreTrajectoryRepresentation
►Nresqml2_2	The resqml2_2 namespace
CBlockedWellboreRepresentation
CBoundaryFeature
CBoundaryFeatureInterpretation
CCmpLineFeature
CCommentProperty
CContinuousColorMap	Map of continuous colors. This class cannot be inherited
CContinuousProperty
CCulturalFeature
CDiscreteColorMap	Map of discrete colors. This class cannot be inherited
CDiscreteProperty
CEarthModelInterpretation
CFaultInterpretation
CFluidBoundaryInterpretation
CGenericFeatureInterpretation
CGeobodyBoundaryInterpretation
CGeobodyInterpretation
CGrid2dRepresentation
CGridConnectionSetRepresentation
CHorizonInterpretation
CIjkGridExplicitRepresentation
CIjkGridLatticeRepresentation	An ijk grid lattice representation. This class cannot be inherited
CIjkGridNoGeometryRepresentation	An ijk grid no geometry representation. This class cannot be inherited
CIjkGridParametricRepresentation
CModel
CNonSealedSurfaceFrameworkRepresentation
CPlaneSetRepresentation
CPointSetRepresentation
CPointsProperty	Proxy class for an points property
CPolylineRepresentation
CPolylineSetRepresentation
CRepresentationSetRepresentation
CRockFluidOrganizationInterpretation
CRockFluidUnitInterpretation	A rock fluid unit interpretation. This class cannot be inherited
CRockVolumeFeature
CSealedSurfaceFrameworkRepresentation
CSealedVolumeFrameworkRepresentation
CSeismicLatticeFeature
CSeismicLineSetFeature
CSeismicWellboreFrameRepresentation	A seismic wellbore frame representation. This class cannot be inherited
CShotPointLineFeature
CStratigraphicColumn
CStratigraphicColumnRankInterpretation
CStratigraphicUnitInterpretation
CStreamlinesFeature	Specification of the vector field upon which the streamlines are based
CStreamlinesRepresentation	Specification of the vector field upon which the streamlines are based
CStructuralOrganizationInterpretation	A structural organization interpretation. This class cannot be inherited
CSubRepresentation
CTriangulatedSetRepresentation
CUnstructuredGridRepresentation	An unstructured grid representation. This class cannot be inherited
CWellboreFeature
CWellboreFrameRepresentation	A wellbore frame representation
CWellboreInterpretation
CWellboreTrajectoryRepresentation
►Nwitsml2_1	The witsml2_1 namespace
CChannel
CChannelIndexDataObject
CChannelMetaDataObject
CChannelSet
CErrorTerm
CErrorTermDictionary
CLog
CToolErrorModel
CToolErrorModelDictionary
CTrajectory	It contains many trajectory stations to capture the information about individual survey points
CWeightingFunction
CWeightingFunctionDictionary
CWell	Contains all information that is the same for all wellbores (sidetracks)
CWellbore	A wellbore represents the path from surface to a unique bottomhole location
CWellboreCompletion
CWellboreGeometry
CWellboreMarker
CWellboreMarkerSet
CWellCompletion
►NWITSML2_NS
CTrajectory	It contains many trajectory stations to capture the information about individual survey points
CWell	Contains all information that is the same for all wellbores (sidetracks)
CWellbore	A wellbore represents the path from surface to a unique bottomhole location
CWellboreObject