Public Member Functions | Properties

VCCommandOutlet Class Reference

Represents a command that a data consumer can control. More...

Inherits VCExtendedManagedObject.

List of all members.

Public Member Functions

(void) - sendCommandWithValue:
 Send a value (with associated timestamp) to the command.
(void) - sendCommandWithDouble:atTime:
 Command a double value at a specific time.
(void) - sendCommandWithInt:atTime:
 Command an integer value at a specific time.
(void) - sendCommandWithData:ofType:atTime:
 Send an arbitrary data type at a specific time.

Properties

NSString * units
 If this command outlet is connected, the units of destination command.
VCDataConsumer * consumer
 The data consumer that owns this command outlet.
NSString * outletName
 The name of this command outlet.
int outletIndex
 The index of this command outlet.
NSDictionary * attributes
 A dicitonary of attributes (NSString, NSString pairs) associated with the command to which this command outlet is connected.
int dataType
 The data type expected by the command to which this command outlet is connected.
int numberOfRows
 The number of rows expected by the command to which this command outlet is connected.
int numberOfColumns
 The number of columns expected by the command to which this command outlet is connected.
BOOL isConnected
 Whether or not the command outlet currently has a command to which it is connected.

Detailed Description

A VCCommandOutlet represents a command that a data consumer can control. In the same way that a VCInput represents a potential source of data, a VCCommandOutlet represents a potential command to be sent when it is connected to a specific session command. It also acts as the repository for configuration data associated with the command; like other objects derived from VCExtendedManagedObject, it can store arbitrary key-value pairs as configuration data.

Do not attempt to modify the properties of this object directly, other than user-defined key-value pairs stored as configuration directly. Undefined behavior will result.


Member Function Documentation

- (void) sendCommandWithData: (void *)  v
ofType: (enum VCDataTypes)  type
atTime: (NSDate *)  date 

Send an arbitrary data value and an explict command date to the command associated with this command outlet. If the command outlet is not currently connected, this method will have no effect.

Parameters:
vA pointer to the data that should be sent.
typeThe type of the data pointed to by v
dateThe time at which the command should take place.
- (void) sendCommandWithDouble: (double)  v
atTime: (NSDate *)  date 

Send a double and an explict command date to the command associated with this command outlet. If the command outlet is not currently connected, this method will have no effect.

Parameters:
vThe double value to command.
dateThe time at which the command should take place.
- (void) sendCommandWithInt: (int)  v
atTime: (NSDate *)  date 

Send an integer and an explict command date to the command associated with this command outlet. If the command outlet is not currently connected, this method will have no effect.

Parameters:
vThe integer value to command.
dateThe time at which the command should take place.
- (void) sendCommandWithValue: (VCValue *)  value

Send a value, with its associated timestamp, to the command associated with this command outlet. If the command outlet is not currently connected, this method will have no effect.

Parameters:
valueThe value to set. The value's timestamp should represent the time at which the command should take place.

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