Previous Next  

Element: SamplingPort

Document type

PseudoPartitionDescription

Document XPath

/PseudoPartitionDescription/Ports/SamplingPort

Schema XPath

/ConfigRecord/Module/Partitions/PseudoPartition/PseudoPartitionDescription/Ports/SamplingPort

Description

The SamplingPort element defines the configuration of sampling ports for a pseudo-partition.

Use

Required

Children

None

Attributes

Attribute

Direction

DriverName

MessageSize

Name

RefreshRate

Restrictions

None

Attribute: Attribute

Document XPath
/PseudoPartitionDescription/Ports/SamplingPort/@Attribute
Schema XPath
/ConfigRecord/Module/Partitions/PseudoPartition/PseudoPartitionDescription/Ports/SamplingPort/@Attribute
Description

The attribute is used to specify the port type.

Use

Optional

Target location

None

XML data type

PortAttributeType

Destination data type

Signed 32 bit integer

Behavior if not specified

N/A

Values with special meanings

DIRECT_ACCESS_PORT: The port is a direct-access port.

LOCAL_PORT: Not supported for partitions.

NULL_PORT: The port is a null port. A null source port sends no data. A null destination port accepts and consumes all data sent to it. Null ports are useful during development when not all applications are available.

PSEUDO_PORT: The port is a pseudo-port.

Restrictions

Attribute: Direction

Document XPath
/PseudoPartitionDescription/Ports/SamplingPort/@Direction
Schema XPath
/ConfigRecord/Module/Partitions/PseudoPartition/PseudoPartitionDescription/Ports/SamplingPort/@Direction
Description

Whether the port is the source or destination of data.

Use

Required

Target location

None

XML data type

PortDirectionType

Destination data type

PORT_DIRECTION_TYPE, as defined in apex/apexType.h

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

None

Attribute: DriverName

Document XPath
/PseudoPartitionDescription/Ports/SamplingPort/@DriverName
Schema XPath
/ConfigRecord/Module/Partitions/PseudoPartition/PseudoPartitionDescription/Ports/SamplingPort/@DriverName
Description

The name of the port driver used by the port. The port driver resides in the core OS. This value must match the name of the driver passed to the portPseudoDrvAdd() in the core OS.

Use

Optional

Target location

None

XML data type

DriverNameType

Destination data type

String

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

None

Attribute: MessageSize

Document XPath
/PseudoPartitionDescription/Ports/SamplingPort/@MessageSize
Schema XPath
/ConfigRecord/Module/Partitions/PseudoPartition/PseudoPartitionDescription/Ports/SamplingPort/@MessageSize
Description

The maximum message size (in bytes) for the port. All bytes are available for the user message.

Use

Required

Target location

None

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

None

Attribute: Name

Document XPath
/PseudoPartitionDescription/Ports/SamplingPort/@Name
Schema XPath
/ConfigRecord/Module/Partitions/PseudoPartition/PseudoPartitionDescription/Ports/SamplingPort/@Name
Description

The name of the port. This value is used to assign a port to a channel in the Module configuration document using /Module/Connections/Channel/Source/@PortNameRef and /Module/Connections/Channel/Destination/@PortNameRef.

Use

Required

Target location

None

XML data type

PortNameType

Destination data type

String

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

Attribute: RefreshRate

Document XPath
/PseudoPartitionDescription/Ports/SamplingPort/@RefreshRate
Schema XPath
/ConfigRecord/Module/Partitions/PseudoPartition/PseudoPartitionDescription/Ports/SamplingPort/@RefreshRate
Description

The frequency with which the message available on the port is updated, in seconds.

Use

Required

Target location

None

XML data type

DurationType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

None




Generated on 2007-10-15 17:17:22.