oyConnector_s Struct Reference
Description: C source code API documentation for the Oyranos project.
Keywords: Oyranos,Color Management,Color Management,ICC,CMS,C,doxygen,API,documentation

| Oyranos Color Management System API - Version 0.9.6

Public Member Functions | Data Fields
oyConnector_s Struct Reference
Conversion

A filter connection description structure. More...

`#include <oyConnector_s.h>`

Inheritance diagram for oyConnector_s:
Collaboration diagram for oyConnector_s:

## Public Member Functions
OYAPI oyConnector_s *OYEXPORT | oyConnector_New (oyObject_s object)
| allocate a new Connector object More...
| oyConnector_Copy
| Copy or Reference a Connector object. More...
OYAPI int OYEXPORT | oyConnector_Release (oyConnector_s **connector)
| release and possibly deallocate a oyConnector_s object More...
OYAPI int OYEXPORT | oyConnector_SetTexts (oyConnector_s *obj, oyCMMGetText_f getText, const char **text_classes)
| set the texts in a connector More...
OYAPI const char **OYEXPORT | oyConnector_GetTexts (oyConnector_s *obj)
| get the text classes in a connector More...
OYAPI const char *OYEXPORT | oyConnector_GetText (oyConnector_s *obj, const char *name_class, oyNAME_e type)
| get the names in a connector More...
int | oyConnector_IsPlug (oyConnector_s *obj)
| Is this connector a plug or a socket. More...
int | oyConnector_SetIsPlug (oyConnector_s *obj, int is_plug)
| Set this connector as a plug or a socket. More...
const char * | oyConnector_GetReg (oyConnector_s *obj)
| Get the registration for the connection type. More...
int | oyConnector_SetReg (oyConnector_s *obj, const char *type_registration)
| Set this connectors type string. More...
int | oyConnector_SetMatch (oyConnector_s *obj, oyCMMFilterSocket_MatchPlug_f func)
| Set this connectors type check function. More...
oyCMMFilterSocket_MatchPlug_f | oyConnector_GetMatch (oyConnector_s *obj)
| Set this connectors type check function. More...
Public Member Functions inherited from oyStruct_s
const char * | oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
| get object infos from a module More...
const char * | oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
| Get a text dump. More...
| oyStruct_RegisterStaticMessageFunc
| register a function for verbosity More...
| oyStruct_GetInfo
| get a additional string from a object More...
const char * | oyStructTypeToText (oyOBJECT_e type)
| Objects type to small string. More...

## Data Fields
const oyOBJECT_e | type_
| Type of object. More...
oyStruct_Copy_f | copy
| Copy function. More...
oyStruct_Release_f | release
| Release function. More...
oyObject_s | oy_
| Oyranos internal object. More...
Data Fields inherited from oyStruct_s
const oyOBJECT_e | type_
| Type of object. More...
oyStruct_Copy_f | copy
| Copy function. More...
oyStruct_Release_f | release
| Release function. More...
oyObject_s | oy_
| Oyranos internal object. More...

## 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

Examples:
  oyranos_cmm_oJPG.c.

## Member Function Documentation

## ◆ oyConnector_Copy()

oyConnector_Copy

Copy or Reference a Connector object.

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

Parameters

  [in] | connector | Connector struct object
  | object | NULL - means reference, the optional object triggers a real copy

Referenced by oyFilterPlug_s::oyFilterPlug_GetPattern(), and oyFilterPlug_s::oyFilterSocket_GetPattern().

## ◆ oyConnector_GetMatch()

oyCMMFilterSocket_MatchPlug_f oyConnector_GetMatch | ( | oyConnector_s * | obj | ) |

Set this connectors type check function.

Function oyConnector_GetMatch

This is use as a check, if connections are possible. This allowes for a more fine grained control than the type registration.

Parameters

  [in] | obj | Connector object

Returns
  the check function

Version
  Oyranos: 0.3.0

Since
  2011/01/31 (Oyranos: 0.3.0)

Date
  2011/01/31

Referenced by oyFilterNode_s::oyFilterNode_ConnectorMatch().

## ◆ oyConnector_GetReg()

const char * oyConnector_GetReg | ( | oyConnector_s * | obj | ) |

Get the registration for the connection type.

Function oyConnector_GetReg

This is use as a rough check, if connections are possible.

Parameters

  [in] | obj | Connector object

Returns
  registration string

Version
  Oyranos: 0.3.0

Since
  2011/01/31 (Oyranos: 0.3.0)

Date
  2011/01/31

Referenced by oyFilterNode_s::oyFilterNode_ConnectorMatch(), and oyFilterNode_s::oyFilterNode_GetConnectorPos().

## ◆ oyConnector_GetText()

OYAPI const char *OYEXPORT oyConnector_GetText | ( | oyConnector_s * | obj,
|  | const char * | name_class,
|  | oyNAME_e | type
| ) |  |

