torc::generic::SimulationInfo Class Reference

This class is used to hold all information about the logic values used within a library. More...

#include <SimulationInfo.hpp>

Inheritance diagram for torc::generic::SimulationInfo:

Collaboration diagram for torc::generic::SimulationInfo:

List of all members.

Public Types

typedef VisitorType
< SimulationInfo > Visitor

Public Member Functions

virtual void accept (BaseVisitor &inoutVisitor) throw (Error)

void addLogicValue (const LogicValueSharedPtr &inLogicValue) throw (Error)

LogicValueSharedPtr findLogicValue (const std::string &inName) throw ()

void removeLogicValue (const std::string &inName) throw (Error)

void getLogicValues (std::vector< LogicValueSharedPtr > &outLogicValues) const throw ()

void setLogicValues (const std::vector< LogicValueSharedPtr > &inLogicValues) throw (Error)

template<typename _Action>

void applyOnAllLogicValues (const _Action &action) throw (Error)

Private Member Functions

SimulationInfo (const SimulationInfo &source) throw ()

SimulationInfo & operator= (const SimulationInfo &source) throw ()

Private Attributes

SymTab< std::string,
LogicValueSharedPtr > mLogicValueSymTab

Friends

class FactoryType< SimulationInfo >

Classes

class Factory

Detailed Description

This class is used to hold all information about the logic values used within a library.

Definition at line 45 of file SimulationInfo.hpp.

Member Typedef Documentation

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

Convenience typedef for visiting a simulation info

Definition at line 58 of file SimulationInfo.hpp.

Member Function Documentation

void torc::generic::SimulationInfo::accept ( BaseVisitor & inoutVisitor ) throw (Error) [virtual]

Recive a inoutVisitor to this class. The visit method of the inoutVisitor 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 sitation can arise when the passed Visitor object does not inherit from the appropriate inoutVisitor specialization. See Visitor documentation for more details.

Parameters:

[in,out] inoutVisitor A reference to the inoutVisitor object

Exceptions:

Error

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

Implements torc::generic::Visitable.

Definition at line 53 of file SimulationInfo.cpp.

void torc::generic::SimulationInfo::addLogicValue ( const LogicValueSharedPtr & inLogicValue ) throw (Error)

Add a logic value to the list of logic values. If an empty pointer is supplied, it returns without doing anything.

Parameters:

[in] inLogicValue A pointer to a logic value object.

Exceptions:

Error

Logic value could not be added.

Definition at line 99 of file SimulationInfo.cpp.

LogicValueSharedPtr torc::generic::SimulationInfo::findLogicValue ( const std::string & inName ) throw ()

Find a logic value by name, in the list of logic values in simulationInfo.

Parameters:

[in] inName String value specifying the name of the logic value.

Returns:: A pointer to the logic value if found, an empty pointer otherwise.

Find a logic value by name, in the list of logic values in simulationInfo.

Parameters:

[in] name String value specifying the name of the logic value.

Returns:: A pointer to the logic value if found, an empty pointer otherwise.

Definition at line 131 of file SimulationInfo.cpp.

void torc::generic::SimulationInfo::removeLogicValue ( const std::string & inName ) throw (Error)

Remove the specified logic value from the list of logic values. If an empty pointer is passed, it returns without doing anything

Parameters:

[in] inName name of the object to be removed

Exceptions:

Error

Logic Value not preset in collection.

Definition at line 153 of file SimulationInfo.cpp.

void torc::generic::SimulationInfo::getLogicValues ( std::vector< LogicValueSharedPtr > & outLogicValues ) const throw () [inline]

Get the list of logic values.

Parameters:

[out] outLogicValues Vector of logic values to be appended to

Definition at line 165 of file SimulationInfo.hpp.

void torc::generic::SimulationInfo::setLogicValues ( const std::vector< LogicValueSharedPtr > & inLogicValues ) throw (Error)

Set the list of logic values.

Parameters:

[in] inLogicValues Vector of logic values to be appended to

Definition at line 72 of file SimulationInfo.cpp.

template<typename _Action>

void torc::generic::SimulationInfo::applyOnAllLogicValues ( const _Action & action ) throw (Error) [inline]

Apply action on all logic values.

Parameters:

[in] action Action to be applied

Definition at line 177 of file SimulationInfo.hpp.

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

torc/generic/om/SimulationInfo.hpp
torc/generic/om/SimulationInfo.cpp


Public Types
typedef VisitorType < SimulationInfo >	Visitor
Public Member Functions
virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)
void	addLogicValue (const LogicValueSharedPtr &inLogicValue) throw (Error)
LogicValueSharedPtr	findLogicValue (const std::string &inName) throw ()
void	removeLogicValue (const std::string &inName) throw (Error)
void	getLogicValues (std::vector< LogicValueSharedPtr > &outLogicValues) const throw ()
void	setLogicValues (const std::vector< LogicValueSharedPtr > &inLogicValues) throw (Error)
template<typename _Action>
void	applyOnAllLogicValues (const _Action &action) throw (Error)
Private Member Functions
	SimulationInfo (const SimulationInfo &source) throw ()
SimulationInfo &	operator= (const SimulationInfo &source) throw ()
Private Attributes
SymTab< std::string, LogicValueSharedPtr >	mLogicValueSymTab
Friends
class	FactoryType< SimulationInfo >
Classes
class	Factory