Vuo  1.2.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
VuoCompilerDataClass Class Referenceabstract

Description

The data type for a data-and-event port.

Public Member Functions

virtual VuoCompilerDatanewData (void)=0
 Factory method for constructing a VuoCompilerData that instantiates this data class.
 
 ~VuoCompilerDataClass (void)
 Destructor.
 
VuoTypegetVuoType (void)
 Returns the VuoType for this port data, as set in setVuoType.
 
void setVuoType (VuoType *vuoType)
 Sets the VuoType for this port data.
 
Type * getType (void)
 Returns the LLVM type for this port data's Vuo type.
 
void setDetails (struct json_object *details)
 Sets details for this port data.
 
json_objectgetDetails (void)
 Returns details for this port data, set in setDetails().
 
- Public Member Functions inherited from VuoCompilerNodeArgumentClass
virtual ~VuoCompilerNodeArgumentClass (void)
 to make this class dynamic_cast-able
 
bool isInEventFunction (void)
 Returns true if this is known to be one of the parameters in its node class's event function.
 
size_t getIndexInEventFunction (void)
 Returns the index of this port's parameter in its node class's event function.
 
void setIndexInEventFunction (size_t indexInEventFunction)
 Indicates that this is the parameter at index indexInEventFunction in its node class's event function.
 
bool isInInitFunction (void)
 Returns true if this is known to be one of the parameters in its node class's init function.
 
size_t getIndexInInitFunction (void)
 Returns the index of this port's parameter in its node class's init function.
 
void setIndexInInitFunction (size_t indexInInitFunction)
 Indicates that this is the parameter at index indexInInitFunction in its node class's init function.
 
bool isInCallbackStartFunction (void)
 Returns true if this is known to be one of the parameters in its node class's callback start function.
 
size_t getIndexInCallbackStartFunction (void)
 Returns the index of this port's parameter in its node class's callback start function.
 
void setIndexInCallbackStartFunction (size_t indexInCallbackStartFunction)
 Indicates that this is the parameter at index indexInCallbackStartFunction in its node class's callback start function.
 
bool isInCallbackUpdateFunction (void)
 Returns true if this is known to be one of the parameters in its node class's callback update function.
 
size_t getIndexInCallbackUpdateFunction (void)
 Returns the index of this port's parameter in its node class's callback update function.
 
void setIndexInCallbackUpdateFunction (size_t indexInCallbackUpdateFunction)
 Indicates that this is the parameter at index indexInCallbackUpdateFunction in its node class's callback update function.
 
bool isInCallbackStopFunction (void)
 Returns true if this is known to be one of the parameters in its node class's callback stop function.
 
size_t getIndexInCallbackStopFunction (void)
 Returns the index of this port's parameter in its node class's callback stop function.
 
void setIndexInCallbackStopFunction (size_t indexInCallbackStopFunction)
 Indicates that this is the parameter at index indexInCallbackStopFunction in its node class's callback stop function.
 
- Public Member Functions inherited from VuoBaseDetail< VuoPortClass >
 VuoBaseDetail (string description, VuoPortClass *base)
 Creates a VuoPortClass detail class.
 
VuoPortClassgetBase (void) const
 Returns the VuoPortClass detail class instance's base class instance.
 
void setBase (VuoPortClass *base)
 Sets the VuoPortClass detail class instance's base class instance.
 

Protected Member Functions

 VuoCompilerDataClass (string name, Type *type)
 Creates a data type for a data-and-event port.
 
- Protected Member Functions inherited from VuoCompilerNodeArgumentClass
 VuoCompilerNodeArgumentClass (string name, VuoPortClass::PortType portType, Type *type)
 Creates a parameter for calling a node's event or init function, and creates its corresponding base VuoPortClass.
 

Protected Attributes

struct json_objectdetails
 Metadata specified in the node class implementation, such as the default value.
 
- Protected Attributes inherited from VuoCompilerNodeArgumentClass
Type * type
 The parameter's type.
 
bool inEventFunction
 Does this parameter appear in the node's event function?
 
size_t indexInEventFunction
 Where this parameter appears in the node's event function's parameter list.
 
bool inInitFunction
 Does this parameter appear in the node's init function?
 
size_t indexInInitFunction
 Where this parameter appears in the node's init function's parameter list.
 
bool inCallbackStartFunction
 Does this parameter appear in the node's callback start function?
 
size_t indexInCallbackStartFunction
 Where this parameter appears in the node's callback start function's parameter list.
 
bool inCallbackUpdateFunction
 Does this parameter appear in the node's callback update function?
 
size_t indexInCallbackUpdateFunction
 Where this parameter appears in the node's callback update function's parameter list.
 
bool inCallbackStopFunction
 Does this parameter appear in the node's callback stop function?
 
size_t indexInCallbackStopFunction
 Where this parameter appears in the node's callback stop function's parameter list.
 

Constructor & Destructor Documentation

VuoCompilerDataClass::VuoCompilerDataClass ( string  name,
Type *  type 
)
protected

Creates a data type for a data-and-event port.

VuoCompilerDataClass::~VuoCompilerDataClass ( void  )

Destructor.

Member Function Documentation

json_object * VuoCompilerDataClass::getDetails ( void  )

Returns details for this port data, set in setDetails().

Type * VuoCompilerDataClass::getType ( void  )
virtual

Returns the LLVM type for this port data's Vuo type.

Overrides the implementation in VuoCompilerNodeArgumentClass.

Reimplemented from VuoCompilerNodeArgumentClass.

VuoType * VuoCompilerDataClass::getVuoType ( void  )

Returns the VuoType for this port data, as set in setVuoType.

virtual VuoCompilerData* VuoCompilerDataClass::newData ( void  )
pure virtual

Factory method for constructing a VuoCompilerData that instantiates this data class.

Implemented in VuoCompilerInputDataClass, and VuoCompilerOutputDataClass.

void VuoCompilerDataClass::setDetails ( struct json_object details)

Sets details for this port data.

Example:
{
"default":10,
"suggestedMin":0,
"suggestedMax":100
}
Example:
{
"default":{"x":-0.5,"y":0.5}
}
void VuoCompilerDataClass::setVuoType ( VuoType vuoType)

Sets the VuoType for this port data.

Its VuoCompilerType may be null (but needs to be non-null by the time the composition is compiled).

Member Data Documentation

struct json_object* VuoCompilerDataClass::details
protected

Metadata specified in the node class implementation, such as the default value.


The documentation for this class was generated from the following files: