oyFilterNode_s Struct Reference
[Conversion API's]

a FilterNode object

Filter nodes chain filters into a oyConversion_s graph. The filter nodes use plugs and sockets for creating connections. Each plug can only connect to one socket. More...

#include <oyranos_alpha.h>


Data Fields

oyOBJECT_e type_
oyStruct_Copy_f copy
oyStruct_Release_f release
oyObject_s oy_
oyFilterPlug_s ** plugs
oyFilterSocket_s ** sockets
oyFilter_sfilter
char * relatives_
oyStruct_sbackend_data

Related Functions

(Note that these are not member functions.)

oyFilterNode_soyFilterNode_New (oyObject_s object)
 allocate and initialise a new filter node object
oyFilterNode_soyFilterNode_Create (oyFilter_s *filter, oyObject_s object)
 initialise a new filter node object properly
oyFilterNode_soyFilterNode_Copy (oyFilterNode_s *node, oyObject_s object)
 copy or reference a filter node object
int oyFilterNode_Release (oyFilterNode_s **obj)
 release and zero a filter node object
OYAPI int OYEXPORT oyFilterNode_ConnectorMatch (oyFilterNode_s *node_first, int pos_first, oyConnector_s *connector_second)
 check if a connector match to a FilterNode
OYAPI oyFilterSocket_s *OYEXPORT oyFilterNode_GetSocket (oyFilterNode_s *node, int pos)
 get a oyFilterSocket_s of type from a FilterNode
OYAPI oyFilterPlug_s *OYEXPORT oyFilterNode_GetPlug (oyFilterNode_s *node, int pos)
 get a oyFilterPlug_s of type from a FilterNode
const char * oyFilterNode_GetText (oyFilterNode_s *node, oyNAME_e name_type)
 serialise filter node to text
oyPointer oyFilterNode_TextToInfo (oyFilterNode_s *node, size_t *size, oyAlloc_f allocateFunc)
 serialise filter node to binary


Detailed Description

a FilterNode object

Filter nodes chain filters into a oyConversion_s graph. The filter nodes use plugs and sockets for creating connections. Each plug can only connect to one socket.

inline_dotgraph_11.dot

This object provides support for separation of options from chaining. So it will be possible to implement options changing, which can affect the same filter instance in different graphs.

A oyFilterNode_s can have various oyFilterPlug_s ' to obtain data from different sources. The required number is described in the oyCMMapi4_s structure, which is part of oyFilter_s.

inline_dotgraph_12.dot

oyFilterSocket_s is designed to accept arbitrary numbers of connections to allow for viewing on a filters data output or observe its state changes.

inline_dotgraph_13.dot

Version:
Oyranos: 0.1.8
Since:
2008/07/08 (Oyranos: 0.1.8)
Date:
2008/07/10

Field Documentation

the filters private data, requested over oyCMMapi4_s::oyCMMFilterNode_CreateContext() and cached through Oyranos

oyStruct_Copy_f oyFilterNode_s::copy

copy function

active input connectors, list ends with a trailing zero

Referenced by oyConversion_s::oyConversion_Run(), oyFilterNode_Create(), oyFilterNode_GetPlug(), and oyFilterNode_Release().

hint about belonging to a filter

Referenced by oyFilterNode_Create(), oyFilterNode_GetPlug(), oyFilterNode_GetSocket(), and oyFilterNode_Release().

oyStruct_Release_f oyFilterNode_s::release

release function

Referenced by oyFilterNode_New().

active output connectors, list ends with a trailing zero

Referenced by oyConversion_s::oyConversion_GetOnePixel(), oyFilterNode_Create(), oyFilterNode_GetSocket(), and oyFilterNode_Release().


Generated on Tue Mar 10 09:46:21 2009 for Oyranos by  doxygen 1.5.8