Oyranos
git-devel
Oyranos is a full featured Color Management System
|
A filter connection structure. More...
#include <oyFilterSocket_s.h>
Public Member Functions | |
OYAPI oyFilterSocket_s *OYEXPORT | oyFilterSocket_New (oyObject_s object) |
allocate a new FilterSocket object More... | |
OYAPI oyFilterSocket_s *OYEXPORT | oyFilterSocket_Copy (oyFilterSocket_s *filtersocket, oyObject_s object) |
Copy or Reference a FilterSocket object. More... | |
OYAPI int OYEXPORT | oyFilterSocket_Release (oyFilterSocket_s **filtersocket) |
release and possibly deallocate a oyFilterSocket_s object More... | |
OYAPI int OYEXPORT | oyFilterSocket_Callback (oyFilterPlug_s *c, oyCONNECTOR_EVENT_e e) |
Tell about a oyConversion_s event. More... | |
OYAPI int OYEXPORT | oyFilterSocket_SignalToGraph (oyFilterSocket_s *c, oyCONNECTOR_EVENT_e e) |
Send a signal through the graph. More... | |
OYAPI oyFilterNode_s *OYEXPORT | oyFilterSocket_GetNode (oyFilterSocket_s *socket) |
Access oyFilterSocket_s::node. More... | |
OYAPI oyStruct_s *OYEXPORT | oyFilterSocket_GetData (oyFilterSocket_s *socket) |
Access oyFilterSocket_s::data. More... | |
OYAPI int OYEXPORT | oyFilterSocket_SetData (oyFilterSocket_s *socket, oyStruct_s *data) |
Set oyFilterSocket_s::data. More... | |
OYAPI oyFilterPlugs_s *OYEXPORT | oyFilterSocket_GetPlugs (oyFilterSocket_s *socket) |
Access oyFilterSocket_s::requesting_plugs_. More... | |
OYAPI const char *OYEXPORT | oyFilterSocket_GetRelatives (oyFilterSocket_s *socket) |
get short description of belonging filter More... | |
void | oyFilterSocket_Release__Members (oyFilterSocket_s_ *filtersocket) |
Custom FilterSocket destructor. More... | |
int | oyFilterSocket_Init__Members (oyFilterSocket_s_ *filtersocket OY_UNUSED) |
Custom FilterSocket constructor. More... | |
int | oyFilterSocket_Copy__Members (oyFilterSocket_s_ *dst, oyFilterSocket_s_ *src) |
Custom FilterSocket copy constructor. 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... | |
int | oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f msg, oyStruct_RegisterStaticFreeFunc_f free_func) |
register a function for verbosity More... | |
const char * | oyStruct_GetInfo (oyPointer context_object, oyNAME_e type, int flags) |
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... | |
A filter connection structure.
The passive output version of a oyConnector_s.
OYAPI int OYEXPORT oyFilterSocket_Callback | ( | oyFilterPlug_s * | c, |
oyCONNECTOR_EVENT_e | e | ||
) |
Tell about a oyConversion_s event.
Function oyFilterSocket_Callback
[in,out] | c | the connector |
e | the event type |
OYAPI oyFilterSocket_s *OYEXPORT oyFilterSocket_Copy | ( | oyFilterSocket_s * | filtersocket, |
oyObject_s | object | ||
) |
Copy or Reference a FilterSocket object.
Function oyFilterSocket_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | filtersocket | FilterSocket struct object |
object | NULL - means reference, the optional object triggers a real copy |
int oyFilterSocket_Copy__Members | ( | oyFilterSocket_s_ * | dst, |
oyFilterSocket_s_ * | src | ||
) |
Custom FilterSocket copy constructor.
Function oyFilterSocket_Copy__Members
OYAPI oyStruct_s *OYEXPORT oyFilterSocket_GetData | ( | oyFilterSocket_s * | socket | ) |
Access oyFilterSocket_s::data.
Function oyFilterSocket_GetData
[in] | socket | the socket |
Referenced by oyFilterPlug_ImageRootRun(), and oyConnectorImaging_s::oyFilterSocket_MatchImagingPlug().
OYAPI oyFilterNode_s *OYEXPORT oyFilterSocket_GetNode | ( | oyFilterSocket_s * | socket | ) |
Access oyFilterSocket_s::node.
Function oyFilterSocket_GetNode
[in] | socket | the socket |
OYAPI oyFilterPlugs_s *OYEXPORT oyFilterSocket_GetPlugs | ( | oyFilterSocket_s * | socket | ) |
Access oyFilterSocket_s::requesting_plugs_.
Function oyFilterSocket_GetPlugs
[in] | socket | the socket |
OYAPI const char *OYEXPORT oyFilterSocket_GetRelatives | ( | oyFilterSocket_s * | socket | ) |
get short description of belonging filter
Function oyFilterSocket_GetRelatives
[in] | socket | the socket |
int oyFilterSocket_Init__Members | ( | oyFilterSocket_s_ *filtersocket | OY_UNUSED | ) |
Custom FilterSocket constructor.
Function oyFilterSocket_Init__Members
OYAPI oyFilterSocket_s *OYEXPORT oyFilterSocket_New | ( | oyObject_s | object | ) |
allocate a new FilterSocket object
Function oyFilterSocket_New
OYAPI int OYEXPORT oyFilterSocket_Release | ( | oyFilterSocket_s ** | filtersocket | ) |
release and possibly deallocate a oyFilterSocket_s object
Function oyFilterSocket_Release
[in,out] | filtersocket | FilterSocket struct object |
void oyFilterSocket_Release__Members | ( | oyFilterSocket_s_ * | filtersocket | ) |
Custom FilterSocket destructor.
Function oyFilterSocket_Release__Members
OYAPI int OYEXPORT oyFilterSocket_SetData | ( | oyFilterSocket_s * | socket, |
oyStruct_s * | data | ||
) |
Set oyFilterSocket_s::data.
Function oyFilterSocket_SetData
[in] | socket | the socket |
[in] | data | the data |
OYAPI int OYEXPORT oyFilterSocket_SignalToGraph | ( | oyFilterSocket_s * | c, |
oyCONNECTOR_EVENT_e | e | ||
) |
Send a signal through the graph.
Function oyFilterSocket_SignalToGraph
The traversal direction is defined as from the starting node to the output.
< kind of ping
< connection established
< released the connection
< call to update image views
< new data accessors
< can not process image
< can not handle option
< can not handle profile
< can not completely process
oyStruct_Copy_f oyFilterSocket_s::copy |
Copy function.
oyObject_s oyFilterSocket_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyFilterSocket_s::release |
Release function.
const oyOBJECT_e oyFilterSocket_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.
Referenced by oyConnectorImaging_s::oyFilterSocket_MatchImagingPlug().