OpenCMISS::Zinc::NodesetGroup Class Reference

A subset of a master nodeset. More...

#include <nodeset.hpp>

Inheritance diagram for OpenCMISS::Zinc::NodesetGroup:

Public Member Functions
	NodesetGroup (cmzn_nodeset_group_id nodeset_id)
cmzn_nodeset_group_id	getId () const
int	addNode (const Node &node)
int	addNodesConditional (const Field &conditionalField)
int	removeAllNodes ()
int	removeNode (const Node &node)
int	removeNodesConditional (const Field &conditionalField)
Public Member Functions inherited from OpenCMISS::Zinc::Nodeset
	Nodeset (cmzn_nodeset_id nodeset_id)
	Nodeset (const Nodeset &nodeset)
Nodeset &	operator= (const Nodeset &nodeset)
bool	isValid () const
cmzn_nodeset_id	getId () const
NodesetGroup	castGroup ()
bool	containsNode (const Node &node)
Nodetemplate	createNodetemplate ()
Node	createNode (int identifier, const Nodetemplate &nodeTemplate)
Nodeiterator	createNodeiterator ()
int	destroyAllNodes ()
int	destroyNode (const Node &node)
int	destroyNodesConditional (const Field &conditionalField)
Node	findNodeByIdentifier (int identifier)
Fieldmodule	getFieldmodule () const
Nodeset	getMasterNodeset ()
char *	getName ()
int	getSize ()

Additional Inherited Members
Protected Attributes inherited from OpenCMISS::Zinc::Nodeset
cmzn_nodeset_id	id

Detailed Description

A subset of a master nodeset.

A specialised nodeset consisting of a subset of nodes from a master nodeset.

Member Function Documentation

int OpenCMISS::Zinc::NodesetGroup::addNode ( const Node &  node )

inline

Add specified node to nodeset group.

Parameters

node	Handle to node to add. Must be from the group's master nodeset.

Returns

Status OpenCMISS::Zinc::OK on success, CMZN_ERROR_ALREADY_EXISTS if node was already in group but otherwise successful, or any other value on more serious failure.

int OpenCMISS::Zinc::NodesetGroup::addNodesConditional ( const Field &  conditionalField )

inline

Ensure this nodeset group contains all nodes from the master nodeset for which the conditional field is true i.e. non-zero valued at the node.

Parameters

conditionalField

Field which if non-zero in a node indicates it is to be added.

Returns

Status OpenCMISS::Zinc::OK on success, any other value on failure.

cmzn_nodeset_group_id OpenCMISS::Zinc::NodesetGroup::getId ( ) const

inline

Return the C handle of the NodesetGroup object.

Returns

C handle of NodesetGroup if this objects is valid, 0 otherwise.

int OpenCMISS::Zinc::NodesetGroup::removeAllNodes ( )

inline

Remove all nodes from nodeset group.

Returns

Status OpenCMISS::Zinc::OK if all nodes removed, any other value if failed.

int OpenCMISS::Zinc::NodesetGroup::removeNode ( const Node &  node )

inline

Remove specified node from nodeset group.

Parameters

node	Handle to node to remove.

Returns

Status OpenCMISS::Zinc::OK on success, CMZN_ERROR_NOT_FOUND if node was not in the group but otherwise successful, or any other value on more serious failure.

int OpenCMISS::Zinc::NodesetGroup::removeNodesConditional ( const Field &  conditionalField )

inline

Remove all nodes from the nodeset group for which the conditional field is true i.e. non-zero valued in the node. Note that group and node_group fields are valid conditional fields.

Parameters

conditionalField

Field which if non-zero in the node indicates it is to be removed.

Returns

Status OpenCMISS::Zinc::OK on success, any other value on failure.

---

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

• auto_comments_output/nodeset.hpp