FiletoActorContainerImpl Class Reference
[Gui/FiletoActorContainer]

The purpose of this class is to maintain a collection of FiletoActor objects. More...

#include <FiletoActorContainerImpl.h>

Inheritance diagram for FiletoActorContainerImpl:

Inheritance graph
[legend]
Collaboration diagram for FiletoActorContainerImpl:

Collaboration graph
[legend]
List of all members.

Public Types

typedef std::list< FiletoActorRow * > ListRow
 Definition of a row.
typedef ListRow::iterator ListRowIterator
 Definition of a row iterator.
typedef std::list< FiletoActorRow
const * > 
ConstListRow
 Definition of a row.
typedef ConstListRow::iterator ConstListRowIterator
 Definition of a row iterator.

Public Member Functions

 vtkTypeMacro (FiletoActorContainerImpl, vtkObject)
void PrintSelf (ostream &os, vtkIndent indent)
 Print the state of this object.
void add (std::string name, FiletoActor *dataflow)
 Add an element to the list.
FiletoActorremove (std::string name)
 Remove an element from the list.
FiletoActorremove (ListRowIterator index)
 Remove an element in the list.
FiletoActorexamine (std::string name)
 Give the element associated with a name.
FiletoActorexamine (ListRowIterator index) const
 Give the element at an index.
std::string name (ListRowIterator index) const
 Give the name of a row.
ListRowIterator nameToIndex (std::string name)
 Given a dataflow name return its index in the list/.
ListRowIterator end ()
 Give the end index of the list.
ListRowIterator begin ()
 Give the start of the list.
int getRowCount () const
 Give the number of elements currently in the list.
int getColumnCount () const
 Give the number of columns in the list.

Static Public Member Functions

static FiletoActorContainerImplNew ()
 Instantiate a new object of this type.

Protected Member Functions

 FiletoActorContainerImpl ()
 Ctor.
virtual ~FiletoActorContainerImpl ()
 Dtor.

Detailed Description

The purpose of this class is to maintain a collection of FiletoActor objects.

Definition at line 20 of file FiletoActorContainerImpl.h.


Member Typedef Documentation

typedef std::list<FiletoActorRow *> FiletoActorContainerImpl::ListRow

Definition of a row.

Definition at line 29 of file FiletoActorContainerImpl.h.

typedef ListRow::iterator FiletoActorContainerImpl::ListRowIterator

Definition of a row iterator.

Definition at line 34 of file FiletoActorContainerImpl.h.

typedef std::list<FiletoActorRow const *> FiletoActorContainerImpl::ConstListRow

Definition of a row.

Definition at line 39 of file FiletoActorContainerImpl.h.

typedef ConstListRow::iterator FiletoActorContainerImpl::ConstListRowIterator

Definition of a row iterator.

Definition at line 44 of file FiletoActorContainerImpl.h.


Constructor & Destructor Documentation

FiletoActorContainerImpl::FiletoActorContainerImpl (  )  [protected]

Ctor.

virtual FiletoActorContainerImpl::~FiletoActorContainerImpl (  )  [protected, virtual]

Dtor.


Member Function Documentation

static FiletoActorContainerImpl* FiletoActorContainerImpl::New (  )  [static]

Instantiate a new object of this type.

This is the only method that objects of this type may be created.

Returns:
The new object.

Reimplemented from vtkObject.

FiletoActorContainerImpl::vtkTypeMacro ( FiletoActorContainerImpl  ,
vtkObject   
)

void FiletoActorContainerImpl::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Print the state of this object.

Parameters:
os The output stream.
indent The indentation level. Used for formating output.

Reimplemented from vtkObject.

void FiletoActorContainerImpl::add ( std::string  name,
FiletoActor dataflow 
)

Add an element to the list.

Parameters:
name The indentifying name (or key) of the element.
dataflow The object that is the element.

FiletoActor* FiletoActorContainerImpl::remove ( std::string  name  ) 

Remove an element from the list.

Parameters:
name The name or key of the element to remove.
Returns:
The dataflow of the element removed. If there was no dataflow associated with the name then null is returned.

FiletoActor* FiletoActorContainerImpl::remove ( ListRowIterator  index  ) 

Remove an element in the list.

Parameters:
index The index (determined by other means) of the element to remove. If this parameter is out of bounds then no action is taken and, therefore, null is returned.
Returns:
The dataflow of the element removed. If there was no dataflow associated with the name then null is returned.

FiletoActor* FiletoActorContainerImpl::examine ( std::string  name  ) 

Give the element associated with a name.

Parameters:
name The name or key of the element to examine.
Returns:
The dataflow of the element examined. If there was no dataflow associated with the name then null is returned.

FiletoActor* FiletoActorContainerImpl::examine ( ListRowIterator  index  )  const

Give the element at an index.

Parameters:
index The index (determined by other means) of the element to examine. If this parameter is out of bounds then no action is taken and, therefore, null is returned.
Returns:
The dataflow of the element examined. If there was no dataflow associated with the name then null is returned.

std::string FiletoActorContainerImpl::name ( ListRowIterator  index  )  const

Give the name of a row.

Parameters:
index The index of the row for which the name is required.
Returns:
The row name.

ListRowIterator FiletoActorContainerImpl::nameToIndex ( std::string  name  ) 

Given a dataflow name return its index in the list/.

Parameters:
name The name or key of the desired element.
Returns:
The index in the list. If there is no dataflow associated with the name then return 0.

ListRowIterator FiletoActorContainerImpl::end (  ) 

Give the end index of the list.

Returns:
The last item in the list.

ListRowIterator FiletoActorContainerImpl::begin (  ) 

Give the start of the list.

Returns:
The first item in the list.

int FiletoActorContainerImpl::getRowCount (  )  const

Give the number of elements currently in the list.

Returns:
Number of elements.

int FiletoActorContainerImpl::getColumnCount (  )  const

Give the number of columns in the list.

This is always one for the model. This function implements TableModel.

Returns:
Alway 1.


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