IDef#

Fully qualified name: omni::graph::exec::unstable::IDef

class IDef : public omni::core::Generated<omni::graph::exec::unstable::IDef_abi>#

Base class for all node definitions.

See Execution Concepts for an in-depth guide on how this object is used during execution.

Thread Safety: Since definitions can be shared by multiple nodes, and nodes can be executed in parallel, implementations of this interface should expect their methods to be called in parallel.

Public Functions

inline omni::graph::exec::unstable::Status execute( omni::graph::exec::unstable::ExecutionTask &info, ) noexcept#

Execute the node definition.

The given task must not be nullptr.

Prefer calling omni::graph::exec::unstable::ExecutionTask::execute() rather than this method as omni::graph::exec::unstable::ExecutionTask::execute() populates information such as omni::graph::exec::unstable::getCurrentTask().

See Error Handling to understand the error handling/reporting responsibilities of implementors of this method.

Thread Safety: See thread safety information in interface description.

inline omni::graph::exec::unstable::SchedulingInfo getSchedulingInfo( const omni::graph::exec::unstable::ExecutionTask &info, ) noexcept#

Provides runtime information about scheduling constraints for a given task/node.

The provided omni::graph::exec::unstable::ExecutionTask can be used to determine the path of the current definition.

The given task must not be nullptr.

Thread Safety: See thread safety information in interface description.

inline const omni::graph::exec::unstable::ConstName &getName( ) noexcept#

Return unique definition identifier.

The returned pointer is never nullptr. The lifetime of the data returned is tied to the lifetime of this object.

Thread Safety: See thread safety information in interface description.

inline void *castWithoutAcquire(omni::core::TypeId id) noexcept#

Casts this object to the type described the the given id.

Returns nullptr if the cast was not successful.

Unlike omni::core::IObject::cast(), this casting method does not call omni::core::IObject::acquire().

Thread Safety: This method is thread safe.

inline uint32_t getUseCount() noexcept#

Returns the number of different instances (this included) referencing the current object.

Thread Safety: This method is thread safe.

inline void *cast(omni::core::TypeId id) noexcept#

Returns a pointer to the interface defined by the given type id if this object implements the type id’s interface.

Objects can support multiple interfaces, even interfaces that are in different inheritance chains.

The returned object will have omni::core::IObject::acquire() called on it before it is returned, meaning it is up to the caller to call omni::core::IObject::release() on the returned pointer.

The returned pointer can be safely reinterpret_cast<> to the type id’s C++ class. For example, “omni.windowing.IWindow” can be cast to omni::windowing::IWindow.

Do not directly use this method, rather use a wrapper function like omni::core::cast() or omni::core::ObjectPtr::as().

Thread Safety: This method is thread safe.

inline void acquire() noexcept#

Increments the object’s reference count.

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety: This method is thread safe.

inline void release() noexcept#

Decrements the objects reference count.

Most implementations will destroy the object if the reference count reaches 0 (though this is not a requirement).

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety: This method is thread safe.

Protected Functions

virtual Status execute_abi(ExecutionTask *info) noexcept = 0#

Execute the node definition.

The given task must not be nullptr.

Prefer calling omni::graph::exec::unstable::ExecutionTask::execute() rather than this method as omni::graph::exec::unstable::ExecutionTask::execute() populates information such as omni::graph::exec::unstable::getCurrentTask().

See Error Handling to understand the error handling/reporting responsibilities of implementors of this method.

Thread Safety: See thread safety information in interface description.

virtual SchedulingInfo getSchedulingInfo_abi( const ExecutionTask *info, ) noexcept = 0#

Provides runtime information about scheduling constraints for a given task/node.

The provided omni::graph::exec::unstable::ExecutionTask can be used to determine the path of the current definition.

The given task must not be nullptr.

Thread Safety: See thread safety information in interface description.

virtual const ConstName *getName_abi() noexcept = 0#

Return unique definition identifier.

The returned pointer is never nullptr. The lifetime of the data returned is tied to the lifetime of this object.

Thread Safety: See thread safety information in interface description.

virtual void *castWithoutAcquire_abi( omni::core::TypeId id, ) noexcept = 0#

Casts this object to the type described the the given id.

Returns nullptr if the cast was not successful.

Unlike omni::core::IObject::cast(), this casting method does not call omni::core::IObject::acquire().

Thread Safety: This method is thread safe.

virtual uint32_t getUseCount_abi() noexcept = 0#

Returns the number of different instances (this included) referencing the current object.

Thread Safety: This method is thread safe.

virtual void *cast_abi(TypeId id) noexcept = 0#

Returns a pointer to the interface defined by the given type id if this object implements the type id’s interface.

Objects can support multiple interfaces, even interfaces that are in different inheritance chains.

The returned object will have omni::core::IObject::acquire() called on it before it is returned, meaning it is up to the caller to call omni::core::IObject::release() on the returned pointer.

The returned pointer can be safely reinterpret_cast<> to the type id’s C++ class. For example, “omni.windowing.IWindow” can be cast to omni::windowing::IWindow.

Do not directly use this method, rather use a wrapper function like omni::core::cast() or omni::core::ObjectPtr::as().

Thread Safety: This method is thread safe.

virtual void acquire_abi() noexcept = 0#

Increments the object’s reference count.

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety: This method is thread safe.

virtual void release_abi() noexcept = 0#

Decrements the objects reference count.

Most implementations will destroy the object if the reference count reaches 0 (though this is not a requirement).

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety: This method is thread safe.