DIRETTA::ProfileMaker Class Reference

ProfileMaker class for creating and configuring Profile objects in Diretta. More...

#include <Profile.hpp>

Public Member Functions
	ProfileMaker ()
	Constructor zero.
bool	setParameter (std::uint16_t, std::uint16_t, std::uint16_t, std::uint32_t, std::uint32_t)
	set Sink(Target) Profile Parameter
void	setConfig (FormatConfigure, ACQUA::Clock, std::uint16_t, std::uint16_t)
	set Playback Format
void	configTransferAuto (ACQUA::Clock)
	Configure automatic data transfer settings based on the specified cycle time.
bool	configTransferAuto ()
	Configure automatic data transfer settings based on the specified cycle time.
bool	configTransferFix (ACQUA::Clock, int)
	fix-cycle configuration
bool	configTransferVar (ACQUA::Clock, int)
	variable-cycle configuration
bool	configTransferFixAuto (ACQUA::Clock)
bool	configTransferVarAuto (ACQUA::Clock)
bool	configTransferSizeFix (size_t)
	Transmission Size Specification Mode.
void	configTransferSizeMax ()
	Adjust to use the maximum network packet size configuration.
bool	configTransferRandom (ACQUA::Clock, ACQUA::Clock, int)
	random-cycle configuration
	operator Profile () const
	Cast to Profile.
void	setForceFragment (bool fl)
	Override packet fragmentation specification in TargetProfile.

Detailed Description

ProfileMaker class for creating and configuring Profile objects in Diretta.

Member Function Documentation

configTransferAuto()

void DIRETTA::ProfileMaker::configTransferAuto

(

ACQUA::Clock

)

Configure automatic data transfer settings based on the specified cycle time.

Parameters

cycleTime

Target Cycle Time( defalt minimam time Clock::zero())

configTransferFix()

bool DIRETTA::ProfileMaker::configTransferFix	(	ACQUA::Clock	,
		int	)

fix-cycle configuration

Parameters

cycleTime	Target Cycle Time
Maximum	Simultaneous Transmissions (Fragment Count)

Returns

success or failure

configTransferSizeFix()

bool DIRETTA::ProfileMaker::configTransferSizeFix

(

size_t

)

Transmission Size Specification Mode.

Parameters

Packet

Data Size: Bytes

configTransferVar()

bool DIRETTA::ProfileMaker::configTransferVar	(	ACQUA::Clock	,
		int	)

variable-cycle configuration

Parameters

cycleTime	Target Cycle Time
Maximum	Simultaneous Transmissions (Fragment Count)

Returns

success or failure

setConfig()

void DIRETTA::ProfileMaker::setConfig	(	FormatConfigure	,
		ACQUA::Clock	,
		std::uint16_t	,
		std::uint16_t	)

set Playback Format

Parameters

FormatConfigure	Playback Format
limitCycle	Minimum period time (maximum transmission frequency) for Sync (Host)
PackDataSize	Maximum Packet Data Size
PackDataCount	Maximum Packet Data Count

Returns

success or failure

setParameter()

bool DIRETTA::ProfileMaker::setParameter	(	std::uint16_t	,
		std::uint16_t	,
		std::uint16_t	,
		std::uint32_t	,
		std::uint32_t	)

set Sink(Target) Profile Parameter

Parameters

min	Minimum transmission cycle
max	Maximum transmission cycle
pro	Target Profile Type (ProfileID)
NoBaseMin	Target Support Format Minimum Frequency Multiplier
mf	Target Support Format Maximum Frame Size

Returns

success or failure

---

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

• Profile.hpp