ViconDataStreamSDK::CPP::Client Class Reference

#include <Client.h>

Public Member Functions
	Client ()
	~Client ()
Output_GetVersion	GetVersion () const
Output_Connect	Connect (const String &HostName)
Output_ConnectToMulticast	ConnectToMulticast (const String &HostName, const String &MulticastIP)
Output_Disconnect	Disconnect ()
Output_IsConnected	IsConnected () const
Output_StartTransmittingMulticast	StartTransmittingMulticast (const String &ServerIP, const String &MulticastIP)
Output_StopTransmittingMulticast	StopTransmittingMulticast ()
Output_EnableSegmentData	EnableSegmentData ()
Output_EnableMarkerData	EnableMarkerData ()
Output_EnableUnlabeledMarkerData	EnableUnlabeledMarkerData ()
Output_EnableDeviceData	EnableDeviceData ()
Output_DisableSegmentData	DisableSegmentData ()
Output_DisableMarkerData	DisableMarkerData ()
Output_DisableUnlabeledMarkerData	DisableUnlabeledMarkerData ()
Output_DisableDeviceData	DisableDeviceData ()
Output_IsSegmentDataEnabled	IsSegmentDataEnabled () const
Output_IsMarkerDataEnabled	IsMarkerDataEnabled () const
Output_IsUnlabeledMarkerDataEnabled	IsUnlabeledMarkerDataEnabled () const
Output_IsDeviceDataEnabled	IsDeviceDataEnabled () const
Output_SetStreamMode	SetStreamMode (const StreamMode::Enum Mode)
Output_SetAxisMapping	SetAxisMapping (const Direction::Enum XAxis, const Direction::Enum YAxis, const Direction::Enum ZAxis)
Output_GetAxisMapping	GetAxisMapping () const
Output_GetFrame	GetFrame ()
Output_GetFrameNumber	GetFrameNumber () const
Output_GetTimecode	GetTimecode () const
Output_GetLatencySampleCount	GetLatencySampleCount () const
Output_GetLatencySampleName	GetLatencySampleName (const unsigned int LatencySampleIndex) const
Output_GetLatencySampleValue	GetLatencySampleValue (const String &LatencySampleName) const
Output_GetLatencyTotal	GetLatencyTotal () const
Output_GetSubjectCount	GetSubjectCount () const
Output_GetSubjectName	GetSubjectName (const unsigned int SubjectIndex) const
Output_GetSubjectRootSegmentName	GetSubjectRootSegmentName (const String &SubjectName) const
Output_GetSegmentCount	GetSegmentCount (const String &SubjectName) const
Output_GetSegmentName	GetSegmentName (const String &SubjectName, const unsigned int SegmentIndex) const
Output_GetSegmentChildCount	GetSegmentChildCount (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentChildName	GetSegmentChildName (const String &SubjectName, const String &SegmentName, const unsigned int SegmentIndex) const
Output_GetSegmentParentName	GetSegmentParentName (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentStaticTranslation	GetSegmentStaticTranslation (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentStaticRotationHelical	GetSegmentStaticRotationHelical (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentStaticRotationMatrix	GetSegmentStaticRotationMatrix (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentStaticRotationQuaternion	GetSegmentStaticRotationQuaternion (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentStaticRotationEulerXYZ	GetSegmentStaticRotationEulerXYZ (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentGlobalTranslation	GetSegmentGlobalTranslation (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentGlobalRotationHelical	GetSegmentGlobalRotationHelical (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentGlobalRotationMatrix	GetSegmentGlobalRotationMatrix (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentGlobalRotationQuaternion	GetSegmentGlobalRotationQuaternion (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentGlobalRotationEulerXYZ	GetSegmentGlobalRotationEulerXYZ (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentLocalTranslation	GetSegmentLocalTranslation (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentLocalRotationHelical	GetSegmentLocalRotationHelical (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentLocalRotationMatrix	GetSegmentLocalRotationMatrix (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentLocalRotationQuaternion	GetSegmentLocalRotationQuaternion (const String &SubjectName, const String &SegmentName) const
Output_GetSegmentLocalRotationEulerXYZ	GetSegmentLocalRotationEulerXYZ (const String &SubjectName, const String &SegmentName) const
Output_GetMarkerCount	GetMarkerCount (const String &SubjectName) const
Output_GetMarkerName	GetMarkerName (const String &SubjectName, const unsigned int MarkerIndex) const
Output_GetMarkerParentName	GetMarkerParentName (const String &SubjectName, const String &MarkerName) const
Output_GetMarkerGlobalTranslation	GetMarkerGlobalTranslation (const String &SubjectName, const String &MarkerName) const
Output_GetUnlabeledMarkerCount	GetUnlabeledMarkerCount () const
Output_GetUnlabeledMarkerGlobalTranslation	GetUnlabeledMarkerGlobalTranslation (const unsigned int MarkerIndex) const
Output_GetDeviceCount	GetDeviceCount () const
Output_GetDeviceName	GetDeviceName (const unsigned int DeviceIndex) const
Output_GetDeviceOutputCount	GetDeviceOutputCount (const String &DeviceName) const
Output_GetDeviceOutputName	GetDeviceOutputName (const String &DeviceName, const unsigned int DeviceOutputIndex) const
Output_GetDeviceOutputValue	GetDeviceOutputValue (const String &DeviceName, const String &DeviceOutputName) const

Detailed Description

Definition at line 660 of file Client.h.

Constructor & Destructor Documentation

Client()

ViconDataStreamSDK::CPP::Client::Client

(

)

~Client()

ViconDataStreamSDK::CPP::Client::~Client

(

)

Member Function Documentation

Connect()

Output_Connect ViconDataStreamSDK::CPP::Client::Connect

(

const String &

HostName

)

ConnectToMulticast()

Output_ConnectToMulticast ViconDataStreamSDK::CPP::Client::ConnectToMulticast	(	const String &	HostName,
		const String &	MulticastIP
	)

DisableDeviceData()

Output_DisableDeviceData ViconDataStreamSDK::CPP::Client::DisableDeviceData

(

)

DisableMarkerData()

Output_DisableMarkerData ViconDataStreamSDK::CPP::Client::DisableMarkerData

(

)

DisableSegmentData()

Output_DisableSegmentData ViconDataStreamSDK::CPP::Client::DisableSegmentData

(

)

DisableUnlabeledMarkerData()

Output_DisableUnlabeledMarkerData ViconDataStreamSDK::CPP::Client::DisableUnlabeledMarkerData

(

)

Disconnect()

Output_Disconnect ViconDataStreamSDK::CPP::Client::Disconnect

(

)

EnableDeviceData()

Output_EnableDeviceData ViconDataStreamSDK::CPP::Client::EnableDeviceData

(

)

EnableMarkerData()

Output_EnableMarkerData ViconDataStreamSDK::CPP::Client::EnableMarkerData

(

)

EnableSegmentData()

Output_EnableSegmentData ViconDataStreamSDK::CPP::Client::EnableSegmentData

(

)

EnableUnlabeledMarkerData()

Output_EnableUnlabeledMarkerData ViconDataStreamSDK::CPP::Client::EnableUnlabeledMarkerData

(

)

GetAxisMapping()

Output_GetAxisMapping ViconDataStreamSDK::CPP::Client::GetAxisMapping

(

)

const

GetDeviceCount()

Output_GetDeviceCount ViconDataStreamSDK::CPP::Client::GetDeviceCount

(

)

const

GetDeviceName()

Output_GetDeviceName ViconDataStreamSDK::CPP::Client::GetDeviceName

(

const unsigned int

DeviceIndex

)

const

GetDeviceOutputCount()

Output_GetDeviceOutputCount ViconDataStreamSDK::CPP::Client::GetDeviceOutputCount

(

const String &

DeviceName

)

const

GetDeviceOutputName()

Output_GetDeviceOutputName ViconDataStreamSDK::CPP::Client::GetDeviceOutputName	(	const String &	DeviceName,
		const unsigned int	DeviceOutputIndex
	)		const

GetDeviceOutputValue()

Output_GetDeviceOutputValue ViconDataStreamSDK::CPP::Client::GetDeviceOutputValue	(	const String &	DeviceName,
		const String &	DeviceOutputName
	)		const

GetFrame()

Output_GetFrame ViconDataStreamSDK::CPP::Client::GetFrame

(

)

GetFrameNumber()

Output_GetFrameNumber ViconDataStreamSDK::CPP::Client::GetFrameNumber

(

)

const

GetLatencySampleCount()

Output_GetLatencySampleCount ViconDataStreamSDK::CPP::Client::GetLatencySampleCount

(

)

const

GetLatencySampleName()

Output_GetLatencySampleName ViconDataStreamSDK::CPP::Client::GetLatencySampleName

(

const unsigned int

LatencySampleIndex

)

const

GetLatencySampleValue()

Output_GetLatencySampleValue ViconDataStreamSDK::CPP::Client::GetLatencySampleValue

(

const String &

LatencySampleName

)

const

GetLatencyTotal()

Output_GetLatencyTotal ViconDataStreamSDK::CPP::Client::GetLatencyTotal

(

)

const

GetMarkerCount()

Output_GetMarkerCount ViconDataStreamSDK::CPP::Client::GetMarkerCount

(

const String &

SubjectName

)

const

GetMarkerGlobalTranslation()

Output_GetMarkerGlobalTranslation ViconDataStreamSDK::CPP::Client::GetMarkerGlobalTranslation	(	const String &	SubjectName,
		const String &	MarkerName
	)		const

GetMarkerName()

Output_GetMarkerName ViconDataStreamSDK::CPP::Client::GetMarkerName	(	const String &	SubjectName,
		const unsigned int	MarkerIndex
	)		const

GetMarkerParentName()

Output_GetMarkerParentName ViconDataStreamSDK::CPP::Client::GetMarkerParentName	(	const String &	SubjectName,
		const String &	MarkerName
	)		const

GetSegmentChildCount()

Output_GetSegmentChildCount ViconDataStreamSDK::CPP::Client::GetSegmentChildCount	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentChildName()

Output_GetSegmentChildName ViconDataStreamSDK::CPP::Client::GetSegmentChildName	(	const String &	SubjectName,
		const String &	SegmentName,
		const unsigned int	SegmentIndex
	)		const

GetSegmentCount()

Output_GetSegmentCount ViconDataStreamSDK::CPP::Client::GetSegmentCount

(

const String &

SubjectName

)

const

GetSegmentGlobalRotationEulerXYZ()

Output_GetSegmentGlobalRotationEulerXYZ ViconDataStreamSDK::CPP::Client::GetSegmentGlobalRotationEulerXYZ	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentGlobalRotationHelical()

Output_GetSegmentGlobalRotationHelical ViconDataStreamSDK::CPP::Client::GetSegmentGlobalRotationHelical	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentGlobalRotationMatrix()

Output_GetSegmentGlobalRotationMatrix ViconDataStreamSDK::CPP::Client::GetSegmentGlobalRotationMatrix	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentGlobalRotationQuaternion()

Output_GetSegmentGlobalRotationQuaternion ViconDataStreamSDK::CPP::Client::GetSegmentGlobalRotationQuaternion	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentGlobalTranslation()

Output_GetSegmentGlobalTranslation ViconDataStreamSDK::CPP::Client::GetSegmentGlobalTranslation	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentLocalRotationEulerXYZ()

Output_GetSegmentLocalRotationEulerXYZ ViconDataStreamSDK::CPP::Client::GetSegmentLocalRotationEulerXYZ	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentLocalRotationHelical()

Output_GetSegmentLocalRotationHelical ViconDataStreamSDK::CPP::Client::GetSegmentLocalRotationHelical	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentLocalRotationMatrix()

Output_GetSegmentLocalRotationMatrix ViconDataStreamSDK::CPP::Client::GetSegmentLocalRotationMatrix	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentLocalRotationQuaternion()

Output_GetSegmentLocalRotationQuaternion ViconDataStreamSDK::CPP::Client::GetSegmentLocalRotationQuaternion	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentLocalTranslation()

Output_GetSegmentLocalTranslation ViconDataStreamSDK::CPP::Client::GetSegmentLocalTranslation	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentName()

Output_GetSegmentName ViconDataStreamSDK::CPP::Client::GetSegmentName	(	const String &	SubjectName,
		const unsigned int	SegmentIndex
	)		const

GetSegmentParentName()

Output_GetSegmentParentName ViconDataStreamSDK::CPP::Client::GetSegmentParentName	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentStaticRotationEulerXYZ()

Output_GetSegmentStaticRotationEulerXYZ ViconDataStreamSDK::CPP::Client::GetSegmentStaticRotationEulerXYZ	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentStaticRotationHelical()

Output_GetSegmentStaticRotationHelical ViconDataStreamSDK::CPP::Client::GetSegmentStaticRotationHelical	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentStaticRotationMatrix()

Output_GetSegmentStaticRotationMatrix ViconDataStreamSDK::CPP::Client::GetSegmentStaticRotationMatrix	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentStaticRotationQuaternion()

Output_GetSegmentStaticRotationQuaternion ViconDataStreamSDK::CPP::Client::GetSegmentStaticRotationQuaternion	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSegmentStaticTranslation()

Output_GetSegmentStaticTranslation ViconDataStreamSDK::CPP::Client::GetSegmentStaticTranslation	(	const String &	SubjectName,
		const String &	SegmentName
	)		const

GetSubjectCount()

Output_GetSubjectCount ViconDataStreamSDK::CPP::Client::GetSubjectCount

(

)

const

GetSubjectName()

Output_GetSubjectName ViconDataStreamSDK::CPP::Client::GetSubjectName

(

const unsigned int

SubjectIndex

)

const

GetSubjectRootSegmentName()

Output_GetSubjectRootSegmentName ViconDataStreamSDK::CPP::Client::GetSubjectRootSegmentName

(

const String &

SubjectName

)

const

GetTimecode()

Output_GetTimecode ViconDataStreamSDK::CPP::Client::GetTimecode

(

)

const

GetUnlabeledMarkerCount()

Output_GetUnlabeledMarkerCount ViconDataStreamSDK::CPP::Client::GetUnlabeledMarkerCount

(

)

const

GetUnlabeledMarkerGlobalTranslation()

Output_GetUnlabeledMarkerGlobalTranslation ViconDataStreamSDK::CPP::Client::GetUnlabeledMarkerGlobalTranslation

(

const unsigned int

MarkerIndex

)

const

GetVersion()

Output_GetVersion ViconDataStreamSDK::CPP::Client::GetVersion

(

)

const

IsConnected()

Output_IsConnected ViconDataStreamSDK::CPP::Client::IsConnected

(

)

const

IsDeviceDataEnabled()

Output_IsDeviceDataEnabled ViconDataStreamSDK::CPP::Client::IsDeviceDataEnabled

(

)

const

IsMarkerDataEnabled()

Output_IsMarkerDataEnabled ViconDataStreamSDK::CPP::Client::IsMarkerDataEnabled

(

)

const

IsSegmentDataEnabled()

Output_IsSegmentDataEnabled ViconDataStreamSDK::CPP::Client::IsSegmentDataEnabled

(

)

const

IsUnlabeledMarkerDataEnabled()

Output_IsUnlabeledMarkerDataEnabled ViconDataStreamSDK::CPP::Client::IsUnlabeledMarkerDataEnabled

(

)

const

SetAxisMapping()

Output_SetAxisMapping ViconDataStreamSDK::CPP::Client::SetAxisMapping	(	const Direction::Enum	XAxis,
		const Direction::Enum	YAxis,
		const Direction::Enum	ZAxis
	)

SetStreamMode()

Output_SetStreamMode ViconDataStreamSDK::CPP::Client::SetStreamMode

(

const StreamMode::Enum

Mode

)

StartTransmittingMulticast()

Output_StartTransmittingMulticast ViconDataStreamSDK::CPP::Client::StartTransmittingMulticast	(	const String &	ServerIP,
		const String &	MulticastIP
	)

StopTransmittingMulticast()

Output_StopTransmittingMulticast ViconDataStreamSDK::CPP::Client::StopTransmittingMulticast

(

)

---

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

• /build/rock-master-18.09-drivers-vicon-0.20160818/Client.h