A class that specifies boolean flags for how two connected objects interact. More...

#include <omEngineConnectionFlags.h>

Public Types
enum	Flag { UNDEFINED = 0, ENABLED = (1 << 0), OFFLINE = (1 << 1), LOAD = (1 << 2), START = (1 << 2), END = (1 << 3), REAL_TIME = (1 << 4), DEFAULT = ENABLED \| OFFLINE \| START \| END \| REAL_TIME }
	An enum that specifies the different connection flags. More...

Public Member Functions
	ConnectionFlags ()
	Create a new connection flags object with no flags set. More...

	ConnectionFlags (Flag flag)
	Create a new connection flags object with the specified flag value initially set. More...

	ConnectionFlags (UInt32 newFlags)
	Create a new connection flags object with the specified initial combined flags value. More...

	operator UInt32 () const
	Convert this connection flags object to an integer value. More...

Bool	isSet (Flag flag) const
	Return whether or not the specified flag value is set for this flags object. More...

void	set (Flag flag, Bool newIsSet)
	Set whether or not the specified flag value is set for this flags object. More...

Detailed Description

A class that specifies boolean flags for how two connected objects interact.

Member Enumeration Documentation

An enum that specifies the different connection flags.

Enumerator
UNDEFINED	The flag value when all flags are not set.
ENABLED	A flag indicating that the connection is enabled.
OFFLINE	A flag indicating that the connection is updated at build time.
LOAD	A flag indicating that the connection should be updated after the connection loads.
START	A flag indicating that the connection should be updated after the connection is first added to simulation.
END	A flag indicating that the connection should be updated before the connection is removed from the simulation.
REAL_TIME	A flag indicating that the connection should be updated interactively as the simulation progresses.
DEFAULT	The default flags to use for a connection.

om::engine::base::ConnectionFlags::ConnectionFlags ( )

inline

Create a new connection flags object with no flags set.

om::engine::base::ConnectionFlags::ConnectionFlags ( Flag flag )

inline

Create a new connection flags object with the specified flag value initially set.

om::engine::base::ConnectionFlags::ConnectionFlags ( UInt32 newFlags )

inline

Create a new connection flags object with the specified initial combined flags value.

om::engine::base::ConnectionFlags::operator UInt32 ( ) const

inline

Convert this connection flags object to an integer value.

This operator is provided so that the ConnectionFlags object can be used as an integer value for bitwise logical operations.

Bool om::engine::base::ConnectionFlags::isSet ( Flag flag ) const

inline

Return whether or not the specified flag value is set for this flags object.

void om::engine::base::ConnectionFlags::set	(	Flag	flag,
		Bool	newIsSet
	)

inline

Set whether or not the specified flag value is set for this flags object.

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