GrlPdLib.SinkCapability Class Reference

SinkCapability class used to configure the - sink capability fields and set as a parameter for the SetSinkCapability function in the PDController class. More...

Public Member Functions
	SinkCapability (bool isEprSrcCap=false)
	Source Capability Constructor.
List< uint >	GetByteData ()
	To Get Byte Data.
bool	ClearDataObjects ()
	Clears Object Values.
	SinkCapability ()
	Sink Capability Constructor.
byte[]	GetRawData_InBytes ()
bool	AddFixedSupply (uint Volt_50mV_Unit, uint OperationalCurrent_10mA_Unit, uint FRSwap_USBTypecCurrent=0, bool enDualRolePower=false, bool HigherCapability=false, bool externallyPowered=false, bool USBCommCapable=false, bool enDualRoleData=false)
	Allows to set Fixed Supply.
bool	AddVariableSupply (uint MaxVolt_50mV_Unit, uint MinVolt_50mV_Unit, uint OperationalCurrent_10mA_Unit)
	Allows to set Variable Supply.
bool	AddBatterySupply (uint MaxVolt_50mV_Unit, uint MinVolt_50mV_Unit, uint OperationalPower_250mW_Unit)
	Allows to set Battery Sypply.
bool	AddPpsApdo (uint MaxVolt_100mV_Unit, uint MinVolt_100mV_Unit, uint MaxCurrent_50mA_Unit)
	Allows to set ppsApdo.
void	AddPdoRawData (uint data)
void	PDMessageHeaderNameValuePair (PDMessage pdoMessage)
void	PDMessagePayLoadNameValuePair (PDMessage pdoMessage)
void	UpdateHeader (uint specificationRevision, uint noOfDataObjects, uint extended)

Public Attributes
List< uint >	m_SnkPowerDataObject
List< KeyValuePair< string, string > >	Header = new List<KeyValuePair<string, string>>()
List< Dictionary< string, string > >	PDO = new List<Dictionary<string, string>>()
uint	extendedHeader
uint	msgHeader

Detailed Description

SinkCapability class used to configure the - sink capability fields and set as a parameter for the SetSinkCapability function in the PDController class.

Constructor & Destructor Documentation

SinkCapability() [1/2]

GrlPdLib.SinkCapability.SinkCapability

(

bool

isEprSrcCap = false

)

Source Capability Constructor.

SinkCapability() [2/2]

GrlPdLib.SinkCapability.SinkCapability

(

)

Sink Capability Constructor.

Member Function Documentation

AddBatterySupply()

bool GrlPdLib.SinkCapability.AddBatterySupply	(	uint	MaxVolt_50mV_Unit,
		uint	MinVolt_50mV_Unit,
		uint	OperationalPower_250mW_Unit )

Allows to set Battery Sypply.

Parameters

MaxVolt_50mV_Unit	Maximum Voltage of 50mV units.
MinVolt_50mV_Unit	Minimum Voltage of 50mV units.
OperationalPower_250mW_Unit	Operational Power of 250mW units.

Returns

Returns true.

AddFixedSupply()

bool GrlPdLib.SinkCapability.AddFixedSupply	(	uint	Volt_50mV_Unit,
		uint	OperationalCurrent_10mA_Unit,
		uint	FRSwap_USBTypecCurrent = 0,
		bool	enDualRolePower = false,
		bool	HigherCapability = false,
		bool	externallyPowered = false,
		bool	USBCommCapable = false,
		bool	enDualRoleData = false )

Allows to set Fixed Supply.

Parameters

Volt_50mV_Unit	Voltage of 50mV Units.
OperationalCurrent_10mA_Unit	Operational Current 10mA units.
FRSwap_USBTypecCurrent	Fast Role Swap USB Type-C Current.
enDualRolePower	Dual Role Power.
HigherCapability	Higher Capability.
externallyPowered	Externally Powered.
USBCommCapable	USB Communications Capability.
enDualRoleData	Dual Role Data.

Returns

Returns true.

AddPpsApdo()

bool GrlPdLib.SinkCapability.AddPpsApdo	(	uint	MaxVolt_100mV_Unit,
		uint	MinVolt_100mV_Unit,
		uint	MaxCurrent_50mA_Unit )

Allows to set ppsApdo.

Parameters

MaxVolt_100mV_Unit	Maximum Voltage of 100mV units.
MinVolt_100mV_Unit	Minimum Voltage of 100mV units.
MaxCurrent_50mA_Unit	Maximum Current of 50mA units.

Returns

Returns true.

AddVariableSupply()

bool GrlPdLib.SinkCapability.AddVariableSupply	(	uint	MaxVolt_50mV_Unit,
		uint	MinVolt_50mV_Unit,
		uint	OperationalCurrent_10mA_Unit )

Allows to set Variable Supply.

Parameters

MaxVolt_50mV_Unit	Maximum Voltage of 50mV units.
MinVolt_50mV_Unit	Minimum Voltage of 50mV units.
OperationalCurrent_10mA_Unit	Operational Current of 10mA units.

Returns

Returns True.

ClearDataObjects()

bool GrlPdLib.SinkCapability.ClearDataObjects

(

)

Clears Object Values.

Returns

Returns true when cleared.

GetByteData()

List< uint > GrlPdLib.SinkCapability.GetByteData

(

)

To Get Byte Data.

Returns

returns the PDO Payload along with buffer.