H5MXARequiredMetaData Class Reference

Concrete implmentation of the IRequiredMetaData virtual class. More...

Inherits IRequiredMetaData.

Inheritance diagram for H5MXARequiredMetaData:

Inheritance graph
[legend]
Collaboration diagram for H5MXARequiredMetaData:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~H5MXARequiredMetaData ()
void setAll (std::string researcherName, std::string dateCreated, std::string datasetName, std::string description, std::string distributionRights, std::string releaseNumber, std::string pedigree, std::string derivedSrcFile)
 Sets all the required meta data.
void setResearcherName (const std::string &researcherName)
 Sets the Researcher's name or who is generating the data set.
std::string getResearcherName ()
 Returns the Researcher name value.
void setDateTimeCreated (const std::string &dateTime)
 Sets the date and time the data set was created. The preferable format for the date time is "yyyy/MM/dd HH:mm:ss".
std::string getDateTimeCreated ()
 Returns the date/time the dataset was created.
void setDatasetName (const std::string &datasetName)
 Provides a descriptive name for the dataset.
std::string getDatasetName ()
 Returns the name given to the data set.
void setDescription (const std::string &description)
 Provides a description for the data in the data file.
std::string getDescription ()
 Returns the description of the dataset.
void setDistributionRights (const std::string &distributionRights)
 Sets the Distribution rights for the data and should be either "Unlimited" or "Limited".
std::string getDistributionRights ()
 Returns the distribution rights of the dataset.
void setReleaseNumber (const std::string &releaseNumber)
 Sets the release number or other tracking number/code that is used to track the dataset.
std::string getReleaseNumber ()
 Returns the Release number or tracking number for the dataset.
void setPedigree (const std::string &pedigree)
 Sets the Pedigree of the data which is either one of "Derived" or "Original".
std::string getPedigree ()
 Returns the pedigree of the dataset and is either "Derived" or "Original".
void setDerivedSourceFile (const std::string &derivedSourceFile)
 Sets the Derived Source file meta data. Use "Not Applicable" if that is appropriate to your data set.
std::string getDerivedSourceFile ()
 Returns the value of the Derived source file meta data. Returns "Not Applicable" if no derived source file was used.
int32 setValueForKey (const std::string &key, const std::string &value)
 Sets the value for a given meta data key.
std::string getValueForKey (const std::string &key)
 Returns the value for a given key.
int32 writeToFile (IDataFile::Pointer dataFile)
int32 readFromFile (IDataFile::Pointer dataFile)
bool isValid (std::string message)
 Validates the Required Meta Data.
void printSelf (std::ostream &os, int32 indent)
 prints a debugging type diagnostic description of the contents of this class
void generateKeyValueMap (std::map< std::string, std::string > &mdMap)
 Generates a std::map of the meta data key to its associated value.

Static Public Member Functions

static IRequiredMetaData::Pointer New (std::string researcherName, std::string dateCreated, std::string datasetName, std::string description, std::string distributionRights, std::string releaseNumber, std::string pedigree, std::string derivedSrcFile)
 Static method to create a new IRequiredMetaData object that is wrapped in a Boost Shared Pointer.
static IRequiredMetaData::Pointer DefaultMetaData ()
 Creates a new IRequiredMetaData::Pointer object that has all empty values. Note that this will make it INVALID. You are required to fill in the appropriate values to make it valid. This is provided as a convenience.

Protected Member Functions

 H5MXARequiredMetaData (std::string researcherName, std::string dateCreated, std::string datasetName, std::string description, std::string distributionRights, std::string releaseNumber, std::string pedigree, std::string derivedSrcFile)

Private Member Functions

 H5MXARequiredMetaData (const H5MXARequiredMetaData &)
void operator= (const H5MXARequiredMetaData &)

Private Attributes

std::string _researcherName
std::string _dateCreated
std::string _datasetName
std::string _description
std::string _distributionRights
std::string _releaseNumber
std::string _pedigree
std::string _derivedSrcFile

Detailed Description

Concrete implmentation of the IRequiredMetaData virtual class.

Author:
Mike Jackson for BlueQuartz Software.us
Date:
Jan 15, 2008
Version:
Revision
1.2


Constructor & Destructor Documentation

H5MXARequiredMetaData::~H5MXARequiredMetaData (  )  [virtual]

