oyConnector_s Struct Reference

a filter connection description structure More...

#include <oyranos_alpha.h>

Inheritance diagram for oyConnector_s:

Public Member Functions
OYAPI oyConnector_s *OYEXPORT	oyConnector_New (oyObject_s object)
	allocate a new Connector object
OYAPI oyConnector_s *OYEXPORT	oyConnector_Copy (oyConnector_s *obj, oyObject_s object)
	copy or reference a Connector object
OYAPI int OYEXPORT	oyConnector_Release (oyConnector_s **obj)
	release and possibly deallocate a Connector 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.
Data Fields
oyStruct_Copy_f	copy
oyStruct_Release_f	release
oyCMMGetText_f	getText
char **	texts
char *	connector_type
oyCMMFilterSocket_MatchPlug_f	filterSocket_MatchPlug
int	is_plug

---

Detailed Description

a filter connection description structure

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.3.0

Since:

2008/07/26 (Oyranos: 0.1.8)

Date:

2011/01/31

---

Field Documentation

char* oyConnector_s::connector_type

a Registration string

Reimplemented in oyConnectorImaging_s.

Referenced by oyConnector_GetReg(), oyConnector_Release(), and oyConnector_SetReg().

oyStruct_Copy_f oyConnector_s::copy

copy function

Reimplemented in oyConnectorImaging_s.

oyCMMFilterSocket_MatchPlug_f oyConnector_s::filterSocket_MatchPlug

Check if two oyCMMapi7_s filter connectors of type oyConnector_s can match each other inside a given socket and a plug.

Reimplemented in oyConnectorImaging_s.

Referenced by oyConnector_GetMatch(), and oyConnector_SetMatch().

oyCMMGetText_f oyConnector_s::getText

Support at least "name" for UIs.

Reimplemented in oyConnectorImaging_s.

int oyConnector_s::is_plug

make requests and receive data, by part of oyFilterPlug_s

Reimplemented in oyConnectorImaging_s.

Referenced by oyConnector_IsPlug(), and oyConnector_SetIsPlug().

oyStruct_Release_f oyConnector_s::release

release function

Reimplemented in oyConnectorImaging_s.

Referenced by oyConnector_New().

char** oyConnector_s::texts

zero terminated list for getText

Reimplemented in oyConnectorImaging_s.