torc::generic::Written Class Reference

Represents an information container relating to the writer of the EDIF file. More...

#include <Written.hpp>

Inheritance diagram for torc::generic::Written:

[legend]

Collaboration diagram for torc::generic::Written:

[legend]

List of all members.

Public Member Functions
const TimeStamp	getTimeStamp () const throw ()
void	setTimeStamp (const TimeStamp &inTimeStamp) throw ()
const std::string	getAuthorName () const throw ()
void	setAuthorName (const std::string &inAuthorName) throw ()
const std::string	getProgramName () const throw ()
void	setProgramName (const std::string &inProgramName) throw ()
const std::string	getProgramVersion () const throw ()
void	setProgramVersion (const std::string &inProgramVersion) throw ()
const std::string	getDataOriginLocationName () const throw ()
void	setDataOriginLocationName (const std::string &value) throw ()
const std::string	getDataOriginVersion () const throw ()
void	setDataOriginVersion (const std::string &inDataOriginVersion) throw ()
Private Attributes
TimeStamp	mTimeStamp
std::string	mAuthorName
std::string	mProgramName
std::string	mProgramVersion
std::string	mDataOriginLocationName
std::string	mDataOriginVersion
Friends
class	FactoryType< Written >
Classes
class	Factory

---

Detailed Description

Represents an information container relating to the writer of the EDIF file.

Definition at line 34 of file Written.hpp.

---

Member Function Documentation

const TimeStamp torc::generic::Written::getTimeStamp

(

)

const throw () [inline]

Get the time stamp

Returns:

mTimeStamp The time in Universal Time Coordinate (year, month, day, hour, minute, second))

Definition at line 189 of file Written.hpp.

void torc::generic::Written::setTimeStamp

(

const TimeStamp &

inTimeStamp

)

throw ()

Set time stamp

Parameters:

[in]

inTimeStamp

TimeStamp in Universal Time Coordinate.

Definition at line 74 of file Written.cpp.

const std::string torc::generic::Written::getAuthorName

(

)

const throw () [inline]

Get author name

Returns:

mAuthorName

Definition at line 199 of file Written.hpp.

void torc::generic::Written::setAuthorName

(

const std::string &

inAuthorName

)

throw ()

Set author name

Parameters:

[in]

inAuthorName

Name of the author

Definition at line 84 of file Written.cpp.

const std::string torc::generic::Written::getProgramName

(

)

const throw () [inline]

Get program name

Returns:

mProgramName

Definition at line 209 of file Written.hpp.

void torc::generic::Written::setProgramName

(

const std::string &

inProgramName

)

throw ()

Set program name

Parameters:

[in]

inProgramName

Name of the program

Definition at line 94 of file Written.cpp.

const std::string torc::generic::Written::getProgramVersion

(

)

const throw () [inline]

Get program version

Returns:

mProgramVersion

Definition at line 219 of file Written.hpp.

void torc::generic::Written::setProgramVersion

(

const std::string &

inProgramVersion

)

throw ()

Set program version

Parameters:

[in]

inProgramVersion

Version of the program

Definition at line 104 of file Written.cpp.

const std::string torc::generic::Written::getDataOriginLocationName

(

)

const throw () [inline]

Get Data origin location name

Returns:

mDataOriginLocationName

Definition at line 229 of file Written.hpp.

void torc::generic::Written::setDataOriginLocationName

(

const std::string &

value

)

throw ()

Set Data origin location name

Parameters:

[in]

value

Data Origin Location Name

Definition at line 114 of file Written.cpp.

const std::string torc::generic::Written::getDataOriginVersion

(

)

const throw () [inline]

Get Data origin version

Returns:

mDataOriginVersion

Get DataOrigin version

Returns:

mDataOriginVersion

Definition at line 239 of file Written.hpp.

void torc::generic::Written::setDataOriginVersion

(

const std::string &

inDataOriginVersion

)

throw ()

Set Data origin version

Parameters:

[in]

inDataOriginVersion

Version of the DataOrigin

Set DataOrigin version

Parameters:

[in]

inDataOriginVersion

Version of the DataOrigin

Definition at line 124 of file Written.cpp.

---

The documentation for this class was generated from the following files:

• torc/generic/om/Written.hpp
• torc/generic/om/Written.cpp