get the names in a connector

Function oyConnector_GetText

Get UI strings.

Parameters

  [in] | obj | Connector object
  [in] | name_class | the names class, e.g. "name", "help" ...
  [in] | type | the names type

Returns
  the name string

Version
  Oyranos: 0.9.5

Since
  2011/01/31 (Oyranos: 0.3.0)

Date
  2013/06/10

## ◆ oyConnector_GetTexts()

OYAPI const char **OYEXPORT oyConnector_GetTexts | ( | oyConnector_s * | obj | ) |

get the text classes in a connector

Function oyConnector_GetTexts

Set UI strings.

Parameters

  [in] | obj | Connector object

Returns
  text_classes zero terminated list of classes, e.g. {"name",NULL}

Version
  Oyranos: 0.9.5

Date
  2013/06/10

Since
  2013/06/10 (Oyranos: 0.9.5)

## ◆ oyConnector_IsPlug()

int oyConnector_IsPlug | ( | oyConnector_s * | obj | ) |

Is this connector a plug or a socket.

Function oyConnector_IsPlug

Parameters

  [in] | obj | Connector object

Returns
  boolean; 0 - socket; 1 - plug

Version
  Oyranos: 0.3.0

Since
  2011/01/31 (Oyranos: 0.3.0)

Date
  2011/01/31

## ◆ oyConnector_New()

OYAPI oyConnector_s *OYEXPORT oyConnector_New | ( | oyObject_s | object | ) |

allocate a new Connector object

Function oyConnector_New

References oyOBJECT_OBJECT_S.

## ◆ oyConnector_Release()

OYAPI int OYEXPORT oyConnector_Release | ( | oyConnector_s ** | connector | ) |

release and possibly deallocate a oyConnector_s object

Function oyConnector_Release

Parameters

  [in,out] | connector | Connector struct object

Referenced by oyFilterNode_s::oyFilterNode_ConnectorMatch().

## ◆ oyConnector_SetIsPlug()

int oyConnector_SetIsPlug | ( | oyConnector_s * | obj,
|  | int | is_plug
| ) |  |

Set this connector as a plug or a socket.

Function oyConnector_SetIsPlug

Parameters

  [in,out] | obj | Connector object
  [in] | is_plug | boolean; 0 - socket; 1 - plug

Returns
  1 - error; 0 - success; -1 - otherwise

Version
  Oyranos: 0.3.0

Since
  2011/01/31 (Oyranos: 0.3.0)

Date
  2011/01/31

## ◆ oyConnector_SetMatch()

int oyConnector_SetMatch | ( | oyConnector_s * | obj,
|  | oyCMMFilterSocket_MatchPlug_f | func
| ) |  |

Set this connectors type check function.

Function oyConnector_SetMatch

This is use as a check, if connections are possible. This allowes for a more fine grained control than the type registration.

Parameters

  [in,out] | obj | Connector object
  [in] | func | the check function

Returns
  1 - error; 0 - success; -1 - otherwise

Version
  Oyranos: 0.3.0

Since
  2011/01/31 (Oyranos: 0.3.0)

Date
  2011/01/31

## ◆ oyConnector_SetReg()

int oyConnector_SetReg | ( | oyConnector_s * | obj,
|  | const char * | type_registration
| ) |  |

Set this connectors type string.

Function oyConnector_SetReg

This is use as a rough check, if connections are possible.

Parameters

  [in,out] | obj | Connector object
  [in] | type_registration | the registration string to describe the type

Returns
  1 - error; 0 - success; -1 - otherwise

Version
  Oyranos: 0.3.0

Since
  2011/01/31 (Oyranos: 0.3.0)

Date
  2011/01/31

## ◆ oyConnector_SetTexts()

OYAPI int OYEXPORT oyConnector_SetTexts | ( | oyConnector_s * | obj,
|  | oyCMMGetText_f | getText,
|  | const char ** | text_classes
| ) |  |

set the texts in a connector

Function oyConnector_SetTexts

Set UI strings.

Parameters

  [in] | obj | Connector object
  [in] | getText | the name function
  [in] | text_classes | zero terminated list of classes, e.g. {"name",NULL} owned by the user, but has to live the lifetime of the object

Returns
  status

Version
  Oyranos: 0.9.5

Date
  2013/06/10

Since
  2013/06/10 (Oyranos: 0.9.5)

## Field Documentation

## ◆ copy

oyStruct_Copy_f oyConnector_s::copy

Copy function.

Referenced by oyFilterNode_s::oyFilterNode_ShowConnector().

## ◆ oy_

oyObject_s oyConnector_s::oy_

Oyranos internal object.

Features name and hash. Do not change during object life time.

## ◆ release

oyStruct_Release_f oyConnector_s::release

Release function.

## ◆ type_

const oyOBJECT_e oyConnector_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.