C:/docs/OpenRTM-aist-Python/OpenRTM_aist/CORBA_SeqUtil.py File Reference

CORBA sequence utility template functions. More...

Functions
def	OpenRTM_aist.CORBA_SeqUtil.for_each (seq, f)
def	OpenRTM_aist.CORBA_SeqUtil.find (seq, f)
def	OpenRTM_aist.CORBA_SeqUtil.push_back (seq, elem)
def	OpenRTM_aist.CORBA_SeqUtil.push_back_list (seq1, seq2)
def	OpenRTM_aist.CORBA_SeqUtil.insert (seq, elem, index)
def	OpenRTM_aist.CORBA_SeqUtil.front (seq)
def	OpenRTM_aist.CORBA_SeqUtil.back (seq)
def	OpenRTM_aist.CORBA_SeqUtil.erase (seq, index)
def	OpenRTM_aist.CORBA_SeqUtil.erase_if (seq, f)
def	OpenRTM_aist.CORBA_SeqUtil.clear (seq)

Detailed Description

CORBA sequence utility template functions.

Date

Date

2007/09/03

Author

Noriaki Ando n-and.nosp@m.o@ai.nosp@m.st.go.nosp@m..jp and Shinji Kurihara

Copyright (C) 2006-2008 Task-intelligence Research Group, Intelligent Systems Research Institute, National Institute of Advanced Industrial Science and Technology (AIST), Japan All rights reserved.

Function Documentation

back()

def OpenRTM_aist.CORBA_SeqUtil.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()

def OpenRTM_aist.CORBA_SeqUtil.clear

(

seq

)

Erase all the elements of the CORBA sequence

same as seq.length(0).

erase()

def OpenRTM_aist.CORBA_SeqUtil.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

find()

def OpenRTM_aist.CORBA_SeqUtil.find	(		seq,
			f
	)

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.

Parameters

seq	CORBA sequence to be applied the functor
functor	A functor to process CORBA sequence elements

Returns

The index of the element that functor matches. If no element found, it would return -1.

for_each()

def OpenRTM_aist.CORBA_SeqUtil.for_each	(		seq,
			f
	)

Apply the functor to all CORBA sequence elements

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

Parameters

seq	CORBA sequence to be applied the functor
functor	A functor to process CORBA sequence elements

Returns

Functor that processed all CORBA sequence elements

front()

def OpenRTM_aist.CORBA_SeqUtil.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()

def OpenRTM_aist.CORBA_SeqUtil.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()

def OpenRTM_aist.CORBA_SeqUtil.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