handleaiuinew/env/halcon/include/halconcpp/HCondition.h

/***********************************************************
 * File generated by the HALCON-Compiler hcomp version 20.11
 * Usage: Interface to C++
 *
 * Software by: MVTec Software GmbH, www.mvtec.com
 ***********************************************************/


#ifndef HCPP_HCONDITION
#define HCPP_HCONDITION

namespace HalconCpp
{

// Represents an instance of a condition synchronization object.
class LIntExport HCondition : public HHandle
{

public:

  // Create an uninitialized instance
  HCondition():HHandle() {}

  // Copy constructor
  HCondition(const HCondition& source) : HHandle(source) {}

  // Copy constructor
  HCondition(const HHandle& handle);

  // Create HCondition from handle, taking ownership
  explicit HCondition(Hlong handle);

  bool operator==(const HHandle& obj) const
  {
    return HHandleBase::operator==(obj);
  }

  bool operator!=(const HHandle& obj) const
  {
    return HHandleBase::operator!=(obj);
  }

protected:

  // Verify matching semantic type ('condition')!
  virtual void AssertType(Hphandle handle) const;

public:



/*****************************************************************************
 * Operator-based class constructors
 *****************************************************************************/

  // create_condition: Create a condition variable synchronization object.
  explicit HCondition(const HTuple& AttribName, const HTuple& AttribValue);

  // create_condition: Create a condition variable synchronization object.
  explicit HCondition(const HString& AttribName, const HString& AttribValue);

  // create_condition: Create a condition variable synchronization object.
  explicit HCondition(const char* AttribName, const char* AttribValue);

#ifdef _WIN32
  // create_condition: Create a condition variable synchronization object.
  explicit HCondition(const wchar_t* AttribName, const wchar_t* AttribValue);
#endif




  /***************************************************************************
   * Operators                                                               *
   ***************************************************************************/

  // Destroy a condition synchronization object.
  void ClearCondition() const;

  // Signal a condition synchronization object.
  void BroadcastCondition() const;

  // Signal a condition synchronization object.
  void SignalCondition() const;

  // Bounded wait on the signal of a condition synchronization object.
  void TimedWaitCondition(const HMutex& MutexHandle, Hlong Timeout) const;

  // wait on the signal of a condition synchronization object.
  void WaitCondition(const HMutex& MutexHandle) const;

  // Create a condition variable synchronization object.
  void CreateCondition(const HTuple& AttribName, const HTuple& AttribValue);

  // Create a condition variable synchronization object.
  void CreateCondition(const HString& AttribName, const HString& AttribValue);

  // Create a condition variable synchronization object.
  void CreateCondition(const char* AttribName, const char* AttribValue);

#ifdef _WIN32
  // Create a condition variable synchronization object.
  void CreateCondition(const wchar_t* AttribName, const wchar_t* AttribValue);
#endif

};

// forward declarations and types for internal array implementation

template<class T> class HSmartPtr;
template<class T> class HHandleBaseArrayRef;

typedef HHandleBaseArrayRef<HCondition> HConditionArrayRef;
typedef HSmartPtr< HConditionArrayRef > HConditionArrayPtr;


// Represents multiple tool instances
class LIntExport HConditionArray : public HHandleBaseArray
{

public:

  // Create empty array
  HConditionArray();

  // Create array from native array of tool instances
  HConditionArray(HCondition* classes, Hlong length);

  // Copy constructor
  HConditionArray(const HConditionArray &tool_array);

  // Destructor
  virtual ~HConditionArray();

  // Assignment operator
  HConditionArray &operator=(const HConditionArray &tool_array);

  // Clears array and all tool instances
  virtual void Clear();

  // Get array of native tool instances
  const HCondition* Tools() const;

  // Get number of tools
  virtual Hlong Length() const;

  // Create tool array from tuple of handles
  virtual void SetFromTuple(const HTuple& handles);

  // Get tuple of handles for tool array
  virtual HTuple ConvertToTuple() const;

protected:

// Smart pointer to internal data container
   HConditionArrayPtr *mArrayPtr;
};

}

#endif