tecplot::toolbox::Set Class Reference

Set should be used with TecUtil functions that use the Set_pa type. More...

#include <Set.h>

Public Member Functions
	Set () throw (OutOfMemoryException)
	Create a Set object.
	Set (SetIndex_t member) throw (OutOfMemoryException)
	Create a Set object.
	Set (std::string strValue) throw (OutOfMemoryException, InvalidArgumentException)
	Create a Set object.
	Set (std::set< int > const &stdSet) throw (OutOfMemoryException, InvalidArgumentException)
	Create a Set object from a std::set<int>.
	Set (Set_pa set) throw (OutOfMemoryException)
	Create a Set object.
	Set (const Set &set) throw (OutOfMemoryException)
	Create a Set object.
virtual	~Set ()
virtual Boolean_t	operator== (const Set &rhs) const
	Query if the set contains the same members as the specified set.
virtual Boolean_t	operator!= (const Set &rhs) const
	Query if the set is different from the specified set.
virtual Set &	operator= (SetIndex_t rhs) throw (OutOfMemoryException)
	Assign a single member to the Set.
virtual Set &	operator= (const Set &rhs) throw (OutOfMemoryException)
	Copy the members of one set to the set.
virtual Set &	operator= (const std::string rhs) throw (OutOfMemoryException, InvalidArgumentException)
	Assign set members from a string representation of a set.
virtual Set &	operator+= (SetIndex_t rhs) throw (OutOfMemoryException)
	Add a member to the set.
virtual Set &	operator+= (const Set &rhs) throw (OutOfMemoryException)
	Add the members of one set to the set.
virtual Set &	operator+= (const std::string rhs) throw (OutOfMemoryException, InvalidArgumentException)
	Add set members from a string representation of a set.
virtual Set &	operator-= (SetIndex_t member)
	Remove a member from the set.
virtual Set &	operator-= (const Set &rhs)
	Remove the members of one set from the set.
virtual Set &	operator-= (const std::string rhs) throw (OutOfMemoryException, InvalidArgumentException)
	Remove set members from a string representation of a set.
virtual void	add (SetIndex_t member) throw (OutOfMemoryException)
	Add a member to the set.
virtual void	add (const Set &set) throw (OutOfMemoryException)
	Add the members of one set to the set.
virtual void	remove (SetIndex_t member)
	Remove a member from the set.
virtual void	remove (const Set &set)
	Remove the members of one set from the set.
virtual void	clear ()
	Remove all members from the set.
virtual void	assign (const Set &set) throw (OutOfMemoryException)
	Copy the members of one set to the set.
virtual void	assign (std::string strValue) throw (OutOfMemoryException, InvalidArgumentException)
	Assign set members from a string representation of a set.
virtual void	toStdSet (std::set< int > &stdSet)
	Create a std::set<int> representation of the set contents.
virtual std::string	toString () const
	Create a string representation of the set contents.
virtual const Set_pa	getRef () const
	Get a reference to the Set_pa that is attached to the Set object.
virtual SetIndex_t	get (SetIndex_t position) const
	Get the member at the specified position in the set.
virtual SetIndex_t	size () const
	Get the number of members in the set.
virtual SetIndex_t	getNext (SetIndex_t member) const
	Get the next member in the set.
virtual SetIndex_t	getPosition (SetIndex_t member) const
	Get the position of the member within the set.
virtual Boolean_t	isEmpty () const
	Query if the set has any members.
virtual Boolean_t	isEqual (const Set &other) const
	Query if the set contains the same member as the specified set.
virtual Boolean_t	isMember (SetIndex_t member) const
	Query if a member is a part of the set.
virtual Boolean_t	isValidMember (SetIndex_t member) const
	Determine if a member number is valid.
virtual Boolean_t	isValidPosition (SetIndex_t position) const
	Determine if a position index is valid.
Static Public Member Functions
static Set	intersection (const Set &set1, const Set &set2) throw (OutOfMemoryException)
	Calculate the intersection of two sets.

---

Detailed Description

Set should be used with TecUtil functions that use the Set_pa type.

Some TecUtil functions allocate a Set_pa in which case you will need to use TecUtilSetDealloc to free the memory.

---

Constructor & Destructor Documentation

