torc::generic::Apply Class Reference

This class is used within simulate to describe input stimuli and expected responces over a certain time interval. More...

#include <Apply.hpp>

Inheritance diagram for torc::generic::Apply:

Inheritance graph
[legend]
Collaboration diagram for torc::generic::Apply:

Collaboration graph
[legend]

List of all members.

Public Types

typedef VisitorType< ApplyVisitor

Public Member Functions

virtual void accept (BaseVisitor &inoutVisitor) throw (Error)
const int32_t getNoOfCycle () const throw ()
void setNoOfCycle (const int32_t &inValue) throw ()
const Value getCycleDuration () const throw ()
void setCycleDuration (const Value &value) throw ()
void getLogicResponses (std::list< LogicalResponseSharedPtr > &outLogicResponces) const throw ()
void setLogicResponses (const std::list< LogicalResponseSharedPtr > &inLogicResponces) throw ()
void addLogicResponse (const LogicalResponseSharedPtr &inLogicResponce) throw ()

Private Member Functions

 Apply (const Apply &source) throw ()
Applyoperator= (const Apply &source) throw ()

Private Attributes

int32_t mNoOfCycle
Value mCycleDuration
std::list
< LogicalResponseSharedPtr > 
mLogicResponses

Friends

class FactoryType< Apply >

Classes

class  Factory


Detailed Description

This class is used within simulate to describe input stimuli and expected responces over a certain time interval.

Definition at line 38 of file Apply.hpp.


Member Typedef Documentation

Convenience class to visit apply .

Definition at line 51 of file Apply.hpp.


Member Function Documentation

void torc::generic::Apply::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 62 of file Apply.cpp.

const int32_t torc::generic::Apply::getNoOfCycle (  )  const throw () [inline]

Get the no of cycles

Returns:
int32_t No of cycles

Definition at line 156 of file Apply.hpp.

void torc::generic::Apply::setNoOfCycle ( const int32_t &  inValue  )  throw ()

Set the no of cycles

Parameters:
[in] inValue int32_t No of cycles

Definition at line 80 of file Apply.cpp.

const Value torc::generic::Apply::getCycleDuration (  )  const throw () [inline]

Get the duration of each cycle

Returns:
Duration of each cycle

Definition at line 165 of file Apply.hpp.

void torc::generic::Apply::setCycleDuration ( const Value value  )  throw ()

Set the duration of each cycle

Parameters:
[in] value Duration of each cycle

Definition at line 89 of file Apply.cpp.

void torc::generic::Apply::getLogicResponses ( std::list< LogicalResponseSharedPtr > &  outLogicResponces  )  const throw () [inline]

Get the list of LogicResponce.

Parameters:
[out] outLogicResponces List of LogicResponce (s) to be appended to

Definition at line 175 of file Apply.hpp.

void torc::generic::Apply::setLogicResponses ( const std::list< LogicalResponseSharedPtr > &  inLogicResponces  )  throw ()

Set the list of LogicResponce.

Parameters:
[in] inLogicResponces List of LogicResponce (s) to be appended to

Definition at line 99 of file Apply.cpp.

void torc::generic::Apply::addLogicResponse ( const LogicalResponseSharedPtr &  inLogicResponce  )  throw ()

Add a LogicResponce to the list of LogicResponce.

Parameters:
[in] inLogicResponce Pointer to LogicResponce to be appended to
Add a LogicResponce to the list of LogicResponces.

Parameters:
[in] inLogicResponce Pointer to LogicResponce to be appended to

Definition at line 125 of file Apply.cpp.


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

Generated on Thu Oct 13 16:49:59 2011 for TORC by  doxygen 1.5.6