Skip to content
Snippets Groups Projects
Commit 0c7cf446 authored by Nina Džugasová's avatar Nina Džugasová Committed by Tomáš Oberhuber
Browse files

Added Object documentation.

parent c6a549f1
No related branches found
No related tags found
1 merge request!15Nina
......@@ -34,16 +34,18 @@ class Object
public:
/****
* Type getter. This returns the type in C++ style - for example the returned value
* \brief Type getter.
*
* Returns the type in C++ style - for example the returned value
* may look as follows: "Vector< double, Devices::Cuda >".
*/
static String getType();
virtual String getTypeVirtual() const;
/****
* This is used for load and save methods.
* \brief This is used for load and save methods.
*
* Each object is saved as if it was stored on Devices::Host. So even Vector< double, Devices::Cuda >
* is saved as Vector< double, Devices::Host >.
*/
......@@ -51,13 +53,25 @@ class Object
virtual String getSerializationTypeVirtual() const;
//! Method for saving the object to a file as a binary data
/***
* \brief Method for saving the object to a file as a binary data.
*
* \param file Name of file object.
*/
virtual bool save( File& file ) const;
//! Method for restoring the object from a file
/***
* \brief Method for restoring the object from a file.
*
* \param file Name of file object.
*/
virtual bool load( File& file );
//! Method for restoring the object from a file
/***
* \brief Method for restoring the object from a file.
*
* \param file Name of file object.
*/
virtual bool boundLoad( File& file );
bool save( const String& fileName ) const;
......@@ -66,7 +80,7 @@ class Object
bool boundLoad( const String& fileName );
//! Destructor
/// Destructor.
// FIXME: __cuda_callable__ would have to be added to every overriding destructor,
// even if the object's constructor is not __cuda_callable__
// __cuda_callable__
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment