Node connection descriptor. More...

#include <oyConnectorImaging_s.h>

Inheritance diagram for oyConnectorImaging_s:

Collaboration diagram for oyConnectorImaging_s:

Public Member Functions
OYAPI oyConnectorImaging_s *OYEXPORT	oyConnectorImaging_New (oyObject_s object)
	allocate a new ConnectorImaging object

OYAPI oyConnectorImaging_s *OYEXPORT	oyConnectorImaging_Copy (oyConnectorImaging_s *connectorimaging, oyObject_s object)
	copy or reference a ConnectorImaging object

OYAPI int OYEXPORT	oyConnectorImaging_Release (oyConnectorImaging_s **connectorimaging)
	release and possibly deallocate a oyConnectorImaging_s object

OYAPI int OYEXPORT	oyConnectorImaging_GetDataTypes (oyConnectorImaging_s c, const oyDATATYPE_e data_types, int data_types_n)
	Get capabilities of oyConnectorImaging_s.

OYAPI int OYEXPORT	oyConnectorImaging_GetChannelTypes (oyConnectorImaging_s c, const oyCHANNELTYPE_e channel_types, int channel_types_n)
	Get capabilities of oyConnectorImaging_s.

OYAPI int OYEXPORT	oyConnectorImaging_GetCapability (oyConnectorImaging_s *c, oyCONNECTOR_IMAGING_CAP_e type)
	Get capabilities of oyConnectorImaging_s.

void	oyConnectorImaging_Release__Members (oyConnectorImaging_s_ *connectorimaging)
	Custom ConnectorImaging destructor.

int	oyConnectorImaging_Init__Members (oyConnectorImaging_s_ *connectorimaging)
	Custom ConnectorImaging constructor.

int	oyConnectorImaging_Copy__Members (oyConnectorImaging_s_ dst, oyConnectorImaging_s_ src)
	Custom ConnectorImaging copy constructor.

Public Member Functions inherited from oyConnector_s
OYAPI oyConnector_s *OYEXPORT	oyConnector_New (oyObject_s object)
	allocate a new Connector object

OYAPI oyConnector_s *OYEXPORT	oyConnector_Copy (oyConnector_s *connector, oyObject_s object)
	copy or reference a Connector object

OYAPI int OYEXPORT	oyConnector_Release (oyConnector_s **connector)
	release and possibly deallocate a oyConnector_s object

int	oyConnector_SetName (oyConnector_s obj, const char string, oyNAME_e type)
	set the names in a connector

const char *	oyConnector_GetName (oyConnector_s *obj, oyNAME_e type)
	set the names in a connector

int	oyConnector_IsPlug (oyConnector_s *obj)
	Is this connector a plug or a socket.

int	oyConnector_SetIsPlug (oyConnector_s *obj, int is_plug)
	Set this connector as a plug or a socket.

const char *	oyConnector_GetReg (oyConnector_s *obj)
	Get the registration for the connection type.

int	oyConnector_SetReg (oyConnector_s obj, const char type_registration)
	Set this connectors type string.

int	oyConnector_SetMatch (oyConnector_s *obj, oyCMMFilterSocket_MatchPlug_f func)
	Set this connectors type check function.

oyCMMFilterSocket_MatchPlug_f	oyConnector_GetMatch (oyConnector_s *obj)
	Set this connectors type check function.

void	oyConnector_Release__Members (oyConnector_s_ *connector)
	Custom Connector destructor.

int	oyConnector_Init__Members (oyConnector_s_ *connector)
	Custom Connector constructor.

int	oyConnector_Copy__Members (oyConnector_s_ dst, oyConnector_s_ src)
	Custom Connector copy constructor.

Public Member Functions inherited from oyStruct_s
const char *	oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	get a text dump

Data Fields
oyStruct_Copy_f	copy

oyStruct_Release_f	release

Data Fields inherited from oyConnector_s
oyStruct_Copy_f	copy

oyStruct_Release_f	release

Data Fields inherited from oyStruct_s
oyStruct_Copy_f	copy

oyStruct_Release_f	release

Detailed Description

Node connection descriptor.

This structure holds informations about the connection capabilities. It holds common structure members of oyFilterPlug_s and oyFilterSocket_s.