tecplot::toolbox::Set::Set

(

)

throw (OutOfMemoryException) [explicit]

Create a Set object.

Exceptions:

OutOfMemoryException

OutOfMemoryException is thrown if the Set could not be allocated.

tecplot::toolbox::Set::Set

(

SetIndex_t

member

)

throw (OutOfMemoryException) [explicit]

Create a Set object.

Parameters:

member

The value with which to seed the Set object.

Exceptions:

OutOfMemoryException

OutOfMemoryException is thrown if the Set could not be allocated.

tecplot::toolbox::Set::Set

(

std::string

strValue

)

throw (OutOfMemoryException, InvalidArgumentException) [explicit]

Create a Set object.

Parameters:

strValue

strValue must have the form: "[s[,s][,s]...]" where s can be one of: 'n' or 'n-m' or 'n-m:l' And where: n >= 1 m > n l >= 1 (l is a skip factor) e.g. "[1,4,7]" - 1,4,7 "[1-5]" - 1,2,3,4,5 "[1,4,7-13:2]" - 1,4,7,9,11,13

Exceptions:

	OutOfMemoryException	OutOfMemoryException is thrown if the Set could not be allocated.
	InvalidArgumentException	InvalidArgumentException is thrown if strValue does not conform to the specified rules.

See also:

Set::assign, Set::toString

tecplot::toolbox::Set::Set

(

std::set< int > const &

stdSet

)

throw (OutOfMemoryException, InvalidArgumentException) [explicit]

Create a Set object from a std::set<int>.

Parameters:

stdSet

std::set<int> object

Exceptions:

	OutOfMemoryException	OutOfMemoryException is thrown if the Set could not be allocated.
	InvalidArgumentException	InvalidArgumentException is thrown if stdSet contains items that are not valid set members. See isValidMember() for more info.

See also:

Set::assign, Set::toString

tecplot::toolbox::Set::Set

(

Set_pa

set

)

throw (OutOfMemoryException) [explicit]

Create a Set object.

Parameters:

set

A preallocated Set_pa with which, to populate the Set object. If this parameter is NULL an empty Set will be created.

   Set_pa zoneSet;
   TecUtilZoneGetEnabled(&zoneSet);
   Set enabledZones(zoneSet);
   TecUtilSetDealloc(&zoneSet);
   ... do something with enabledZones ...   

Exceptions:

OutOfMemoryException

OutOfMemoryException is thrown if the Set could not be allocated.

See also:

TecUtilZoneGetEnabled, TecUtilZoneGetActive

tecplot::toolbox::Set::Set

(

const Set &

set

)

throw (OutOfMemoryException)

Create a Set object.

Parameters:

set

A Set object you want to copy

Exceptions:

OutOfMemoryException

OutOfMemoryException is thrown if the Set could not be allocated.

virtual tecplot::toolbox::Set::~Set

(

)

[virtual]

---

Member Function Documentation

virtual Boolean_t tecplot::toolbox::Set::operator==

(

const Set &

rhs

)

const [virtual]

Query if the set contains the same members as the specified set.

Parameters:

rhs

The set on the right hand side to compare with

Returns:

TRUE if the set contains exactly the same members as the specified set. FALSE otherwise.

See also:

isEqual

virtual Boolean_t tecplot::toolbox::Set::operator!=

(

const Set &

rhs

)

const [virtual]

Query if the set is different from the specified set.

Parameters:

rhs

The set on the right hand side to compare with

Returns:

TRUE if the sets are different. FALSE otherwise.

See also:

isEqual

virtual Set& tecplot::toolbox::Set::operator=

(

SetIndex_t

rhs

)

throw (OutOfMemoryException) [virtual]

Assign a single member to the Set.

Parameters:

rhs

A SetIndex_t which is greater than or equal to 1.

Exceptions:

OutOfMemoryException

OutOfMemoryException is thrown if the Set could not be expanded.

virtual Set& tecplot::toolbox::Set::operator=

(

const Set &

rhs

)

throw (OutOfMemoryException) [virtual]

Copy the members of one set to the set.

Parameters:

rhs

A set object that contains zero or more members

Exceptions:

OutOfMemoryException

OutOfMemoryException is thrown if the Set could not be expanded.

virtual Set& tecplot::toolbox::Set::operator=