H5MXARequiredMetaData::H5MXARequiredMetaData ( std::string  researcherName,
std::string  dateCreated,
std::string  datasetName,
std::string  description,
std::string  distributionRights,
std::string  releaseNumber,
std::string  pedigree,
std::string  derivedSrcFile 
) [protected]

H5MXARequiredMetaData::H5MXARequiredMetaData ( const H5MXARequiredMetaData  )  [private]


Member Function Documentation

IRequiredMetaData::Pointer H5MXARequiredMetaData::New ( std::string  researcherName,
std::string  dateCreated,
std::string  datasetName,
std::string  description,
std::string  distributionRights,
std::string  releaseNumber,
std::string  pedigree,
std::string  derivedSrcFile 
) [static]

Static method to create a new IRequiredMetaData object that is wrapped in a Boost Shared Pointer.

Parameters:
researcherName The name of the researcher
dateCreated The date the data was created
datasetName The name of the dataset or experiment
description A short description of the experiment
distributionRights How is the data to be distributed.
releaseNumber If the data is publicly releasable was there a tracking number for the release
pedigree More detailed information about the data/experiment
derivedSrcFile Did the data come from a data file
The distributionRights should be one of the following: const std::string MXA_RIGHTS_UNLIMITED_VALUE("Unlimited"); const std::string MXA_RIGHTS_LIMITED_VALUE("Limited"); const std::string MXA_RELEASE_LIMITATION_TAG("Release_Limitation");

IRequiredMetaData::Pointer H5MXARequiredMetaData::DefaultMetaData (  )  [static]

Creates a new IRequiredMetaData::Pointer object that has all empty values. Note that this will make it INVALID. You are required to fill in the appropriate values to make it valid. This is provided as a convenience.

void H5MXARequiredMetaData::setAll ( std::string  researcherName,
std::string  dateCreated,
std::string  datasetName,
std::string  description,
std::string  distributionRights,
std::string  releaseNumber,
std::string  pedigree,
std::string  derivedSrcFile 
) [virtual]

Sets all the required meta data.

Parameters:
researcherName The name of the researcher
dateCreated The date the data was created
datasetName The name of the dataset or experiment
description A short description of the experiment
distributionRights How is the data to be distributed.
releaseNumber If the data is publicly releasable was there a tracking number for the release
pedigree More detailed information about the data/experiment
derivedSrcFile Did the data come from a data file
The distributionRights should be one of the following: const std::string MXA_RIGHTS_UNLIMITED_VALUE("Unlimited"); const std::string MXA_RIGHTS_LIMITED_VALUE("Limited"); const std::string MXA_RELEASE_LIMITATION_TAG("Release_Limitation");

Implements IRequiredMetaData.

void H5MXARequiredMetaData::setResearcherName ( const std::string &  researcherName  )  [virtual]

Sets the Researcher's name or who is generating the data set.

Parameters:
researcherName 

Implements IRequiredMetaData.

std::string H5MXARequiredMetaData::getResearcherName (  )  [virtual]

Returns the Researcher name value.

Returns:

Implements IRequiredMetaData.

void H5MXARequiredMetaData::setDateTimeCreated ( const std::string &  dateTime  )  [virtual]

Sets the date and time the data set was created. The preferable format for the date time is "yyyy/MM/dd HH:mm:ss".

Parameters:
dateTime 

Implements IRequiredMetaData.

std::string H5MXARequiredMetaData::getDateTimeCreated (  )  [virtual]

Returns the date/time the dataset was created.

Returns:

Implements IRequiredMetaData.

void H5MXARequiredMetaData::setDatasetName ( const std::string &  datasetName  )  [virtual]

Provides a descriptive name for the dataset.

Parameters:
datasetName The name of the dataset

Implements IRequiredMetaData.

std::string H5MXARequiredMetaData::getDatasetName (  )  [virtual]

Returns the name given to the data set.

Returns:

Implements IRequiredMetaData.

void H5MXARequiredMetaData::setDescription ( const std::string &  description  )  [virtual]

Provides a description for the data in the data file.

Parameters:
description The description of the data

Implements IRequiredMetaData.

std::string H5MXARequiredMetaData::getDescription (  )  [virtual]

Returns the description of the dataset.

Returns:

Implements IRequiredMetaData.

