Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

CORBA_SeqUtil.py File Reference

CORBA sequence utility template functions. More...


Functions

 for_each (seq, f)
 CORBA sequence helper template functionsApply the functor to all CORBA sequence elements.
 find (seq, f)
 Return the index of CORBA sequence element that functor matches.
 push_back (seq, elem)
 Push the new element back to the CORBA sequence.
 push_back_list (seq1, seq2)
 insert (seq, elem, index)
 Insert the element to the CORBA sequence.
 front (seq)
 Get the front element of the CORBA sequence.
 back (seq)
 Get the last element of the CORBA sequence.
 erase (seq, index)
 Erase the element of the specified index.
 erase_if (seq, f)
 clear (seq)
 Erase all the elements of the CORBA sequence.


Detailed Description

CORBA sequence utility template functions.

Date:
Date
2007/09/03
Author:
Noriaki Ando <n-ando@aist.go.jp> and Shinji Kurihara
Copyright (C) 2007 Task-intelligence Research Group, Intelligent Systems Research Institute, National Institute of Advanced Industrial Science and Technology (AIST), Japan All rights reserved.

Function Documentation

back seq   ) 
 

Get the last element of the CORBA sequence.

This operation returns seq[seq.length() - 1].

Parameters:
seq The CORBA sequence to be get the element

clear seq   ) 
 

Erase all the elements of the CORBA sequence.

same as seq.length(0).

erase seq  ,
index 
 

Erase the element of the specified index.

This operation removes the element of the given index. The other elements are closed up around the hole.

Parameters:
seq The CORBA sequence to be get the element
index The index of the element to be removed

erase_if seq  ,
 

find seq  ,
 

Return the index of CORBA sequence element that functor matches.

This operation applies the given functor to the given CORBA sequence, and returns the index of the sequence element that the functor matches. The functor should be bool functor(const CORBA sequence element) type, and it would return true, if the element matched the functor.

Returns:
The index of the element that functor matches. If no element found, it would return -1.
Parameters:
seq CORBA sequence to be applied the functor
functor A functor to process CORBA sequence elements

for_each seq  ,
 

CORBA sequence helper template functionsApply the functor to all CORBA sequence elements.

Apply the given functor to the given CORBA sequence. functor should be void functor(CORBA sequence element).

Returns:
Functor that processed all CORBA sequence elements
Parameters:
seq CORBA sequence to be applied the functor
functor A functor to process CORBA sequence elements

front seq   ) 
 

Get the front element of the CORBA sequence.

This operation returns seq[0].

Parameters:
seq The CORBA sequence to be get the element

insert seq  ,
elem  ,
index 
 

Insert the element to the CORBA sequence.

Insert a new element in the given position to the CORBA sequence. If the given index is greater than the length of the sequence, the given element is pushed back to the last of the sequence. The length of the CORBA sequence will be expanded automatically.

Parameters:
seq The CORBA sequence to be inserted a new element
elem The new element to be inserted the sequence
index The inserting position

push_back seq  ,
elem 
 

Push the new element back to the CORBA sequence.

Add the given element to the last of CORBA sequence. The length of the CORBA sequence will be expanded automatically.

Parameters:
seq CORBA sequence to be added a new element
elem The new element to be added to the CORBA sequence

push_back_list seq1  ,
seq2 
 


Generated on Mon Oct 29 15:51:43 2007 for OpenRTM by  doxygen 1.4.3