To signal a value is not initialised or does not apply, set the according integer value to -1.

Todo:: generalise the connector properties

Version: Oyranos: 0.1.10

Since: 2008/07/26 (Oyranos: 0.1.8)

Date: 2010/06/25

Member Function Documentation

OYAPI oyConnectorImaging_s *OYEXPORT oyConnectorImaging_Copy	(	oyConnectorImaging_s *	connectorimaging,
		oyObject_s	object
	)

copy or reference a ConnectorImaging object

Function oyConnectorImaging_Copy

The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.

Parameters

[in]	connectorimaging	ConnectorImaging struct object
	object	NULL - means reference, the optional object triffers a real copy

References oyOBJECT_CONNECTOR_IMAGING_S.

int oyConnectorImaging_Copy__Members	(	oyConnectorImaging_s_ *	dst,
		oyConnectorImaging_s_ *	src
	)

Custom ConnectorImaging copy constructor.

Function oyConnectorImaging_Copy__Members

OYAPI int OYEXPORT oyConnectorImaging_GetCapability	(	oyConnectorImaging_s *	c,
		oyCONNECTOR_IMAGING_CAP_e	type
	)

Get capabilities of oyConnectorImaging_s.

Function oyConnectorImaging_GetDataTypes

Version: Oyranos: 0.5.0

Date: 2012/09/06

Since: 2012/09/06 (Oyranos: 0.5.0)

References oyCONNECTOR_IMAGING_CAP_CAN_INTERWOVEN, oyCONNECTOR_IMAGING_CAP_CAN_PLANAR, oyCONNECTOR_IMAGING_CAP_CAN_REVERT, oyCONNECTOR_IMAGING_CAP_CAN_SUBPIXEL, oyCONNECTOR_IMAGING_CAP_CAN_SWAP, oyCONNECTOR_IMAGING_CAP_CAN_SWAP_BYTES, oyCONNECTOR_IMAGING_CAP_ID, and oyOBJECT_CONNECTOR_IMAGING_S.

OYAPI int OYEXPORT oyConnectorImaging_GetChannelTypes	(	oyConnectorImaging_s *	c,
		const oyCHANNELTYPE_e **	channel_types,
		int *	channel_types_n
	)

Get capabilities of oyConnectorImaging_s.

Function oyConnectorImaging_GetChannelTypes

Version: Oyranos: 0.5.0

Date: 2012/09/06

Since: 2012/09/06 (Oyranos: 0.5.0)

References oyOBJECT_CONNECTOR_IMAGING_S.

OYAPI int OYEXPORT oyConnectorImaging_GetDataTypes	(	oyConnectorImaging_s *	c,
		const oyDATATYPE_e **	data_types,
		int *	data_types_n
	)

Get capabilities of oyConnectorImaging_s.

Function oyConnectorImaging_GetDataTypes

Version: Oyranos: 0.5.0

Date: 2012/09/06

Since: 2012/09/06 (Oyranos: 0.5.0)

References oyOBJECT_CONNECTOR_IMAGING_S.

int oyConnectorImaging_Init__Members ( oyConnectorImaging_s_ * connectorimaging )

Custom ConnectorImaging constructor.

Function oyConnectorImaging_Init__Members

OYAPI oyConnectorImaging_s *OYEXPORT oyConnectorImaging_New ( oyObject_s object )

allocate a new ConnectorImaging object

Function oyConnectorImaging_New

References oyOBJECT_OBJECT_S.

OYAPI int OYEXPORT oyConnectorImaging_Release ( oyConnectorImaging_s ** connectorimaging )

release and possibly deallocate a oyConnectorImaging_s object

Function oyConnectorImaging_Release

Parameters

[in,out] connectorimaging ConnectorImaging struct object

References oyOBJECT_CONNECTOR_IMAGING_S.

void oyConnectorImaging_Release__Members ( oyConnectorImaging_s_ * connectorimaging )

Custom ConnectorImaging destructor.

Function oyConnectorImaging_Release__Members

Field Documentation

oyStruct_Copy_f oyConnectorImaging_s::copy

copy function

oyStruct_Release_f oyConnectorImaging_s::release

release function

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation