Image Manager (CVCDriver.dll) 14.1
Functions
IFlowSetInfo
Memory Management

Interface for collecting information about data stream modules (specifically flows and flow sets). More...

Functions

cvbbool_t CVDCanFlowSetInfo (CVDSTREAM Stream)
 This function verifies if the handle implements IFlowSetInfo. More...
 
cvbres_t CVDStreamFlowSetInfoGetFlowAlignment (CVDSTREAM Stream, size_t FlowIndex, size_t &AlignmentInBytes)
 Returns the alignment size of a single flow. More...
 
cvbres_t CVDStreamFlowSetInfoGetFlowCount (CVDSTREAM Stream, size_t &Count)
 Returns the number of flows that compose a single flow set. More...
 
cvbres_t CVDStreamFlowSetInfoGetFlowSetMinCount (CVDSTREAM Stream, size_t &Count)
 Returns the minimum number of flow sets that is required for data acquisition. More...
 
cvbres_t CVDStreamFlowSetInfoGetFlowSize (CVDSTREAM Stream, size_t FlowIndex, size_t &SizeInBytes)
 Returns the size of a single flow. More...
 

Detailed Description

Interface for collecting information about data stream modules (specifically flows and flow sets).

This is a collection of features that aim to provide information about the acquisition data stream, specifically flows and flow sets defined by GenICam GenTL standard, which are responsible for transporting acquired data.

Function Documentation

◆ CVDCanFlowSetInfo()

cvbbool_t CVDCanFlowSetInfo ( CVDSTREAM  Stream)

This function verifies if the handle implements IFlowSetInfo.

Parameters
[in]StreamHandle to be examined.
Returns
TRUE if the handle implements IFlowSetInfo, FALSE otherwise.
Supported platforms:
Win32
Win64
Linux

◆ CVDStreamFlowSetInfoGetFlowAlignment()

cvbres_t CVDStreamFlowSetInfoGetFlowAlignment ( CVDSTREAM  Stream,
size_t  FlowIndex,
size_t &  AlignmentInBytes 
)

Returns the alignment size of a single flow.

A flow is a logical unit that composes a flow set. In general, each flow represents a logical component that is a part of a whole acquired data. In a legacy 2D application, a flow is mapped to the 2D data of the given image and in a 3D application it could have three flows; one is for 3D data, another is for its confidence mask, and the other is for 2D luminance.

Parameters
[in]StreamThe handle of a target data stream module.
[in]FlowIndexThe index of the target flow to be queried.
[out]AlignmentInBytesThe alignment size of the flow specified by FlowIndex; the unit is the byte.
Returns
See also

◆ CVDStreamFlowSetInfoGetFlowCount()

cvbres_t CVDStreamFlowSetInfoGetFlowCount ( CVDSTREAM  Stream,
size_t &  Count 
)

Returns the number of flows that compose a single flow set.

Parameters
[in]StreamThe handle of a target data stream module.
[out]CountThe number of flows that compose a single flow set.
Returns
See also

◆ CVDStreamFlowSetInfoGetFlowSetMinCount()

cvbres_t CVDStreamFlowSetInfoGetFlowSetMinCount ( CVDSTREAM  Stream,
size_t &  Count 
)

Returns the minimum number of flow sets that is required for data acquisition.

Parameters
[in]StreamThe handle of a target data stream module.
[out]CountThe minimum number of flow sets that is required for data acquisition.
Returns
See also

◆ CVDStreamFlowSetInfoGetFlowSize()

cvbres_t CVDStreamFlowSetInfoGetFlowSize ( CVDSTREAM  Stream,
size_t  FlowIndex,
size_t &  SizeInBytes 
)

Returns the size of a single flow.

Note
A flow is a logical unit that composes a flow set that becomes a composite buffer. Each flow size can be vary.
Parameters
[in]StreamThe handle of a target data stream module.
[in]FlowIndexThe index of the target flow to be queried.
[out]SizeInBytesThe size of the flow specified by FlowIndex; the unit is the byte.
Returns
See also