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

#include <Written.hpp>

Inheritance diagram for torc::generic::Written:

Collaboration diagram for torc::generic::Written:

Data Structures
class	Factory

Public Types
typedef Written	Type

typedef boost::shared_ptr< Type >	Pointer

typedef boost::weak_ptr< Type >	WeakPointer

Public Member Functions
const TimeStamp	getTimeStamp () const

void	setTimeStamp (const TimeStamp &inTimeStamp)

const std::string	getAuthorName () const

void	setAuthorName (const std::string &inAuthorName)

const std::string	getProgramName () const

void	setProgramName (const std::string &inProgramName)

const std::string	getProgramVersion () const

void	setProgramVersion (const std::string &inProgramVersion)

const std::string	getDataOriginLocationName () const

void	setDataOriginLocationName (const std::string &value)

const std::string	getDataOriginVersion () const

void	setDataOriginVersion (const std::string &inDataOriginVersion)

	Written ()

	~Written () throw ()

void	addComment (const std::string &comment)

const std::vector< std::string > &	getComments () const

void	setComments (const std::vector< std::string > &inSource)

PropertySharedPtr	getProperty (const std::string &inName)

bool	setProperty (const std::string &inName, const PropertySharedPtr &inProperty)

void	getProperties (std::map< std::string, PropertySharedPtr > &outProperties) const

void	setProperties (const std::map< std::string, PropertySharedPtr > &inSource)

template<typename _Action >
void	applyOnAllProperties (const _Action &action) throw (Error)

void	getUserData (std::list< std::string > &outUserData) const

void	setUserData (const std::list< std::string > &inSource)

void	addUserData (const std::string &inSource)

void	setWeakThis (const WeakPointer &inWeakThis)

Pointer	getSharedThis () const

Private Attributes
TimeStamp	mTimeStamp

std::string	mAuthorName

std::string	mProgramName

std::string	mProgramVersion

std::string	mDataOriginLocationName

std::string	mDataOriginVersion

Friends
class	FactoryType< Written >

Detailed Description

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

Definition at line 33 of file Written.hpp.

Member Typedef Documentation

typedef boost::shared_ptr<Type> torc::generic::SelfReferencing< Written >::Pointer

inherited

Definition at line 36 of file SelfReferencing.hpp.

typedef Written torc::generic::SelfReferencing< Written >::Type

inherited

Definition at line 35 of file SelfReferencing.hpp.

typedef boost::weak_ptr<Type> torc::generic::SelfReferencing< Written >::WeakPointer

inherited

Definition at line 37 of file SelfReferencing.hpp.

Constructor & Destructor Documentation

torc::generic::Written::Written ( )

Definition at line 112 of file Written.cpp.

                  : Commentable(), PropertyContainer(), UserDataContainer(),
     SelfReferencing<Written>(), mTimeStamp(), mAuthorName(), mProgramName(), mProgramVersion(),
     mDataOriginLocationName(), mDataOriginVersion() {}

torc::generic::Written::~Written	(	)
throw	(
	)

Definition at line 116 of file Written.cpp.

116 {}

Member Function Documentation

void torc::generic::Commentable::addComment ( const std::string & comment )

inherited

Add a comment to the object

Parameters

[in] comment The comment to add to an existing list of comments

Definition at line 36 of file Commentable.cpp.

                                                      {
     mComments.push_back(comment);
 }

void torc::generic::UserDataContainer::addUserData ( const std::string & inSource )

inherited

Add an user data to the list of user data

Parameters

[in] inSource An user data as string

Definition at line 34 of file UserDataContainer.cpp.

                                                              {
     mUserData.push_back(inSource);
 }

template<typename _Action >

void torc::generic::PropertyContainer::applyOnAllProperties	(	const _Action &	action	)
throw	(	Error
	)

inlineinherited

Apply action on all properties.

Parameters

[in] action Action to be applied

