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

#include <NetworkTableEntry.h>

Public Member Functions

 NetworkTableEntry (std::string &name, NetworkTableEntryType *type, EntryValue value)
 
 NetworkTableEntry (EntryId id, std::string &name, SequenceNumber sequenceNumber, NetworkTableEntryType *type, EntryValue value)
 
EntryId GetId ()
 
EntryValue GetValue ()
 
NetworkTableEntryTypeGetType ()
 
bool PutValue (SequenceNumber newSequenceNumber, EntryValue newValue)
 
void ForcePut (SequenceNumber newSequenceNumber, EntryValue newValue)
 
void ForcePut (SequenceNumber newSequenceNumber, NetworkTableEntryType *type, EntryValue newValue)
 
void MakeDirty ()
 
void MakeClean ()
 
bool IsDirty ()
 
void SendValue (DataIOStream &iostream)
 
SequenceNumber GetSequenceNumber ()
 
void SetId (EntryId id)
 
void ClearId ()
 
void Send (NetworkTableConnection &connection)
 
void FireListener (TableListenerManager &listenerManager)
 

Public Attributes

std::string name
 

Static Public Attributes

static const EntryId UNKNOWN_ID = 0xFFFF
 

Detailed Description

An entry in a network table

Author
mwills

Definition at line 30 of file NetworkTableEntry.h.

Member Function Documentation

void NetworkTableEntry::ClearId ( )

clear the id of the entry to unknown

Definition at line 113 of file NetworkTableEntry.cpp.

void NetworkTableEntry::ForcePut ( SequenceNumber  newSequenceNumber,
EntryValue  newValue 
)

force a value and new sequence number upon an entry

Parameters
newSequenceNumber
newValue

Definition at line 55 of file NetworkTableEntry.cpp.

void NetworkTableEntry::ForcePut ( SequenceNumber  newSequenceNumber,
NetworkTableEntryType newType,
EntryValue  newValue 
)

force a value and new sequence number upon an entry, Will also set the type of the entry

Parameters
newSequenceNumber
type
newValue

Definition at line 67 of file NetworkTableEntry.cpp.

SequenceNumber NetworkTableEntry::GetSequenceNumber ( )
Returns
the current sequence number of the entry

Definition at line 97 of file NetworkTableEntry.cpp.

void NetworkTableEntry::SendValue ( DataIOStream iostream)

Send the value of the entry over the output stream

Parameters
os
Exceptions
IOException

Definition at line 90 of file NetworkTableEntry.cpp.

void NetworkTableEntry::SetId ( EntryId  _id)

Sets the id of the entry

Parameters
idthe id of the entry
Exceptions
IllegalStateExceptionif the entry already has a known id

Definition at line 105 of file NetworkTableEntry.cpp.

Member Data Documentation

std::string NetworkTableEntry::name

the name of the entry

Definition at line 41 of file NetworkTableEntry.h.

const EntryId NetworkTableEntry::UNKNOWN_ID = 0xFFFF
static

the id that represents that an id is unknown for an entry

Definition at line 37 of file NetworkTableEntry.h.


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