torc::generic::Status Class Reference

Represents EDIF status construct. More...

#include <Status.hpp>

Inheritance diagram for torc::generic::Status:

[legend]

Collaboration diagram for torc::generic::Status:

[legend]

List of all members.

Public Types
typedef VisitorType< Status >	Visitor
Public Member Functions
void	getWrittens (std::vector< WrittenSharedPtr > &outValues) const throw ()
void	setWrittens (const std::vector< WrittenSharedPtr > &inSource) throw ()
void	addWritten (WrittenSharedPtr &inWritten) throw (Error)
virtual void	accept (BaseVisitor &visitor) throw (Error)
Private Attributes
std::vector< WrittenSharedPtr >	mWrittens
Friends
class	FactoryType< Status >
Classes
class	Factory

---

Detailed Description

Represents EDIF status construct.

Status is used to convey accounting and problem analysis information for the design.

Definition at line 43 of file Status.hpp.

---

Member Typedef Documentation

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

Convenience class to visit a status.

Definition at line 56 of file Status.hpp.

---

Member Function Documentation

void torc::generic::Status::getWrittens

(

std::vector< WrittenSharedPtr > &

outValues

)

const throw () [inline]

Get the vector of written statements.

Returns:

vector Containing written statements

Definition at line 131 of file Status.hpp.

void torc::generic::Status::setWrittens

(

const std::vector< WrittenSharedPtr > &

inSource

)

throw ()

Set the vector of written statements.

Parameters:

[in]

inSource

Vector containing written statements

Definition at line 64 of file Status.cpp.

void torc::generic::Status::addWritten

(

WrittenSharedPtr &

inWritten

)

throw (Error)

Add a written statement to the vector of written statements. If an empty pointer is supplied, it returns without doing anything.

Parameters:

[in]

inWritten

A pointer to a written object.

Exceptions:

Error

Written could not be added.

Definition at line 80 of file Status.cpp.

void torc::generic::Status::accept

(

BaseVisitor &

visitor

)

throw (Error) [virtual]

Recive 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 sitation can arise when the passed Visitor object does not inherit from the appropriate visitor specialization. See Visitor documentation for more details.

Parameters:

[in,out]

visitor

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.

Definition at line 85 of file Status.cpp.

---

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

• torc/generic/om/Status.hpp
• torc/generic/om/Status.cpp