OpenCMISS-Zinc 3.0.0 Release C++ API Documentation
 All Classes Namespaces Files Functions Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
OpenCMISS::Zinc::Nodesetchanges Class Reference

Object describing changes to a nodeset in a fieldmoduleevent. More...

#include <node.hpp>

Public Member Functions

 Nodesetchanges (cmzn_nodesetchanges_id nodesetchanges_id)
 
 Nodesetchanges (const Nodesetchanges &nodesetchanges)
 
Nodesetchangesoperator= (const Nodesetchanges &nodesetchanges)
 
bool isValid () const
 
Node::ChangeFlags getNodeChangeFlags (const Node &node)
 
int getNumberOfChanges ()
 
Node::ChangeFlags getSummaryNodeChangeFlags ()
 

Detailed Description

Object describing changes to a nodeset in a fieldmoduleevent.

Object describing changes to a nodeset in a fieldmoduleevent

Member Function Documentation

Node::ChangeFlags OpenCMISS::Zinc::Nodesetchanges::getNodeChangeFlags ( const Node node)
inline

Returns if and how a node has changed in the nodeset changes.

Parameters
nodeThe node to query about.
Returns
Logical OR of change bit flags. See #cmzn_node_change_flag.
int OpenCMISS::Zinc::Nodesetchanges::getNumberOfChanges ( )
inline

Returns the number of changes to nodes in the nodeset changes. Note this can be larger than the number of nodes in the nodeset if multiple changes are made to the same nodes, or nodes are removed.

Returns
The number of changes to nodes.
Node::ChangeFlags OpenCMISS::Zinc::Nodesetchanges::getSummaryNodeChangeFlags ( )
inline

Returns logical OR of change flags for all nodes in the nodeset changes.

Returns
Logical OR of change bit flags. See #cmzn_node_change_flag.
bool OpenCMISS::Zinc::Nodesetchanges::isValid ( ) const
inline

Check if this is a valid Nodesetchanges object.

Returns
Status True if object is valid, false otherwise.

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