(

const std::string

rhs

)

throw (OutOfMemoryException, InvalidArgumentException) [virtual]

Assign set members from a string representation of a set.

Parameters:

rhs

As string that represents a valid set. See Set::assign.

Exceptions:

	OutOfMemoryException	OutOfMemoryException is thrown if the Set could not be expanded.
	InvalidArgumentException	InvalidArgumentException is thrown if strValue does not conform to the specified rules.

See also:

Set::assign, Set::toString

virtual Set& tecplot::toolbox::Set::operator+=

(

SetIndex_t

rhs

)

throw (OutOfMemoryException) [virtual]

Add a member to the set.

Parameters:

rhs

Member to add to the set. Member must be greater than or equal to 1.

Exceptions:

OutOfMemoryException

OutOfMemoryException is thrown if the Set could not be expanded.

virtual Set& tecplot::toolbox::Set::operator+=

(

const Set &

rhs

)

throw (OutOfMemoryException) [virtual]

Add the members of one set to the set.

Parameters:

rhs

The set which to add to the current set.

Exceptions:

OutOfMemoryException

OutOfMemoryException is thrown if the Set could not be expanded.

virtual Set& tecplot::toolbox::Set::operator+=

(

const std::string

rhs

)

throw (OutOfMemoryException, InvalidArgumentException) [virtual]

Add set members from a string representation of a set.

Parameters:

rhs

As string that represents a valid set. See Set::assign.

Exceptions:

	OutOfMemoryException	OutOfMemoryException is thrown if the Set could not be expanded.
	InvalidArgumentException	InvalidArgumentException is thrown if strValue does not conform to the specified rules.

See also:

Set::assign, Set::toString

virtual Set& tecplot::toolbox::Set::operator-=

(

SetIndex_t

member

)

[virtual]

Remove a member from the set.

Parameters:

member

Member to remove from the set.

virtual Set& tecplot::toolbox::Set::operator-=

(

const Set &

rhs

)

[virtual]

Remove the members of one set from the set.

Parameters:

rhs

The set identifying the members to remove from the current set.

virtual Set& tecplot::toolbox::Set::operator-=

(

const std::string

rhs

)

throw (OutOfMemoryException, InvalidArgumentException) [virtual]

Remove set members from a string representation of a set.

Parameters:

rhs

As string that represents a valid set. See Set::assign.

Exceptions:

	OutOfMemoryException	OutOfMemoryException is thrown if there is not enough memory to perform this operation.
	InvalidArgumentException	InvalidArgumentException is thrown if strValue does not conform to the specified rules.

See also:

Set::assign, Set::toString

virtual void tecplot::toolbox::Set::add

(

SetIndex_t

member

)

throw (OutOfMemoryException) [virtual]

Add a member to the set.

Parameters:

member

Member to add to the set. Member must be greater than or equal to 1.

Exceptions:

OutOfMemoryException

OutOfMemoryException is thrown if the Set could not be expanded.

virtual void tecplot::toolbox::Set::add

(

const Set &

set

)

throw (OutOfMemoryException) [virtual]

Add the members of one set to the set.

Parameters:

set

The set which to add to the current set.

Exceptions:

OutOfMemoryException

OutOfMemoryException is thrown if the Set could not be expanded.

virtual void tecplot::toolbox::Set::remove

(

SetIndex_t

member

)

[virtual]

Remove a member from the set.

Parameters:

member

Member to remove from the set.

virtual void tecplot::toolbox::Set::remove

(

const Set &

set

)

[virtual]

Remove the members of one set from the set.

Parameters:

set

The set which to remove the members from the current set.

virtual void tecplot::toolbox::Set::clear

(

)

[virtual]

Remove all members from the set.

virtual void tecplot::toolbox::Set::assign

(

const Set &

set

)

throw (OutOfMemoryException) [virtual]

Copy the members of one set to the set.

Parameters:

set

A set object that contains zero or more members

Exceptions:

OutOfMemoryException

OutOfMemoryException is thrown if the Set could not be expanded.

virtual void tecplot::toolbox::Set::assign

(

std::string

strValue

)

throw (OutOfMemoryException, InvalidArgumentException) [virtual]

Assign set members from a string representation of a set.

