torc::generic::LogicValue Class Reference

This class is used within simulationInfo construct to define a logic value to use for modeling in the logicModel view. More...

#include <LogicValue.hpp>

Inheritance diagram for torc::generic::LogicValue:

Collaboration diagram for torc::generic::LogicValue:

Data Structures
class	Factory

Public Types
typedef VisitorType< LogicValue >	Visitor
typedef std::string	Name
typedef LogicValue	Type
typedef boost::shared_ptr< Type >	Pointer
typedef boost::weak_ptr< Type >	WeakPointer

Public Member Functions
virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)
const LogicValueAttributesSharedPtr	getAttributes () const
void	setAttributes (const LogicValueAttributesSharedPtr &inSource)
virtual	~LogicValue () throw ()
virtual const std::string	getName () const
void	setName (const std::string &inSource) throw (Error)
virtual Name	getOriginalName () const
virtual void	setOriginalName (const Name &inSource)
void	addComment (const std::string &comment)
const std::vector< std::string > &	getComments () const
void	setComments (const std::vector< std::string > &inSource)
const boost::shared_ptr < SimulationInfo >	getParent () const
virtual void	setParent (const boost::shared_ptr< SimulationInfo > &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

Protected Member Functions
	LogicValue ()

Private Attributes
LogicValueAttributesSharedPtr	mAttributes

Friends
class	FactoryType< LogicValue >

Detailed Description

This class is used within simulationInfo construct to define a logic value to use for modeling in the logicModel view.

Definition at line 42 of file LogicValue.hpp.

Member Typedef Documentation

typedef std::string torc::generic::Renamable::Name

inherited

Definition at line 40 of file generic/Renamable.hpp.

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

inherited

Definition at line 36 of file SelfReferencing.hpp.

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

inherited

Definition at line 35 of file SelfReferencing.hpp.

typedef VisitorType<LogicValue> torc::generic::LogicValue::Visitor

Convenience class to visit a LogicValue.

Definition at line 53 of file LogicValue.hpp.

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

inherited

Definition at line 37 of file SelfReferencing.hpp.

Constructor & Destructor Documentation

torc::generic::LogicValue::~LogicValue ( ) throw ( )

virtual

Definition at line 76 of file LogicValue.cpp.

{}

torc::generic::LogicValue::LogicValue ( )

protected

Definition at line 72 of file LogicValue.cpp.

                       : Nameable(), Renamable(), Commentable(), Visitable(),
    ParentedObject<SimulationInfo>(), PropertyContainer(), UserDataContainer(),
    SelfReferencing<LogicValue>(), mAttributes() {}

Member Function Documentation

void torc::generic::LogicValue::accept ( BaseVisitor &  inoutVisitor ) throw ( Error )

virtual

Receive a visitor to this class. The visit method of the visitor is called and a reference to this object is passed as a parameter. It has to be noted however, that a dynamic_cast is performed inside this method. If the cast fails, an appropriate exception is thrown by this method. This situation can arise when the passed Visitor object does not inherit from the appropriate visitor specialization. See Visitor documentation for more details.

Parameters

[in,out]

inoutVisitor

A reference to the visitor object

Exceptions

Error

Visitor type inappropriate for visiting this object or any other error thrown by the Visitor::throw() method.

Implements torc::generic::Visitable.

Reimplemented in torc::generic::LogicElement.

Definition at line 63 of file LogicValue.cpp.

                                                               {
    try {
        runVisitor(*this, inoutVisitor);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

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 LogicValueAttributesSharedPtr torc::generic::LogicValue::getAttributes ( ) const

inline

Get the attributes of the LogicValue. Attributes include voltageMap, currentMap, booleanMap, compound, weak, strong, dominates etc.

Returns

Pointer to LogicValueAttributes object.

Definition at line 125 of file LogicValue.hpp.

                                                                           {
    return mAttributes;
}

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::Nameable::getName ( void  ) const

inlinevirtualinherited

Get the object name

Returns

Name of the object

Definition at line 89 of file Nameable.hpp.

                                               {
    return mName;
}

Here is the caller graph for this function:

Renamable::Name torc::generic::Renamable::getOriginalName ( ) const

inlinevirtualinherited

Get the new name provided for the object.

Returns

Name of the object

Definition at line 78 of file generic/Renamable.hpp.

                                                      {
    return mOriginalName;
}

Here is the caller graph for this function:

const boost::shared_ptr<SimulationInfo > torc::generic::ParentedObject< SimulationInfo >::getParent ( ) const

inlineinherited

Get a pointer to the parent object

Returns

Pointer to parent

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< LogicValue >::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

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::LogicValue::setAttributes

(

const LogicValueAttributesSharedPtr &

inSource

)

Set the attributes of the LogicValue. Attributes include voltageMap, currentMap, booleanMap, compound, weak, strong, dominates etc.

Parameters

[in]

inSource

Pointer to LogicValueAttributes object.

Definition at line 59 of file LogicValue.cpp.

                                                                            {
    mAttributes = inSource;
}

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::Nameable::setName ( const std::string &  inSource ) throw ( Error )

inherited

Set a name for this object

Parameters

[in]

inSource

Name of the object

Exceptions

Error

Could not set name, because name is empty (Will be used by array members) Id : eMessageIdErrorEmptyItemName Context Data Nameable - String

Set a name for this object

Parameters

[in]

inSource

Name of the object

Exceptions

Error

Could not set name, because name is empty (Will be used by array members)

Definition at line 41 of file Nameable.cpp.

                                                              {
    if(inSource.empty()) {
        Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Nameable", inSource);
        throw e;
    }
    mName = inSource;
}

Here is the call graph for this function:

void torc::generic::Renamable::setOriginalName ( const Name &  inSource )

virtualinherited

Set the new name provided for the object.

Parameters

[in]

inSource

Name of the object

Definition at line 35 of file generic/Renamable.cpp.

                                                             {
    mOriginalName = inSource;
}

virtual void torc::generic::ParentedObject< SimulationInfo >::setParent ( const boost::shared_ptr< SimulationInfo > &  inSource )

virtualinherited

Set a pointer to the parent

Parameters

[in]

inSource

Set a pointer to the parent

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::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< LogicValue >::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< LogicValue >

friend

Definition at line 46 of file LogicValue.hpp.

Field Documentation

LogicValueAttributesSharedPtr torc::generic::LogicValue::mAttributes

private

Definition at line 115 of file LogicValue.hpp.

---

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

• LogicValue.hpp
• LogicValue.cpp