From 1f6180d64f9923f54f5460e7c4e68d1c91030229 Mon Sep 17 00:00:00 2001
From: wfg <wfg@pc0098504.ornl.gov>
Date: Wed, 23 Nov 2016 12:13:26 -0500
Subject: [PATCH] Working on ADIOS class to reflect changes on API
Working on class CGroup and CCapsule
---
doc/CodingGuidelines | 5 +-
include/core/CCapsule.h | 13 ++----
include/core/CGroup.h | 1 +
include/public/ADIOS.h | 101 ++++++++++++++++++++++++----------------
src/public/ADIOS.cpp | 6 +++
5 files changed, 76 insertions(+), 50 deletions(-)
diff --git a/doc/CodingGuidelines b/doc/CodingGuidelines
index ab260d64a..e05631f89 100644
--- a/doc/CodingGuidelines
+++ b/doc/CodingGuidelines
@@ -163,8 +163,7 @@ Avoid mixing C-like equivalents
C++ Exceptions
1) Throw C++ standard exceptions for error handling, do not throw integers.
This is helpful as it allows handling of different exception types in different ways.
- In rare cases a custom exception must be defined/declared.
+ In rare cases a custom exceptions must be defined/declared.
2) Use informative messages for exception handling to complement the nature of the exception.
Help the user fix the error/warning.
-3) Error exceptions (program stops) must start with "ERROR: ",
- warnings (program doesn't stop) must start with "WARNING: " in the log or standard output.
\ No newline at end of file
+3) Error exceptions that are caught at main (program stops) must start with "ERROR: "
\ No newline at end of file
diff --git a/include/core/CCapsule.h b/include/core/CCapsule.h
index dbcf6edb4..c2d0f6ee8 100644
--- a/include/core/CCapsule.h
+++ b/include/core/CCapsule.h
@@ -50,6 +50,11 @@ public:
int m_RankMPI = 0; ///< current MPI rank process
int m_SizeMPI = 1; ///< current MPI processes size
+ std::map< std::string, std::shared_ptr<CTransport> > m_Transport;
+ std::vector<char> Buffer;
+ size_t m_MaxBufferSize = 0;
+ std::string m_GroupName; ///< associated group to look for variable information
+
/**
*
* @param streamName
@@ -127,14 +132,6 @@ public:
*/
void Close( const std::string streamName );
-
-private:
-
- std::map< std::string, std::shared_ptr<CTransport> > m_Transport;
- std::vector<char> Buffer;
- size_t m_MaxBufferSize = 0;
- std::string GroupName; ///< associated group to look for variable information
-
};
diff --git a/include/core/CGroup.h b/include/core/CGroup.h
index ad0690289..fd04c071e 100644
--- a/include/core/CGroup.h
+++ b/include/core/CGroup.h
@@ -170,6 +170,7 @@ private:
const unsigned long long int GetIntVariableValue( const std::string variableName ) const;
+
};
diff --git a/include/public/ADIOS.h b/include/public/ADIOS.h
index 884fa1f08..ae7912998 100644
--- a/include/public/ADIOS.h
+++ b/include/public/ADIOS.h
@@ -85,7 +85,6 @@ public: // PUBLIC Constructors and Functions define the User Interface with ADIO
* @param accessMode "w": write, "a": append, need more info on this
* @param maxBufferSize used for transport
*/
-
template< class... Args >
void Open( const std::string streamName, const std::string accessMode, Args... args )
{
@@ -101,36 +100,58 @@ public: // PUBLIC Constructors and Functions define the User Interface with ADIO
/**
- * Submits a data element values for writing and associates it with the given variableName
- * @param groupName name of group that owns the variable
- * @param variableName name of existing scalar or vector variable in the XML file or created with CreateVariable
- * @param values pointer to the variable values passed from the user application, use dynamic_cast to check that pointer is of the same value type
+ * Sets a transport method to be associated with a group.
+ * @param streamName unique name
+ * @param transport method to be associated
+ */
+ void SetTransport( const std::string streamName, const std::string transport );
+
+
+ /**
+ * Sets a default group to be associated with a stream before writing variables with Write function.
+ * @param streamName unique name
+ * @param groupName default group from which variables will be used
*/
+ void SetGroup( const std::string streamName, const std::string groupName );
+
+
template<class T>
- void Write( const std::string streamName, const std::string variableName, const T* values, const unsigned int cores = 1 )
+ void Write( const std::string streamName, const std::string groupName, const std::string variableName, const T* values )
{
+ auto itCapsule = m_Capsules.find( streamName );
auto itGroup = m_Groups.find( groupName );
+
if( m_DebugMode == true )
{
- CheckGroup( itGroup, groupName, " from call to Write with variable " + variableName );
-
- if( itGroup->second.m_IsOpen == false )
- throw std::invalid_argument( "ERROR: group " + groupName + " is not open in Write function.\n" );
+ CheckCapsule( itCapsule, streamName, " from call to Write variable " + variableName );
+ CheckGroup( itGroup, groupName, " from call to Write variable " + variableName );
}
+
WriteHelper( itGroup->second, variableName, values, m_Capsules );
}
+ /**
+ * Write version using default group, set with Function SetGroup.
+ * Submits a data element values for writing and associates it with the given variableName
+ * @param streamName stream or file to be written to
+ * @param variableName name of existing scalar or vector variable in the XML file or created with CreateVariable
+ * @param values pointer to the variable values passed from the user application, use dynamic_cast to check that pointer is of the same value type
+ * @param cores optional parameter for threaded version
+ */
template<class T>
- void Write( const std::string streamName, const std::string groupName, const std::string variableName, const T* values, const unsigned int cores = 1 )
+ void Write( const std::string streamName, const std::string variableName, const T* values )
{
+ auto itCapsule = m_Capsules.find( streamName );
+
+ if( m_DebugMode == true )
+ CheckCapsule( itCapsule, streamName, " from call to Write variable " + variableName );
+
+ const std::string groupName( itCapsule->second.m_GroupName );
auto itGroup = m_Groups.find( groupName );
+
if( m_DebugMode == true )
- {
- CheckGroup( itGroup, groupName, " from call to Write with variable " + variableName );
+ CheckGroup( itGroup, groupName, " from call to Write variable " + variableName );
- if( itGroup->second.m_IsOpen == false )
- throw std::invalid_argument( "ERROR: group " + groupName + " is not open in Write function.\n" );
- }
WriteHelper( itGroup->second, variableName, values, m_Capsules );
}
@@ -148,11 +169,6 @@ public: // PUBLIC Constructors and Functions define the User Interface with ADIO
*/
void MonitorGroups( std::ostream& logStream ) const;
- /**
- * @brief Create a new group or replace an existing one
- * @param groupName unique name
- */
- void CreateGroup( const std::string groupName );
/**
* Creates a new Variable, if debugMode = true, program will throw an exception, else it will overwrite current variable with the same name
@@ -168,7 +184,13 @@ public: // PUBLIC Constructors and Functions define the User Interface with ADIO
const std::string dimensionsCSV = "", const std::string globalDimensionsCSV = "",
const std::string globalOffsetsCSV = "" );
- void SetVariableTransform( const std::string groupName, const std::string variableName, const std::string transform );
+ /**
+ * Sets a transform method to a variable, to be applied when writing
+ * @param groupName corresponding variable group
+ * @param variableName corresponding variable name
+ * @param transform method to be applied for this variable
+ */
+ void SetTransform( const std::string groupName, const std::string variableName, const std::string transform );
/**
@@ -177,19 +199,9 @@ public: // PUBLIC Constructors and Functions define the User Interface with ADIO
* @param attributeName corresponding attribute name
* @param type string or number
* @param value string contents of the attribute (e.g. "Communication value" )
- * @param globalDimensionsCSV comma separated (no space) global dimensions "gNx,gNy,gNz" defined by other variables
- * @param globalOffsetsCSV comma separated (no space) global offsets "oNx,oNy,oNz" defined by other variables
*/
void CreateAttribute( const std::string groupName, const std::string attributeName,
- const std::string type, const std::string value,
- const std::string globalDimensionsCSV = "", const std::string globalOffsetsCSV = "" );
-
- /**
- * Sets a transport method to be associated with a group. Need to think variadic function for other methods
- * @param groupName unique name
- * @param transport transport method
- */
- void SetTransport( const std::string groupName, const std::string transport );
+ const std::string type, const std::string value );
private:
@@ -208,23 +220,34 @@ private:
std::map< std::string, CGroup > m_Groups;
/**
- * @brief List of Capsules defined from either ADIOS XML configuration file or the CreateGroup function.
+ * @brief List of Capsules, each defined from the Open function.
* <pre>
- * Key: std::string unique capsule name given by ADIOS Open
+ * Key: std::string unique stream/file/capsule name given by ADIOS Open
* Value: CCapsule object
* </pre>
*/
- std::map< std::string, CCapsule > m_Capsules; ///< contains all capsules created with ADIOS Open
+ std::map< std::string, CCapsule > m_Capsules;
+
std::vector< std::shared_ptr<CTransform> > m_Transforms; ///< transforms associated with ADIOS run
/**
* @brief Checks for group existence in m_Groups, if failed throws std::invalid_argument exception
- * @param itGroup group iterator, usually from find function
- * @param groupName passed for thrown exception only
+ * @param itGroup m_Group iterator, usually from find function
+ * @param groupName unique name, passed for thrown exception only
+ * @param hint adds information to thrown exception
+ */
+ void CheckGroup( std::map< std::string, CGroup >::const_iterator itGroup,
+ const std::string groupName, const std::string hint ) const;
+
+ /**
+ * @brief Checks for capsule existence in m_Groups, if failed throws std::invalid_argument exception
+ * @param itCapsule m_Capsule iterator, usually from find function
+ * @param streamName unique name, passed for thrown exception only
* @param hint adds information to thrown exception
*/
- void CheckGroup( std::map< std::string, CGroup >::const_iterator itGroup, const std::string groupName, const std::string hint );
+ void CheckCapsule( std::map< std::string, CCapsule >::const_iterator itCapsule,
+ const std::string streamName, const std::string hint ) const;
};
diff --git a/src/public/ADIOS.cpp b/src/public/ADIOS.cpp
index 15550db04..570938957 100644
--- a/src/public/ADIOS.cpp
+++ b/src/public/ADIOS.cpp
@@ -129,5 +129,11 @@ void ADIOS::CheckGroup( std::map< std::string, CGroup >::const_iterator itGroup,
throw std::invalid_argument( "ERROR: group " + groupName + " not found " + hint + "\n" );
}
+void ADIOS::CheckCapsule( std::map< std::string, CCapsule >::const_iterator itCapsule, const std::string streamName, const std::string hint )
+{
+ if( itCapsule == m_Groups.end() )
+ throw std::invalid_argument( "ERROR: stream (or file) " + streamName + " not created with Open , " + hint + "\n" );
+}
+
} //end namespace
--
GitLab