Definition at line 113 of file PropertyContainer.hpp.

                                          {
     try {
         mProperties.applyOnAll(action);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

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

inline

Get author name

Returns: mAuthorName

Definition at line 180 of file Written.hpp.

                                                     {
     return mAuthorName;
 }

const std::vector< std::string > & torc::generic::Commentable::getComments ( ) const

inlineinherited

Get the list of all comments

Returns: A list of all comments on this object

Definition at line 85 of file Commentable.hpp.

                                                                   {
     return mComments;
 }

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

inline

Get Data origin location name

Returns: mDataOriginLocationName

Definition at line 207 of file Written.hpp.

                                                                 {
     return mDataOriginLocationName;
 }

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

inline

Get Data origin version

Returns: mDataOriginVersion

Get DataOrigin version

Returns: mDataOriginVersion

Definition at line 216 of file Written.hpp.

                                                            {
     return mDataOriginVersion;
 }

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

inline

Get program name

Returns: mProgramName

Definition at line 189 of file Written.hpp.

                                                      {
     return mProgramName;
 }

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

inline

Get program version

Returns: mProgramVersion

Definition at line 198 of file Written.hpp.

                                                         {
     return mProgramVersion;
 }

void torc::generic::PropertyContainer::getProperties ( std::map< std::string, PropertySharedPtr > & outProperties ) const

inlineinherited

Get the map of all properties

Parameters

[out] outProperties The map of properties

Get the map of all properties

Returns: The map of properties

Definition at line 107 of file PropertyContainer.hpp.

                                                                {
     mProperties.getValueMap(outProperties);
     return;
 }

Here is the call graph for this function:

PropertySharedPtr torc::generic::PropertyContainer::getProperty ( const std::string & inName )

inherited

Get a property

Parameters

[in] inName Name of the property to be retreived

Returns: Pointer to the property object if present, empty pointer otherwise.

Get a property

Parameters

[in] name Name of the property to be retreived

Returns: Pointer to the property object if present, empty pointer otherwise.

Definition at line 37 of file PropertyContainer.cpp.

                                                                         {
     PropertySharedPtr property;
     if(!inName.empty()) {
         mProperties.get(inName, property);
     }
     return property;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Pointer torc::generic::SelfReferencing< Written >::getSharedThis ( ) const

inlineinherited

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Returns: A shared pointer to this object

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Parameters

[out] ptr Set to a shared pointer to this object

const TimeStamp torc::generic::Written::getTimeStamp ( ) const

inline

Get the time stamp

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

Definition at line 171 of file Written.hpp.

                                                    {
     return mTimeStamp;
 }

void torc::generic::UserDataContainer::getUserData ( std::list< std::string > & outUserData ) const

inlineinherited

Get the list of all userData

Parameters

[out] outUserData The list of all userData

Definition at line 78 of file UserDataContainer.hpp.

                                                                                 {
     outUserData.insert(outUserData.end(), mUserData.begin(), mUserData.end());
     return;
 }

void torc::generic::Written::setAuthorName ( const std::string & inAuthorName )

Set author name

Parameters

[in] inAuthorName Name of the author

Definition at line 72 of file Written.cpp.

                                                          {
     mAuthorName = inAuthorName;
 }

void torc::generic::Commentable::setComments ( const std::vector< std::string > & inSource )

inherited

Get the list of all comments

Parameters

[in] inSource A list of all comments to be set on this object

Definition at line 45 of file Commentable.cpp.

                                                                   {
     mComments.insert(mComments.end(), inSource.begin(), inSource.end());
 }

void torc::generic::Written::setDataOriginLocationName ( const std::string & value )

Set Data origin location name

Parameters

[in] value Data Origin Location Name

Definition at line 99 of file Written.cpp.

                                                               {
     mDataOriginLocationName = value;
 }

void torc::generic::Written::setDataOriginVersion ( const std::string & inDataOriginVersion )

Set Data origin version

Parameters

[in] inDataOriginVersion Version of the DataOrigin

Set DataOrigin version

Parameters

[in] inDataOriginVersion Version of the DataOrigin

Definition at line 108 of file Written.cpp.

                                                                        {
     mDataOriginVersion = inDataOriginVersion;
 }

void torc::generic::Written::setProgramName ( const std::string & inProgramName )

Set program name

Parameters

[in] inProgramName Name of the program

Definition at line 81 of file Written.cpp.

                                                            {
     mProgramName = inProgramName;
 }

void torc::generic::Written::setProgramVersion ( const std::string & inProgramVersion )

Set program version

Parameters

[in] inProgramVersion Version of the program

Definition at line 90 of file Written.cpp.

                                                                  {
     mProgramVersion = inProgramVersion;
 }

void torc::generic::PropertyContainer::setProperties ( const std::map< std::string, PropertySharedPtr > & inSource )

inherited

Set the map of properties

Parameters

[in] inSource The map of properties

Definition at line 66 of file PropertyContainer.cpp.

                                                                                           {
     std::map<std::string, PropertySharedPtr>::const_iterator it = inSource.begin();
     for(; it != inSource.end(); it++) {
         setProperty((*it).first, (*it).second);
     }
 }

Here is the call graph for this function:

bool torc::generic::PropertyContainer::setProperty	(	const std::string &	inName,
		const PropertySharedPtr &	inProperty
	)

inherited

Save the inSource of a property

Parameters

[in]	inName	Name of the property to be saved
[in]	inProperty	Pointer to the property object if present, empty pointer otherwise.

Returns: bool True if saved, false otherwise.

Save the inSource of a property

Parameters

[in]	inName	Name of the property to be saved
[in]	inPoperty	Pointer to the property object if present, empty pointer otherwise.

Returns: bool True if saved, false otherwise.

Definition at line 53 of file PropertyContainer.cpp.

                                          {
     if(!inName.empty()) {
         return mProperties.set(inName, inProperty);
     }
     return false;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::generic::Written::setTimeStamp ( const TimeStamp & inTimeStamp )

Set time stamp

Parameters

[in] inTimeStamp TimeStamp in Universal Time Coordinate.

Definition at line 63 of file Written.cpp.

                                                        {
     mTimeStamp = inTimeStamp;
 }

void torc::generic::UserDataContainer::setUserData ( const std::list< std::string > & inSource )

inherited

Set the list of userData

Parameters

[in] inSource The list of UserData

Definition at line 26 of file UserDataContainer.cpp.

                                                                       {
     mUserData.insert(mUserData.end(), inSource.begin(), inSource.end());
 }

void torc::generic::SelfReferencing< Written >::setWeakThis ( const WeakPointer & inWeakThis )

inlineinherited

Set a weak pointer to this object. This will be used later to get a shared pointer to this object from within other member methods if required. This should be called by the Factory creating the object.

Parameters

[in] weakThis A weak pointer to this object

Friends And Related Function Documentation

friend class FactoryType< Written >

friend

Definition at line 36 of file Written.hpp.

Field Documentation

std::string torc::generic::Written::mAuthorName

private

Definition at line 159 of file Written.hpp.

std::string torc::generic::Written::mDataOriginLocationName

private

Definition at line 162 of file Written.hpp.

std::string torc::generic::Written::mDataOriginVersion

private

Definition at line 163 of file Written.hpp.

std::string torc::generic::Written::mProgramName

private

Definition at line 160 of file Written.hpp.

std::string torc::generic::Written::mProgramVersion

private

Definition at line 161 of file Written.hpp.

TimeStamp torc::generic::Written::mTimeStamp

private

Definition at line 158 of file Written.hpp.

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

Data Structures

Public Types

Public Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation