torc-master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
torc::generic::LogicValue::Factory Class Reference

#include <LogicValue.hpp>

+ Inheritance diagram for torc::generic::LogicValue::Factory:
+ Collaboration diagram for torc::generic::LogicValue::Factory:

Public Types

typedef _Tp Type
 
typedef SelfReferencing< Type >
::Pointer 
Pointer
 
typedef SelfReferencing< Type >
::WeakPointer 
WeakPointer
 

Public Member Functions

virtual LogicValueSharedPtr newLogicValuePtr (const std::string &inName, const LogicValueAttributesSharedPtr &inAttributes, const std::string &inOriginalName=std::string(), const SimulationInfoSharedPtr &inSimulationInfo=SimulationInfoSharedPtr()) throw (Error)
 
virtual void create (Pointer &outPointer) throw (Error)
 

Detailed Description

Convenience class to create a LogicValue.

Definition at line 58 of file LogicValue.hpp.

Member Typedef Documentation

template<typename _Tp>
typedef SelfReferencing<Type>::Pointer torc::generic::FactoryType< _Tp >::Pointer
inherited

A pointer to an object of type Type

Definition at line 45 of file FactoryType.hpp.

template<typename _Tp>
typedef _Tp torc::generic::FactoryType< _Tp >::Type
inherited

A rename of the parameter type

Definition at line 40 of file FactoryType.hpp.

template<typename _Tp>
typedef SelfReferencing<Type>::WeakPointer torc::generic::FactoryType< _Tp >::WeakPointer
inherited

A weak pointer to an object of type Type

Definition at line 50 of file FactoryType.hpp.

Member Function Documentation

template<typename _Tp>
virtual void torc::generic::FactoryType< _Tp >::create ( Pointer outPointer)
throw (Error
)
inlinevirtualinherited

Create an object of the Type specification of Factory. If the object has a boost::weak_ptr to itself, it is the task of this method to set this after the object is created.

Returns
A pointer to the freshly created object.

Definition at line 58 of file FactoryType.hpp.

58  {
59  try {
60  Pointer temp(new _Tp()); //Do not remove
61  outPointer = temp;
62  WeakPointer weakPtr(outPointer);
63  outPointer->setWeakThis(weakPtr);
64  } catch(std::exception& e) //May receive std::bad_alloc
65  {
66  //TBD::ERROR
67  }
68  }
SelfReferencing< Type >::WeakPointer WeakPointer
Definition: FactoryType.hpp:50
SelfReferencing< Type >::Pointer Pointer
Definition: FactoryType.hpp:45
LogicValueSharedPtr torc::generic::LogicValue::Factory::newLogicValuePtr ( const std::string &  inName,
const LogicValueAttributesSharedPtr inAttributes,
const std::string &  inOriginalName = std::string(),
const SimulationInfoSharedPtr inSimulationInfo = SimulationInfoSharedPtr() 
)
throw (Error
)
virtual

Create a LogicValue.

Parameters
[in]inNameName of the LogicValue to be created.
[in]inAttributesPointer to LogicValueAttributes object.
[in]inOriginalNameOriginal name of the LogicValue [optional].
[in]inSimulationInfoPointer to parented(SimulationInfo) object. If not mentioned LogicValue will not be added to SimulationInfo.
Returns
Pointer to created LogicValue.

Definition at line 34 of file LogicValue.cpp.

36  {
37  try {
38  LogicValueSharedPtr newLogicValue;
39  create(newLogicValue);
40  newLogicValue->setName(inName);
41  newLogicValue->setAttributes(inAttributes);
42  newLogicValue->setOriginalName(inOriginalName);
43  if(inSimulationInfo) {
44  inSimulationInfo->addLogicValue(newLogicValue);
45  }
46  return newLogicValue;
47  } catch(Error& e) {
48  e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
49  throw;
50  }
51 }
boost::shared_ptr< LogicValue > LogicValueSharedPtr
virtual void create(Pointer &outPointer)
Definition: FactoryType.hpp:58

+ Here is the call graph for this function:


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