Parameters:

strValue

strValue must have the form: "[s[,s][,s]...]" where s can be one of: 'n' or 'n-m' or 'n-m:l' And where: n >= 1 m > n l >= 1 (l is a skip factor) e.g. "[1,4,7]" - 1,4,7 "[1-5]" - 1,2,3,4,5 "[1,4,7-13:2]" - 1,4,7,9,11,13

Exceptions:

	OutOfMemoryException	OutOfMemoryException is thrown if the Set could not be expanded.
	InvalidArgumentException	InvalidArgumentException is thrown if strValue does not conform to the specified rules.

See also:

Set::toString

virtual void tecplot::toolbox::Set::toStdSet

(

std::set< int > &

stdSet

)

[virtual]

Create a std::set<int> representation of the set contents.

Parameters:

stdSet

std set<int> to which the memeber of the set will be assigned.

See also:

Set::assign

virtual std::string tecplot::toolbox::Set::toString

(

)

const [virtual]

Create a string representation of the set contents.

The resulting string will be in the form as described by Set::assign(std::string strValue).

Returns:

A string representation of the set contents.

See also:

Set::assign

virtual const Set_pa tecplot::toolbox::Set::getRef

(

)

const [virtual]

Get a reference to the Set_pa that is attached to the Set object.

Returns:

A reference to the Set_pa owned by the Set object. This reference must not be deallocated.

virtual SetIndex_t tecplot::toolbox::Set::get

(

SetIndex_t

position

)

const [virtual]

Get the member at the specified position in the set.

Parameters:

position

The position in the set. position must be >= 1.

Returns:

The member at the specified position. If a member does not exist at the specified position the return value is TECUTILSETNOTMEMBER

virtual SetIndex_t tecplot::toolbox::Set::size

(

)

const [virtual]

Get the number of members in the set.

Returns:

The count of the number of member in the set.

virtual SetIndex_t tecplot::toolbox::Set::getNext

(

SetIndex_t

member

)

const [virtual]

Get the next member in the set.

Parameters:

member

The member after which to return the next member. Use TECUTILSETNOTMEMBER to get the first member of the set.

Returns:

The member in the set following the specified member. If the specified member is not found or is the last member of the set, the return value is TECUTILSETNOTMEMBER

See also:

TecUtilSetForEachMember

virtual SetIndex_t tecplot::toolbox::Set::getPosition

(

SetIndex_t

member

)

const [virtual]

Get the position of the member within the set.

Parameters:

member

The member for which to get the position.

Returns:

The position of the specified member. If the member is not found, the return value will be TECUTILSETNOTMEMBER

static Set tecplot::toolbox::Set::intersection	(	const Set &	set1,
		const Set &	set2
	)			throw (OutOfMemoryException) [static]

Calculate the intersection of two sets.

Parameters:

	set1	The first Set to use
	set2	The second Set to use

Returns:

A Set containing the intersection of the two Sets.

Exceptions:

OutOfMemoryException

OutOfMemoryException is thrown if the resulting Set could not be created.

virtual Boolean_t tecplot::toolbox::Set::isEmpty

(

)

const [virtual]

Query if the set has any members.

Returns:

TRUE if the set has no members, FALSE if the set contains members

virtual Boolean_t tecplot::toolbox::Set::isEqual

(

const Set &

other

)

const [virtual]

Query if the set contains the same member as the specified set.

Parameters:

other

The other set to compare with.

Returns:

TRUE if the set contains exactly the same members as the specified set. FALSE otherwise.

virtual Boolean_t tecplot::toolbox::Set::isMember

(

SetIndex_t

member

)

const [virtual]

Query if a member is a part of the set.

Parameters:

member

The member to look for in the set. member must be >= 1

Returns:

TRUE if the member is contained in the set. FALSE otherwise.

virtual Boolean_t tecplot::toolbox::Set::isValidMember

(

SetIndex_t

member

)

const [inline, virtual]

Determine if a member number is valid.

Returns:

TRUE if the member number is valid, FALSE otherwise.

virtual Boolean_t tecplot::toolbox::Set::isValidPosition

(

SetIndex_t

position

)

const [inline, virtual]

Determine if a position index is valid.

Returns:

TRUE if the position index is valid, FALSE otherwise