Now you can download a copy of these docs so you can use them offline! Download now
NetworkTableEntryType Class Referenceabstract

#include <NetworkTableEntryType.h>

Inheritance diagram for NetworkTableEntryType:

Public Member Functions

virtual bool isComplex ()
 
virtual void sendValue (EntryValue value, DataIOStream &os)=0
 
virtual EntryValue readValue (DataIOStream &is)=0
 
virtual EntryValue copyValue (EntryValue value)
 
virtual bool areEqual (EntryValue v1, EntryValue v2)=0
 
virtual void deleteValue (EntryValue value)
 

Public Attributes

const TypeId id
 
const char * name
 

Protected Member Functions

 NetworkTableEntryType (TypeId id, const char *name)
 

Detailed Description

Represents the type associated with a network tables value.

Definition at line 33 of file NetworkTableEntryType.h.

Constructor & Destructor Documentation

NetworkTableEntryType::NetworkTableEntryType ( TypeId  id,
const char *  name 
)
protected

Creates a new NetworkTablesEntryType.

Parameters
idThe numeric ID associated with this type. This ID represents this data type to other nodes on the network.
nameThe string name associated with this type.

Definition at line 11 of file NetworkTableEntryType.cpp.

Member Function Documentation

virtual bool NetworkTableEntryType::areEqual ( EntryValue  v1,
EntryValue  v2 
)
pure virtual

Compares two values to determine if they are equal and should not push an update to other nodes

Parameters
v1
v2
Returns
true if the two values are equal

Implemented in ArrayEntryType.

EntryValue NetworkTableEntryType::copyValue ( EntryValue  value)
virtual

Creates a copy of the given value of this type.

Parameters
valueThe value to copy.
Returns
A copy of the given value of this type.

Reimplemented in ArrayEntryType.

Definition at line 16 of file NetworkTableEntryType.cpp.

void NetworkTableEntryType::deleteValue ( EntryValue  value)
virtual

Deletes a value of this type.

After calling this function, the given value is no longer valid.

Parameters
valueThe value to delete.

Reimplemented in ArrayEntryType.

Definition at line 19 of file NetworkTableEntryType.cpp.

bool NetworkTableEntryType::isComplex ( )
virtual

Determines whether this data type is complex (i.e. it does not represent a number, string, or boolean).

Returns
True of this type is complex. False otherwise.

Reimplemented in ComplexEntryType.

Definition at line 23 of file NetworkTableEntryType.cpp.

virtual EntryValue NetworkTableEntryType::readValue ( DataIOStream is)
pure virtual

Unserializes the a value of this type from the given input stream.

Parameters
isThe input stream to read from.
Returns
The unserialized value.

Implemented in ArrayEntryType.

virtual void NetworkTableEntryType::sendValue ( EntryValue  value,
DataIOStream os 
)
pure virtual

Serializes the given value on the given output stream.

Parameters
valueThe value to serialize.
osThe output stream to use.

Implemented in ArrayEntryType.


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

Generated on Sat Apr 26 2014 12:26:46 for WPILibC++ by doxygen 1.8.6