void H5MXARequiredMetaData::setDistributionRights ( const std::string &  distributionRights  )  [virtual]

Sets the Distribution rights for the data and should be either "Unlimited" or "Limited".

Parameters:
distributionRights The distribution Rights for the dataset.

Implements IRequiredMetaData.

std::string H5MXARequiredMetaData::getDistributionRights (  )  [virtual]

Returns the distribution rights of the dataset.

Returns:

Implements IRequiredMetaData.

void H5MXARequiredMetaData::setReleaseNumber ( const std::string &  releaseNumber  )  [virtual]

Sets the release number or other tracking number/code that is used to track the dataset.

Parameters:
releaseNumber The release number/code or "Not Applicable"

Implements IRequiredMetaData.

std::string H5MXARequiredMetaData::getReleaseNumber (  )  [virtual]

Returns the Release number or tracking number for the dataset.

Returns:

Implements IRequiredMetaData.

void H5MXARequiredMetaData::setPedigree ( const std::string &  pedigree  )  [virtual]

Sets the Pedigree of the data which is either one of "Derived" or "Original".

Parameters:
pedigree The pedigree of the data

Implements IRequiredMetaData.

std::string H5MXARequiredMetaData::getPedigree (  )  [virtual]

Returns the pedigree of the dataset and is either "Derived" or "Original".

Returns:

Implements IRequiredMetaData.

void H5MXARequiredMetaData::setDerivedSourceFile ( const std::string &  derivedSourceFile  )  [virtual]

Sets the Derived Source file meta data. Use "Not Applicable" if that is appropriate to your data set.

Parameters:
derivedSourceFile Value of the Derived Source File

Implements IRequiredMetaData.

std::string H5MXARequiredMetaData::getDerivedSourceFile (  )  [virtual]

Returns the value of the Derived source file meta data. Returns "Not Applicable" if no derived source file was used.

Returns:

Implements IRequiredMetaData.

int32 H5MXARequiredMetaData::setValueForKey ( const std::string &  key,
const std::string &  value 
) [virtual]

Sets the value for a given meta data key.

Parameters:
key The meta data key to set
value The value of meta data to set
Returns:
Zero or positive on success.

Implements IRequiredMetaData.

std::string H5MXARequiredMetaData::getValueForKey ( const std::string &  key  )  [virtual]

Returns the value for a given key.

Parameters:
key The key to retrieve the value for
Returns:
The meta data value associated with the key. An empty string is a valid return value.

Implements IRequiredMetaData.

int32 H5MXARequiredMetaData::writeToFile ( IDataFile::Pointer  dataFile  ) 

int32 H5MXARequiredMetaData::readFromFile ( IDataFile::Pointer  dataFile  ) 

bool H5MXARequiredMetaData::isValid ( std::string  message  )  [virtual]

Validates the Required Meta Data.

Parameters:
message A std::string to store error messages
Returns:
If this is a valid set of Required Meta Data

Implements IRequiredMetaData.

void H5MXARequiredMetaData::printSelf ( std::ostream &  os,
int32  indent 
) [virtual]

prints a debugging type diagnostic description of the contents of this class

Parameters:
os An output stream to write to.
indent The number of spaces to use for indentation

Implements IRequiredMetaData.

void H5MXARequiredMetaData::generateKeyValueMap ( std::map< std::string, std::string > &  mdMap  )  [virtual]

Generates a std::map of the meta data key to its associated value.

Parameters:
mdMap The map to store the values into.

Implements IRequiredMetaData.

void H5MXARequiredMetaData::operator= ( const H5MXARequiredMetaData  )  [private]


Member Data Documentation

std::string H5MXARequiredMetaData::_researcherName [private]

std::string H5MXARequiredMetaData::_dateCreated [private]

std::string H5MXARequiredMetaData::_datasetName [private]

std::string H5MXARequiredMetaData::_description [private]

std::string H5MXARequiredMetaData::_distributionRights [private]

std::string H5MXARequiredMetaData::_releaseNumber [private]

std::string H5MXARequiredMetaData::_pedigree [private]

std::string H5MXARequiredMetaData::_derivedSrcFile [private]


The documentation for this class was generated from the following files:
Generated on Tue Nov 17 18:43:12 2009 for MXADataModel by  doxygen 1.5.2