BaseCmdList

Fully qualified name: cupva::BaseCmdList

Defined in cupva_host.hpp

class BaseCmdList

BaseCmdList is a movable list of BaseCmd instances.

• Maturity: GA

Public Functions

inline BaseCmdList() noexcept

Constructs an empty BaseCmdList object.

Usage considerations

• Allowed context for the API call

  • Interrupt handler: No

  • Signal handler: No

  • Thread-safe: No

  • Re-entrant: No

  • Async/Sync: Sync

• Required privileges: None

• Allowed execution state

  • Initialization: Yes

  • Operational: No

  • Reinit/Deinit Preparation: Yes

• Maturity: GA

Pre:

None

BaseCmdList(PtrType data, SizeType const size) noexcept

Constructs BaseCmdList owning a fixed size of command objects.

Usage considerations

• Allowed context for the API call

  • Interrupt handler: No

  • Signal handler: No

  • Thread-safe: No

  • Re-entrant: No

  • Async/Sync: Sync

• Required privileges: None

• Allowed execution state

  • Initialization: Yes

  • Operational: No

  • Reinit/Deinit Preparation: Yes

• Maturity: GA

Parameters:

• data – defines the command list data.

• size – defines the list size.

Pre:

None

BaseCmdList(BaseCmdList&) = delete

BaseCmdList &operator=(BaseCmdList&) = delete

inline BaseCmdList(BaseCmdList &&obj) noexcept

BaseCmdList move constructor.

Usage considerations

• Allowed context for the API call

  • Interrupt handler: No

  • Signal handler: No

  • Thread-safe: No

  • Re-entrant: No

  • Async/Sync: Sync

• Required privileges: None

• Allowed execution state

  • Initialization: Yes

  • Operational: Yes

  • Reinit/Deinit Preparation: Yes

• Maturity: GA

Pre:

None

inline BaseCmdList &operator=(BaseCmdList &&obj) & noexcept

BaseCmdList move assignment.

Usage considerations

• Allowed context for the API call

  • Interrupt handler: No

  • Signal handler: No

  • Thread-safe: No

  • Re-entrant: No

  • Async/Sync: Sync

• Required privileges: None

• Allowed execution state

  • Initialization: Yes

  • Operational: Yes

  • Reinit/Deinit Preparation: Yes

• Maturity: GA

Pre:

None

template<typename ...Args, std::enable_if_t<AllHaveBase<BaseCmd, Args...>::value, int> = 0>
inline explicit BaseCmdList(

Args&&... argsParam,

)

Constructs BaseCmdList instance owning a number of BaseCmd objects.

Usage considerations

• Allowed context for the API call

  • Interrupt handler: No

  • Signal handler: No

  • Thread-safe: No

  • Re-entrant: No

  • Async/Sync: Sync

• Required privileges: None

• Allowed execution state

  • Initialization: Yes

  • Operational: No

  • Reinit/Deinit Preparation: Yes

• Maturity: GA

Throws:

cupva::Exception(NotAllowedInOperationalState) – if called when NVIDIA DRIVE OS VM state is “Operational”

Pre:

None

~BaseCmdList() noexcept

BaseCmdList destructor.

Usage considerations

• Allowed context for the API call

  • Interrupt handler: No

  • Signal handler: No

  • Thread-safe: No

  • Re-entrant: No

  • Async/Sync: Sync

• Required privileges: None

• Allowed execution state

  • Initialization: Yes

  • Operational: No

  • Reinit/Deinit Preparation: Yes

• Maturity: GA

Pre:

None

void finalize()

Destroy the resources owned by the list.

This method is exposed to allow fine-grained control over error handling.

During destruction of the object, this method will be called but the destructor must not propagate exceptions. To handle exceptions, manually invoke this method prior to object destruction.

This function can throw exceptions depending on the commands contained in the list. See finalize()

exception specification of a particular command for details.

Usage considerations

• Allowed context for the API call

  • Interrupt handler: No

  • Signal handler: No

  • Thread-safe: No

  • Re-entrant: No

  • Async/Sync: Sync

• Required privileges: None

• Allowed execution state

  • Initialization: Yes

  • Operational: No

  • Reinit/Deinit Preparation: Yes

• Maturity: GA

Throws:

cupva::Exception(NotAllowedInOperationalState) – if called when NVIDIA DRIVE OS VM state is “Operational”

Pre:

None

inline SizeType getSize() const noexcept

Gets the number of commands stored in the list.

Usage considerations

• Allowed context for the API call

  • Interrupt handler: No

  • Signal handler: No

  • Thread-safe: Yes

  • Re-entrant: No

  • Async/Sync: Sync

• Required privileges: None

• Allowed execution state

  • Initialization: Yes

  • Operational: Yes

  • Reinit/Deinit Preparation: Yes

• Maturity: GA

Pre:

None