Now you can download a copy of these docs so you can use them offline! Download now
Public Member Functions | List of all members
ArrayEntryType Class Reference

#include <ArrayEntryType.h>

Inheritance diagram for ArrayEntryType:
Inheritance graph
[legend]
Collaboration diagram for ArrayEntryType:
Collaboration graph
[legend]

Public Member Functions

 ArrayEntryType (TypeId id, NetworkTableEntryType &elementType)
 
EntryValue copyElement (EntryValue value)
 
void deleteElement (EntryValue value)
 
bool areElementsEqual (EntryValue v1, EntryValue v2)
 
void sendValue (EntryValue value, DataIOStream &os)
 
EntryValue readValue (DataIOStream &is)
 
EntryValue copyValue (EntryValue value)
 
void deleteValue (EntryValue value)
 
bool areEqual (EntryValue v1, EntryValue v2)
 
EntryValue internalizeValue (std::string &key, ComplexData &externalRepresentation, EntryValue currentInteralValue)
 
void exportValue (std::string &key, EntryValue internalData, ComplexData &externalRepresentation)
 
- Public Member Functions inherited from ComplexEntryType
virtual bool isComplex ()
 

Additional Inherited Members

- Public Attributes inherited from NetworkTableEntryType
const TypeId id
 
const char * name
 
- Protected Member Functions inherited from ComplexEntryType
 ComplexEntryType (TypeId id, const char *name)
 
- Protected Member Functions inherited from NetworkTableEntryType
 NetworkTableEntryType (TypeId id, const char *name)
 

Detailed Description

Represents the type of an array entry value.

Definition at line 34 of file ArrayEntryType.h.

Constructor & Destructor Documentation

ArrayEntryType::ArrayEntryType ( TypeId  id,
NetworkTableEntryType &  elementType 
)

Creates a new ArrayEntryType.

Parameters
idThe ID which identifies this type to other nodes on across the network.
elementTypeThe type of the elements this array contains.

Definition at line 10 of file ArrayEntryType.cpp.

Member Function Documentation

bool ArrayEntryType::areElementsEqual ( EntryValue  v1,
EntryValue  v2 
)

Compares two elements of the type of the array

Returns
true if the elements are equal

Definition at line 20 of file ArrayEntryType.cpp.

bool ArrayEntryType::areEqual ( EntryValue  v1,
EntryValue  v2 
)
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

Implements NetworkTableEntryType.

Definition at line 80 of file ArrayEntryType.cpp.

EntryValue ArrayEntryType::copyElement ( EntryValue  value)

Creates a copy of an value which is of the type contained by this array.

Parameters
valueThe element, of this array's contained type, to copy.
Returns
A copy of the given value.

Definition at line 14 of file ArrayEntryType.cpp.

EntryValue ArrayEntryType::copyValue ( EntryValue  value)
virtual

See NetworkTableEntryType::copyValue

Reimplemented from NetworkTableEntryType.

Definition at line 52 of file ArrayEntryType.cpp.

void ArrayEntryType::deleteElement ( EntryValue  value)

Deletes a entry value which is of the type contained by this array.

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

Parameters
valueThe value to delete.

Definition at line 17 of file ArrayEntryType.cpp.

void ArrayEntryType::deleteValue ( EntryValue  value)
virtual

See NetworkTableEntryType::deleteValue

Reimplemented from NetworkTableEntryType.

Definition at line 68 of file ArrayEntryType.cpp.

void ArrayEntryType::exportValue ( std::string &  key,
EntryValue  internalData,
ComplexData &  externalRepresentation 
)
virtual

See ComplexEntryType::exportValue

Implements ComplexEntryType.

Definition at line 126 of file ArrayEntryType.cpp.

EntryValue ArrayEntryType::internalizeValue ( std::string &  key,
ComplexData &  externalRepresentation,
EntryValue  currentInteralValue 
)
virtual

See ComplexEntryType::internalizeValue

Implements ComplexEntryType.

Definition at line 92 of file ArrayEntryType.cpp.

EntryValue ArrayEntryType::readValue ( DataIOStream &  is)
virtual

See NetworkTableEntryType::readValue

Implements NetworkTableEntryType.

Definition at line 36 of file ArrayEntryType.cpp.

void ArrayEntryType::sendValue ( EntryValue  value,
DataIOStream &  os 
)
virtual

See NetworkTableEntryType::sendValue

Implements NetworkTableEntryType.

Definition at line 25 of file ArrayEntryType.cpp.

The documentation for this class was generated from the following files:
Generated on Sat Apr 26 2014 12:26:45 for WPILibC++ by doxygen 1.8.6